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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドはAssertクラスに所属する組み込みメソッドです。このメソッドは、Pythonにおいて、あるオブジェクトが特定の形式の文字列として表現される際の動作を定義するために利用されます。

具体的には、format()関数やf-string(フォーマット済み文字列リテラル)、あるいはstr.format()メソッドなどが、オブジェクトを文字列に変換する際に内部的にこの__format__メソッドを呼び出します。これにより、オブジェクトの文字列表現を柔軟にカスタマイズすることが可能になります。

例えば、数値を特定の桁数で表示したり、浮動小数点数の小数点以下の桁数を指定したり、日付や時刻の表示形式を調整したり、文字列を指定された文字で埋めたりするといった、多様な書式設定が実現できます。Assertクラスのインスタンスをこれらの機能でフォーマットしようとした場合、この__format__メソッドが定義されたルールに従って文字列が生成されます。

開発者が自身のクラスで__format__メソッドを実装することで、そのクラスのインスタンスがどのように文字列としてフォーマットされるかを細かく制御できるようになります。これにより、データの出力、デバッグ時の情報表示、ユーザーインターフェースでの表示など、さまざまな場面で一貫性のある、かつ利用しやすい文字列表現を提供することが可能になります。

構文(syntax)

1class_instance = AssertionError("An assertion error occurred.")
2formatted_result = class_instance.__format__("s")

引数(parameters)

self, format_spec: str, /

  • self: format メソッドが呼び出されている Assert オブジェクト自身
  • format_spec: str: フォーマット指定子を表す文字列

戻り値(return)

str

このメソッドは、アサートオブジェクトを文字列としてフォーマットした結果を返します。

関連コンテンツ

関連プログラミング言語