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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Pythonのオブジェクトを特定の書式で文字列に変換する際にその動作を制御するメソッドです。

このメソッドは、format()組み込み関数や、f-string(書式付き文字列リテラル)を使用してオブジェクトの文字列表現をカスタマイズする際に自動的に呼び出されます。例えば、数値の表示桁数を指定したり、日付の出力形式を変更したり、独自のデータ構造を特定のフォーマットで表現したりする用途で活用されます。

__format__メソッドは通常、format_specと呼ばれる文字列を引数として受け取ります。このformat_specは、オブジェクトをどのように整形するかを指示する書式指定文字列です。メソッドの実装者は、このformat_specを解析し、それに応じた形でオブジェクトの情報を整形した文字列を戻り値として返します。

開発者が自身の作成するカスタムクラスで__format__メソッドを実装することで、そのクラスのインスタンスがformat()関数やf-stringで利用された際に、独自に定義した書式ルールに基づいて文字列に変換されるようになります。これにより、アプリケーション全体でデータの表示形式を統一したり、ユーザーインターフェースやログ出力など、特定の目的に合わせた柔軟な文字列表現を簡単に生成したりすることが可能になります。オブジェクトの書式化を細かく制御できるため、可読性や保守性の高いコードを書く上で重要な役割を果たします。

構文(syntax)

1123.__format__('04d')

引数(parameters)

self, format_spec: str, /

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

戻り値(return)

str

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

関連コンテンツ

関連プログラミング言語