【Python3.x】Compare::__repr__()メソッドの使い方
__repr__メソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
__repr__メソッドは、オブジェクトの公式な文字列表現を生成し、その文字列を返すメソッドです。このメソッドは、主に開発者向けのデバッグやログ出力の際に、オブジェクトの状態を明確に表現するために使用されます。Pythonのインタプリタでオブジェクトを直接入力して表示すると、デフォルトでこの__repr__メソッドが呼び出され、その戻り値が表示されます。
__repr__の戻り値は、そのオブジェクトを再構築できるような形式の文字列であることが理想とされています。例えば、datetime.date(2023, 1, 1)のように、コードとして評価できるような形式が期待されます。もし__repr__が定義されていない場合、Pythonはデフォルトで<ClassName object at 0x...>のような汎用的な表現を返します。
しばしば比較される__str__メソッドは、ユーザーにとって読みやすい非公式な文字列表現を返すことを目的としているのに対し、__repr__はプログラマにとって明確で、曖昧さのない、技術的な表現を提供します。したがって、カスタムクラスを定義する際には、デバッグ時の利便性向上のためにも__repr__メソッドを実装することが強く推奨されます。これにより、プログラムの動作を追跡しやすくなり、問題の特定に役立ちます。
構文(syntax)
1class MyClass: 2 def __init__(self, value): 3 self.value = value 4 5 def __repr__(self): 6 return f"MyClass(value={self.value})"
引数(parameters)
self
- self: メソッドが呼び出されるオブジェクト自身
戻り値(return)
str
このメソッドは、オブジェクトを開発者やデバッガーが解釈しやすい形式の文字列として返します。この文字列は、通常、そのオブジェクトを再構築できるような表現であることが期待されます。