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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、オブジェクトが自身の文字列表現をどのようにフォーマットするかを定義するために実行するメソッドです。Pythonにおいて、オブジェクトを特定の形式で文字列に変換する際に利用され、format()組み込み関数やf-string(フォーマット済み文字列リテラル)と組み合わせて使用されます。

このメソッドは、format(オブジェクト, フォーマット指定子) のように呼び出されたり、f"{オブジェクト:フォーマット指定子}" のような形式で記述されたりしたときに、Pythonインタープリタによって内部的に呼び出されます。呼び出されると、フォーマット指定子 の文字列を引数として受け取り、その指定子に基づいてオブジェクトの内容を加工し、整形された文字列を返します。

システムエンジニアがクラスを設計する際、この__format__メソッドを実装することで、自身で作成したカスタムオブジェクトが、組み込みの数値や日付型のように、特定の書式で表示されるようカスタマイズできるようになります。例えば、小数点以下の桁数を指定したり、特定の区切り文字を使用したり、日付の表示順序を変更したりといった柔軟な表現を可能にします。これにより、プログラム内でオブジェクトを文字列として表示する際の「見た目」を細かく制御し、アプリケーションの要件に合わせた分かりやすい出力形式を提供することが可能となり、コードの可読性と使いやすさが向上します。多くのオブジェクトではデフォルトの動作が提供されていますが、このメソッドをオーバーライドすることで、より高度な文字列フォーマットのニーズに対応できます。

構文(syntax)

1class SomeClass:
2    def __format__(self, format_spec):
3        return ""

引数(parameters)

self, format_spec: str, /

  • self: メソッドが呼び出されるオブジェクト自身
  • format_spec: str: オブジェクトをどのようにフォーマットするかを指定する文字列

戻り値(return)

str

このメソッドは、オブジェクトを文字列としてフォーマットするための書式指定を解釈し、その結果としてフォーマットされた文字列を返します。

関連コンテンツ

関連プログラミング言語