【Python3.x】Attribute::__str__()メソッドの使い方
__str__メソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
__str__メソッドは、オブジェクトの文字列表現を生成するためのメソッドです。
このメソッドは、Pythonの任意のクラスで定義(オーバーライド)できる「特殊メソッド」の一つで、そのクラスのインスタンスがどのような文字列として表示されるかをカスタマイズするために利用されます。具体的には、print()関数でオブジェクトを出力したり、str()関数を使ってオブジェクトを明示的に文字列型に変換しようとしたりする際に、Pythonインタープリタが自動的にこの__str__メソッドを呼び出します。
もしクラス内で__str__メソッドが定義されていない場合、Pythonはデフォルトの表現(例えば「<__main__.MyClass object at 0x...>」のような、メモリ上の位置を示す情報)を返します。しかし、このメソッドを実装することで、オブジェクトが保持する内部のデータ(フィールドの値など)を含んだ、人間にとってより読みやすく、意味のある文字列を返すように設定できます。
例えば、ユーザー情報を保持するクラスであれば、__str__を定義することで、そのオブジェクトをprint()した際に「ユーザー名: John Doe, メール: john.doe@example.com」といった具体的な情報が表示されるようになります。
この機能は、プログラムのデバッグ時や、ログ出力、あるいはユーザーインターフェースでオブジェクトの情報を表示する際など、多岐にわたる場面でオブジェクトの可読性を向上させるために非常に重要です。__repr__メソッドもオブジェクトの文字列表現を返しますが、__str__は主にエンドユーザーや読み手を意識した、分かりやすさを重視した表現を目的としています。
構文(syntax)
1class MyClass: 2 def __str__(self): 3 return "このオブジェクトのユーザーフレンドリーな文字列表現"
引数(parameters)
self: object
- self: object: 文字列として表現したいオブジェクト自身
戻り値(return)
str
このメソッドは、オブジェクトを人間が読みやすい文字列形式で表現したものを返します。