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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Addクラスのインスタンスを特定の書式で文字列に変換するために実行されるメソッドです。Pythonにおけるこのメソッドは、format()組み込み関数やf-string(書式付き文字列リテラル)と連携し、オブジェクトの文字列表現をカスタマイズする際に用いられる特殊メソッド(マジックメソッド)の一つです。

このメソッドが実装されていると、"{:format_spec}".format(オブジェクト) の形式や、f"{オブジェクト:format_spec}" といった書式指定文字列を使って、Addクラスのインスタンスを望む形式の文字列として取得することができます。

たとえば、Addクラスのインスタンスが数値や日付のような情報を含んでいる場合、__format__メソッドを独自に実装することで、「桁区切りを入れる」「小数点以下の桁数を指定する」「特定の日付フォーマットで表示する」といった柔軟な書式設定が可能になります。これにより、データの視覚的な表現を細かく制御できます。

このメソッドは、単一の引数format_specを受け取ります。このformat_specは、ユーザーが指定したい書式ルールを文字列として表現したものであり、どのようにオブジェクトを文字列化するかを詳細に指示するために使われます。クラスの設計者がこの__format__メソッドを適切に実装することにより、そのクラスのユーザーは、インスタンスの見た目を簡単に制御できるようになります。この機能は、アプリケーションの出力を見やすく整えたり、特定のデータ形式に合わせたりする場面で非常に役立ち、データの表示を統一し、可読性を高める上で重要な役割を果たします。

構文(syntax)

1# 数値オブジェクトに対して書式指定子を適用する例
2number_object = 123
3formatted_string = number_object.__format__("0>5d")

引数(parameters)

self, format_spec: str, /

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

戻り値(return)

str

このメソッドは、オブジェクトの書式設定された文字列表現を返します。

関連コンテンツ

関連プログラミング言語