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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、オブジェクトを特定の形式の文字列に変換するために使用される特殊なメソッドです。Pythonでは、format()組み込み関数やf-string(フォーマット済み文字列リテラル)を用いてオブジェクトを整形する際に、内部的にこのメソッドが呼び出されます。

このメソッドは、自身のオブジェクト(self)と、どのような形式で文字列に整形するかを指示する文字列(format_spec)を引数として受け取ります。format_specには、数値の小数点以下の桁数や表示幅、日付の表示形式、カスタムオブジェクトにおける特定の表示ルールなど、出力する文字列の書式に関する詳細な情報が含まれます。

開発者が自身の定義したクラスに__format__メソッドを実装することで、そのクラスのオブジェクトがformat()関数やf-stringでどのように整形されるかをカスタマイズできます。例えば、独自に定義したデータ型のオブジェクトを、特定の単位を付けて表示したり、固定幅で整列させて表示したりするなど、目的に応じた柔軟な文字列表現を実現できます。

システムエンジニアを目指す方にとっては、この__format__メソッドが、プログラムが出力する情報をより読みやすく、利用者にとって理解しやすい形式で表示するための強力な手段であると理解することが重要です。これにより、デバッグ情報の出力や、ユーザーインターフェースへの表示など、さまざまな場面でオブジェクトの表現力を高めることができます。

構文(syntax)

1class Break:
2    def __format__(self, format_spec: str) -> str:
3        return ""

引数(parameters)

self, format_spec: str, /

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

戻り値(return)

str

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

関連コンテンツ

関連プログラミング言語