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

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

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

作成日: 更新日:

基本的な使い方

__str__メソッドは、Pythonのオブジェクトの「人間が読みやすい」文字列表現を返すための特殊なメソッドです。このメソッドは、print()関数でオブジェクトを表示したり、str()関数でオブジェクトを明示的に文字列に変換したりする際に、Pythonの内部で自動的に呼び出されます。

開発者が独自に定義したクラスのインスタンスをprint()関数などで表示すると、デフォルトではオブジェクトのタイプとメモリ上のアドレスのような、あまり意味のない情報が表示されることがよくあります。しかし、クラス内で__str__メソッドを適切に定義することで、「この商品オブジェクトは〇〇という名前で、価格は△△円です」といった、そのオブジェクトが持つ具体的な情報や状態を分かりやすい形式で文字列として表現し、出力できるようになります。

__str__メソッドを定義する際は、引数としてインスタンス自身(self)を受け取り、必ず文字列を返さなければなりません。これにより、プログラムのデバッグ作業時や、ログファイルへの出力、ユーザーインターフェースにおけるオブジェクトの情報の表示など、様々な状況でオブジェクトの状態を効果的かつ直感的に表現することが可能になります。オブジェクトの内容を外部に明確に伝えるための、非常に重要な役割を担うメソッドです。

構文(syntax)

1class And:
2    def __init__(self, operand1, operand2):
3        self.operand1 = operand1
4        self.operand2 = operand2
5
6    def __str__(self):
7        return f"({self.operand1} and {self.operand2})"

引数(parameters)

self

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

戻り値(return)

str

このメソッドは、オブジェクトを人間が読みやすい文字列形式で表現したものを返します。

関連コンテンツ

関連プログラミング言語