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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Pythonのオブジェクトを特定の書式に整形した文字列として表現するための特殊メソッドです。このメソッドは、format()組み込み関数、文字列のstr.format()メソッド、f-stringなど、オブジェクトの書式設定を行う際に内部的に呼び出されます。

具体的には、書式指定子(例えば、"{:0.2f}"の0.2f部分)を受け取り、その指定に基づいてオブジェクトを文字列に変換する役割を担います。ユーザー定義クラスでこのメソッドを実装(オーバーライド)することで、そのクラスのインスタンスが、与えられた書式指定子に応じてどのような文字列として表現されるかを細かく制御できるようになります。

これにより、数値の桁数調整や日付の表示形式の変更、あるいは独自のデータ構造を特定の形式で表現するなど、オブジェクトの情報を利用シーンや読者に合わせて柔軟かつ統一された形式で出力することが可能になります。システム開発において、データの整形と表示の品質を高め、利用者に分かりやすい情報を提供するための非常に有用な機能です。

構文(syntax)

1class ClassDef:
2    def __format__(self, format_spec):
3        return ""

引数(parameters)

self, format_spec: str

  • self: フォーマットされるオブジェクト自身
  • format_spec: str: フォーマット方法を指定する文字列

戻り値(return)

str

このメソッドは、オブジェクトをフォーマットされた文字列に変換した結果を返します。

関連コンテンツ

関連プログラミング言語