Pythonのrepr()関数とは？オブジェクト指向プログラミングにおける役割を解説

Python公式ドキュメントによると、__repr__()はオブジェクトの「公式（official）」な文字列表現を計算するための特殊メソッドです。組み込み関数repr()は、内部でこの__repr__()を呼び出してオブジェクトを表示します。戻り値となる文字列は、人間が読める形式であるだけでなく、多くの場合その文字列から元のオブジェクトを再構築できる情報を含んでいます。

また、__repr__()は主に開発者向けのデバッグや開発作業に役立つのに対し、__str__()はエンドユーザー向けの読みやすい表示に適しているという違いがあります。用途に応じて両者を使い分けることが、Pythonらしいオブジェクト設計のポイントです。

__repr__()の基本的な実装例

次のコードは、独自クラスで__repr__()を実装する方法と、その動作を示しています。

class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __repr__(self):
        return 'Point(x=%s, y=%s)' % (self.x, self.y)

p = Point(3, 4)
print(p)

出力結果

Point(x=3, y=4)

print()はオブジェクトの__repr__()を呼び出すため、定義した形式でインスタンスの内容が表示されます。これにより、デバッグ時にオブジェクトの中身をひと目で把握できます。

datetimeオブジェクトでのrepr()の使用例

続いて、標準ライブラリのdatetimeオブジェクトを使って、repr()関数の実際の挙動を確認してみましょう。

>>> import datetime
>>> today = datetime.datetime.now()

組み込み関数repr()を使って変数todayを表示すると、次のような結果になります。

>>> repr(today)
'datetime.datetime(2012, 3, 14, 9, 21, 58, 130922)'

戻り値は確かに文字列ですが、これはdatetimeオブジェクトの「公式」な文字列表現です。重要なのは、この文字列から元のオブジェクトを再構築できるという点です。

>>> eval('datetime.datetime(2012, 3, 14, 9, 21, 58, 130922)')
datetime.datetime(2012, 3, 14, 9, 21, 58, 130922)

組み込み関数eval()は文字列をPythonの式として評価し、datetimeオブジェクトを復元します。このようにrepr()が返す文字列は単なる表示用テキストではなく、オブジェクトの状態を正確に再現できる「再構築可能な表現」であることが、__repr__()設計の本質と言えます。