【Python3.x】__base__::__str__()メソッドの使い方
__str__メソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
__str__メソッドは、Pythonのオブジェクトの「人間が読みやすい」文字列表現を生成し、それを返すメソッドです。このメソッドは、クラスのインスタンスを文字列として表現する際に非常に重要な役割を果たします。具体的には、組み込み関数であるstr()がオブジェクトに対して呼び出されたり、print()関数でオブジェクトが出力されたりする際に自動的に呼び出されます。また、f-stringのような文字列フォーマット機能でオブジェクトが使用される場合にも、このstr`メソッドが利用されます。
__str__メソッドが返す値は、必ずstr型、つまり文字列でなければなりません。もしユーザーが定義したクラスでこのメソッドが実装されていない場合、Pythonはデフォルトでオブジェクトの型とメモリアドレスのような情報を含む、あまり人間には読みやすくない文字列表現を返します。しかし、このメソッドを適切に実装することで、そのオブジェクトが持つ属性値など、より意味のある情報を文字列として表示できるようになります。
これにより、プログラムのデバッグ時やログ出力、あるいはユーザーインターフェースでオブジェクトの内容を表示する際に、そのオブジェクトがどのような状態であるかを一目で理解しやすくなります。システムエンジニアを目指す初心者の方にとって、オブジェクトの内容を分かりやすく表現するこの__str__メソッドは、コードの可読性やデバッグ効率を高める上で非常に役立つ基本的な概念の一つです。
構文(syntax)
1class ClassName: 2 def __str__(self): 3 return "オブジェクトの文字列表現"
引数(parameters)
self
- self: オブジェクト自身
戻り値(return)
str
このメソッドは、オブジェクトの文字列表現を返します。この文字列表現は、通常、人間が理解しやすい形式でオブジェクトの内容を表します。