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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Pythonのbuiltinカテゴリに属し、AugAssignクラスのインスタンスがフォーマット文字列によってどのように表現されるかを制御するために使用されるメソッドです。

Pythonでは、format()関数やf-string(フォーマット済み文字列リテラル)を用いて、オブジェクトを任意の書式の文字列として整形する機能があります。この__format__メソッドは、その整形処理が実行される際に、対象のオブジェクトから内部的に呼び出されます。

もしAugAssignがプログラムの構文要素を表現するクラス(例えば、抽象構文木の一部)であるならば、このメソッドを実装することで、その構文要素の内部的な情報や構造を、開発者にとって読みやすく、あるいはデバッグしやすい特定の形式の文字列として出力できるようになります。例えば、「a += b」のような複合代入文の詳細を、特定の書式ルールに則って整形して表示するといった用途が考えられます。

プログラマは、自身の定義するクラスでこの__format__メソッドをオーバーライドすることで、そのクラスのオブジェクトがフォーマットされる際の振る舞いを細かくカスタマイズできます。これにより、オブジェクトの情報を標準的な形式で表示したり、特定の目的に応じたレポート形式で出力したりするなど、文字列への変換処理において高い柔軟性を得られます。特に、複雑なデータ構造や内部状態を持つオブジェクトを、視覚的に分かりやすく表現する際に非常に有用です。

構文(syntax)

1class MyObject:
2    def __init__(self, value):
3        self.value = value
4
5    def __format__(self, format_spec):
6        """
7        このメソッドは、format()関数やf-stringでオブジェクトが
8        フォーマットされる際に自動的に呼び出されます。
9        format_spec は、フォーマット指定子(例: 's', '0.2f'など)の文字列です。
10        この例では、指定子に応じて値を大文字または小文字にします。
11        """
12        if format_spec == 'upper':
13            return str(self.value).upper()
14        elif format_spec == 'lower':
15            return str(self.value).lower()
16        return str(self.value) # デフォルトの文字列表現
17
18# __format__ メソッドが使われる構文の例
19# オブジェクトを作成し、f-stringでフォーマット指定子を付けて表示します。
20# これにより、MyObject.__format__ メソッドが呼び出されます。
21formatted_string_example = f"大文字: {MyObject('python'):upper}, 小文字: {MyObject('PYTHON'):lower}, デフォルト: {MyObject(123)}"

引数(parameters)

self, format_spec: str

  • self: 演算対象のオブジェクト自身
  • format_spec: str: フォーマット指定子文字列

戻り値(return)

str

このメソッドは、オブジェクトをフォーマットされた文字列として表現したものを返します。

関連コンテンツ

関連プログラミング言語