Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】And::__repr__()メソッドの使い方

__repr__メソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__repr__メソッドは、オブジェクトの「公式な」文字列表現を返すために実行されるメソッドです。このメソッドは、主に開発者がプログラムのデバッグやオブジェクトの状態確認を行う際に利用することを目的としています。

__repr__メソッドが返す文字列は、そのオブジェクトを正確に、そして曖昧さなく表現するべきであるとされています。可能であれば、その文字列をPythonのeval()関数に渡すことで、元のオブジェクトと等価な新しいオブジェクトを再構築できるような形式が理想的です。例えば、ClassName(argument1, argument2)のような形式が該当します。

しばしば比較される__str__メソッドとは異なり、__repr__は人間が読みやすい形式であることよりも、開発者にとって役立つ詳細な情報を含む表現を重視します。Pythonの対話型インタープリタで変数名を入力してEnterキーを押すと、その変数が保持するオブジェクトの__repr__メソッドが呼び出され、結果が表示されます。また、組み込み関数であるrepr()にオブジェクトを渡した場合も、このメソッドが実行されます。

ご自身のカスタムクラスを定義する際に__repr__メソッドを適切に実装することで、デバッグ作業が格段に効率的になり、ログ出力がより分かりやすくなるなど、コードの可読性とメンテナンス性が向上します。システム開発においてオブジェクトの状態を正確に把握することは非常に重要であり、このメソッドはそのための強力なツールとなります。

構文(syntax)

1class And:
2    def __repr__(self):
3        return "And()"

引数(parameters)

self

  • self: Andオブジェクト自身

戻り値(return)

str

__repr__ メソッドは、オブジェクトの「公式な」文字列表現を返します。これは、デバッグ時などに、プログラムがオブジェクトをどのように解釈しているかを確認するために使用されます。

関連コンテンツ

関連プログラミング言語