【Python3.x】Call::__format__()メソッドの使い方
__format__メソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
__format__メソッドは、Callクラスに属し、そのインスタンスを特定の書式で文字列に変換する際に実行されるメソッドです。このメソッドは、Pythonにおいてオブジェクトの文字列表現を細かく制御するために利用されます。具体的には、str.format() メソッドや f-string(書式付き文字列リテラル)内で、コロン(:)に続けて書式指定ミニ言語が使われた場合に、Pythonインタープリタによって自動的に呼び出されます。
このメソッドは、format_specという書式指定子を表す文字列引数を受け取ります。format_specは、数値の桁数や小数点以下の表示、日付のフォーマット、文字列の配置など、オブジェクトをどのように文字列に変換するかに関する具体的な指示を含みます。多くの組み込み型では、この__format__メソッドが独自に実装されており、それぞれの型に応じた柔軟な書式設定が可能です。
例えば、数値型であればゼロ埋めやカンマ区切り、日付型であれば特定の日付フォーマットを指定できます。開発者は自身の作成するカスタムクラスでこの__format__メソッドを実装することにより、そのクラスのインスタンスがstr.format()やf-stringで利用された際の文字列表現を自由に定義できるようになります。これにより、オブジェクトの内部構造を直接知らなくても、人間が読みやすく、かつ用途に合わせた形で情報を表現することが可能となり、アプリケーションの利便性向上に貢献します。
構文(syntax)
1class MyClass: 2 def __format__(self, format_spec): 3 # ここにカスタムフォーマットのロジックを実装します 4 # format_spec はフォーマット文字列リテラルや format() 関数に渡される指定子です 5 return f"Custom formatted output for spec '{format_spec}'"
引数(parameters)
self, format_spec: str, /
- self: 自身を表すオブジェクト
- format_spec: str: オブジェクトのフォーマット方法を指定する文字列
戻り値(return)
str
このメソッドは、str や repr と同様に、オブジェクトの文字列表現を生成しますが、より柔軟なフォーマット指定子を使用して、表示形式を制御できます。生成された文字列表現を返します。