【Python3.x】AnnAssign::__str__()メソッドの使い方
__str__メソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
__str__メソッドは、Pythonのオブジェクトを人間が読める形式の文字列に変換するメソッドです。これは、str()関数やprint()関数を使ってオブジェクトを出力しようとした際に、自動的に呼び出されます。このメソッドを定義することで、カスタムクラスのインスタンスを分かりやすく簡潔な形で表現できるようになり、デバッグ時の情報確認やログ出力、ユーザーインターフェースでの表示など、幅広い場面で役立ちます。
例えば、自作した「製品」オブジェクトをprint()した場合、「製品名: ノートパソコン、価格: 120,000円」のように、そのオブジェクトが持つ主要な情報をひと目で理解できる文字列として表示させることが可能です。
__str__メソッドは、同じく文字列変換を行う__repr__メソッドと似ていますが、__str__は主にユーザーやプログラムの利用者が読むことを想定した「読みやすい」表現を目指すのに対し、__repr__は開発者向けに、そのオブジェクトを再構築できるような「厳密な」表現を提供することが一般的です。
今回対象となっているAnnAssignクラスは、Pythonの内部でコードの構造を表すクラスの一つです。具体的には、型アノテーションが付いた代入文、例えばx: int = 10のようなコード要素に対応します。このAnnAssignクラスの__str__メソッドは、そのような内部的なオブジェクトの構造を、人間が理解しやすい文字列として表現するために利用されます。これにより、Pythonのプログラムがどのように構成されているかを視覚的に把握しやすくなり、プログラムの解析やデバッグの際に非常に役立ちます。
構文(syntax)
1variable: type = value
引数(parameters)
self
- self: AnnAssignオブジェクト自身
戻り値(return)
str
AnnAssignオブジェクトを、人間が読みやすい文字列形式で表現したものを返します。