【Python3.x】ClassDef::__str__()メソッドの使い方
__str__メソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
__str__メソッドは、クラスのインスタンスを表す人間が読みやすい文字列表現を生成するための特殊なメソッドです。Pythonでは、オブジェクトをprint()関数で出力したり、str()関数に渡したり、あるいはログ出力などで文字列として扱われる必要がある場合に、この__str__メソッドが自動的に呼び出されます。
このメソッドをクラス内に定義することで、そのオブジェクトが持つ情報を分かりやすい形で表現できるようになります。例えば、顧客情報を扱うクラスのインスタンスをprint()関数で表示した際に、「<main.Customer object at 0x...>」といったメモリ上のアドレスではなく、「顧客名: 山田太郎, ID: 001, メール: taro@example.com」のような具体的な情報を文字列として返すことができます。
__str__メソッドは、プログラムのデバッグ時や、作成したオブジェクトの状態を素早く確認したい場合、またエンドユーザー向けのメッセージにオブジェクトの情報を埋め込む場合などに非常に有効です。このメソッドは必ず文字列を返す必要があり、適切な実装によりコードの可読性と保守性を大きく向上させることができます。もし__str__メソッドが定義されていない場合、Pythonはデフォルトでオブジェクトの型とメモリ上のアドレスを含む表現を返します。
構文(syntax)
1class ClassName: 2 def __str__(self): 3 return "文字列"
引数(parameters)
self
- self: オブジェクト自身への参照
戻り値(return)
str
このメソッドは、オブジェクトの文字列表現を返します。