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

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

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

作成日: 更新日:

基本的な使い方

__format__メソッドは、Pythonにおいて、オブジェクトを特定の形式の文字列として表現する際に利用される特殊なメソッドです。具体的には、組み込みのformat()関数やf-string(書式付き文字列リテラル)を使用してオブジェクトの文字列表現をカスタマイズする目的で呼び出されます。このメソッドをクラス内で定義することで、そのクラスのインスタンスがどのような書式で文字列に変換されるかを開発者が自由に制御できるようになります。

AnnAssignクラスは、Pythonのコードが内部的にどのように解釈されているかを示す「抽象構文木(AST)」と呼ばれる構造の一部を表すクラスです。このAnnAssignは、たとえば変数名: 型ヒント = 初期値のように型ヒントが付けられた代入文を表現するノードとして機能します。

AnnAssignクラスにおける__format__メソッドは、このASTノード自身の構造やその内容を、開発者がデバッグやコード解析を行う際に読みやすい文字列形式で出力するために用いられます。これにより、Pythonのインタプリタがコードをどのように認識しているかを視覚的に確認できるようになり、コードの振る舞いを理解したり、ツールを作成したりする上で役立ちます。このメソッドは、オブジェクトが持つ情報を特定の書式に従って、外部に提示するための標準的なインターフェースを提供していると言えます。

構文(syntax)

1class ClassName:
2    def __format__(self, format_spec):
3        pass

引数(parameters)

self, format_spec: str, /

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

戻り値(return)

str

このメソッドは、AnnAssignオブジェクトのフォーマットされた文字列表現を返します。

関連コンテンツ

関連プログラミング言語