【Python3.x】Compare::__str__()メソッドの使い方
__str__メソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
__str__メソッドは、オブジェクトの「人間が読みやすい」文字列表現を返すために使用される特殊なメソッドです。このメソッドは、Pythonの組み込み関数であるstr()がオブジェクトに対して呼び出されたり、print()関数でオブジェクトが表示されたり、f-stringやformat()メソッドを使ってオブジェクトが文字列に埋め込まれる際に、内部的に自動で呼び出されます。
その主な目的は、オブジェクトの内容をエンドユーザーやログ出力などの目的で、直感的で分かりやすい形式の文字列として提供することです。例えば、独自のクラスで作成したインスタンスをprint()関数で出力した際に、デフォルトの<__main__.MyClass object at 0x...>のような情報が少ない表示ではなく、そのオブジェクトが持つ意味のある情報を簡潔に表示できるようにするために利用されます。
__str__メソッドは、開発者向けの「公式な」文字列表現を返す__repr__メソッドとは異なり、より「非公式で読みやすい」表現を意図しています。もし、あるクラスに__str__メソッドが定義されていない場合、str()関数などはフォールバックとして__repr__メソッドの結果を利用します。
ユーザーが定義するクラスでこのメソッドを適切に実装することで、デバッグ時のオブジェクトの内容確認、プログラムの動作確認、そして最終的な出力結果の可読性が大幅に向上します。このメソッドは常に文字列型の値を返す必要があります。
構文(syntax)
1class ClassName: 2 def __str__(self): 3 return "Object string representation"
引数(parameters)
self
- self: オブジェクト自身への参照
戻り値(return)
str
__str__メソッドは、オブジェクトの文字列表現を返します。これは、print()関数などでオブジェクトを表示する際に利用されます。