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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Pythonのformat()関数やf-string(フォーマット済み文字列リテラル)を通じて、Andクラスのインスタンスを特定の書式で文字列に変換する特殊メソッドです。

このメソッドは、Andオブジェクトに対して与えられた書式指定文字列(例: "{:...")を解釈し、数値の桁数揃えや文字列のアライメントといった書式ルールを適用した結果の文字列を返却します。例えば、format(my_and_object, "書式指定")やf"{my_and_object:書式指定}"のように記述することで、Andオブジェクトの多様な文字列表現を得られます。

開発者がAndクラスに__format__メソッドを実装することで、そのオブジェクトの文字列表現を柔軟かつ一貫性のある方法で制御できます。これは、デバッグログやUI表示など、オブジェクトの文字列表現が必要な場面で役立ち、情報の可読性と表現力を大きく向上させます。

構文(syntax)

1class And:
2    def __init__(self, value: bool):
3        self.value = value
4
5    def __format__(self, format_spec: str) -> str:
6        # format_spec に応じてオブジェクトの文字列表現をカスタマイズ
7        if format_spec == "verbose":
8            return "TRUE" if self.value else "FALSE"
9        elif format_spec == "numeric":
10            return "1" if self.value else "0"
11        return str(self.value)
12
13# __format__ メソッドの呼び出し構文
14# format() 関数またはf-stringによって間接的に呼び出されます
15instance = And(True)
16formatted_output = f"{instance:verbose}"

引数(parameters)

self, format_spec: str, /

  • self: format()メソッドが呼び出されるオブジェクト自身
  • format_spec: str: オブジェクトのフォーマット方法を指定する文字列

戻り値(return)

str

このメソッドは、And演算の対象となるオブジェクトを文字列として整形した結果を返します。

関連コンテンツ

関連プログラミング言語