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

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

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

作成日: 更新日:

基本的な使い方

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

たとえば、Pythonの対話型インタープリタで変数に格納されたオブジェクト名を入力してEnterキーを押した場合や、組み込み関数repr()を用いてオブジェクトの文字列表現を取得しようとした場合に、この__repr__メソッドが自動的に呼び出されます。

__repr__メソッドが返す文字列は、そのオブジェクトを再構築するために必要な情報を含んでいるか、少なくともオブジェクトを一意に識別できるような、曖昧さのない形式であることが強く推奨されます。一般的な慣習として、ClassName(attribute=value, ...) のような、開発者が見て理解しやすい形式で表現されることが多いです。

似た役割を持つ__str__メソッドと比較すると、__str__がエンドユーザーにとって読みやすく、理解しやすい表現を提供することを目的としているのに対し、__repr__は開発者向けに、より技術的で詳細な情報を提供することを目的としています。print()関数などでオブジェクトを表示する際には、通常__str__が使用されますが、__str__が定義されていない場合には__repr__が代わりに利用されます。

自身でクラスを定義する際に__repr__メソッドを適切に実装することで、そのクラスのインスタンスを効果的にデバッグできるようになり、プログラムの動作を深く理解する上で非常に役立ちます。

構文(syntax)

1class MyClass:
2    def __init__(self, attribute):
3        self.attribute = attribute
4
5    def __repr__(self):
6        return f"{self.__class__.__name__}(attribute={self.attribute!r})"

引数(parameters)

self: BinOp

  • self: BinOp: 表現を生成する対象の BinOp オブジェクト自体

戻り値(return)

str

このメソッドは、オブジェクトの「開発者向け」の文字列表現を返します。これは、デバッグやコードの解析を行う際に、オブジェクトの状態を正確に把握するために使用されます。

関連コンテンツ

関連プログラミング言語