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

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

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

作成日: 更新日:

基本的な使い方

__repr__メソッドは、オブジェクトの公式な文字列表現を返すメソッドです。このメソッドは、主に開発者がオブジェクトの状態をデバッグしたり、ログに出力したりする際に利用されることを意図しています。例えば、Pythonの対話型インタープリタでオブジェクト名を入力したときや、repr()関数を呼び出したときに、このメソッドが内部的に使用されます。

理想的には、__repr__メソッドが返す文字列は、そのオブジェクトを再構築するための有効なPython式であるべきだとされています。しかし、これは常に必須ではありません。重要なのは、開発者にとって、そのオブジェクトが何であるかを明確に理解できる、曖昧さのない表現を提供することです。

もしクラスに__repr__メソッドが実装されていない場合、Pythonはデフォルトで「<モジュール名.クラス名 object at メモリアドレス>」のような、あまり情報を含まない文字列を返します。したがって、カスタムクラスを作成する際には、開発者がそのオブジェクトの状態を把握しやすくするために、__repr__メソッドを適切に実装することが推奨されます。

このメソッドが返す文字列は、ユーザーフレンドリーな表現を提供する__str__メソッドとは異なり、あくまで開発者向けの「公式な」表現であるという点で区別されます。

構文(syntax)

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

引数(parameters)

self: object, /

  • self: object: このメソッドを呼び出しているオブジェクト自身

戻り値(return)

str

このメソッドは、オブジェクトを「公式な」文字列表現として返します。これは、Pythonインタープリタで評価できるような形式であることが期待されます。

関連コンテンツ