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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Pythonにおいてオブジェクトを特定の形式の文字列に変換する際に呼び出される特殊なメソッドです。これは主にstr.format()メソッドやf-string(フォーマット済み文字列リテラル)で、{オブジェクト:フォーマット指定子}のように使用された際に機能します。

Dictクラスの__format__メソッドは、辞書オブジェクトを文字列として整形するために存在しますが、他の多くのPythonの組み込み型(数値や日付など)とは異なり、標準で利用できる特別なフォーマット指定子を提供していません。例えば、数値の小数点以下の桁数を指定したり、日付の表示形式を変更するような書式指定は、辞書に対しては用意されていません。

そのため、辞書オブジェクトに対して__format__メソッドが呼び出された場合、フォーマット指定子の有無にかかわらず、結果はstr()関数で辞書を文字列に変換したときと同じ標準的な文字列表現になります。具体的には、辞書のキーと値のペアが波括弧 {} で囲まれ、カンマで区切られた形で表示される文字列です。

例えば、my_dict = {'a': 1, 'b': 2}という辞書がある場合、'{!s}'.format(my_dict)やf-stringのf'{my_dict}'のように使用しても、"{'a': 1, 'b': 2}"という文字列が返されます。

もし辞書の内容を特定の書式で整形して表示したい場合は、この__format__メソッドに依存するのではなく、Pythonのループ処理や文字列操作機能を用いて、ご自身で目的に合った文字列生成ロジックを実装する必要があります。このメソッドは、辞書の標準的なデバッグ出力や、単純な文字列表現が必要な場合に利用されます。

構文(syntax)

1my_dictionary = {'name': 'Alice', 'age': 30}
2formatted_string = f"User info: {my_dictionary}"

引数(parameters)

self, format_spec: str, /

  • self: フォーマット対象の辞書オブジェクト
  • format_spec: str: フォーマット指定子文字列

戻り値(return)

str

このメソッドは、辞書オブジェクトを整形された文字列として返します。

関連コンテンツ

関連プログラミング言語