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

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

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

作成日: 更新日:

基本的な使い方

__str__メソッドは、PythonのAST(抽象構文木)モジュールにおいて、ASTノードオブジェクトの「読みやすい」文字列表現を生成し、それを返すことを実行するメソッドです。ASTとは、Pythonのソースコードをコンピュータが理解しやすいように、その構造を木構造で表現したもので、各ノードは変数宣言、関数呼び出し、条件分岐といったコードの要素を表します。

この__str__メソッドは、ASTノードオブジェクトがstr()関数に渡されたり、print()関数で出力されたりする際に自動的に呼び出されます。例えば、Pythonのインタプリタがソースコードを解析して生成したASTの構造をデバッグしたり、プログラムがASTを操作した結果を確認したりする場合に、このメソッドが非常に役立ちます。__str__メソッドが適切に実装されていれば、ASTノードが出力されたときに、そのノードが元のソースコードのどの部分に対応するのか、あるいはどのような種類のノードなのかといった情報が、人間にとって分かりやすい形で提供されます。

システムエンジニアを目指す初心者の方にとって、このメソッドは、プログラムの内部構造であるASTを視覚的に理解しやすくしたり、デバッグ時に複雑なオブジェクトの状態を把握したりするための強力なツールであると理解できます。Pythonの組み込み型オブジェクトだけでなく、ASTのようなプログラムの内部表現を扱うオブジェクトに対しても、__str__メソッドは、そのオブジェクトを人間が読みやすい形式に変換する共通の手段として機能します。これにより、プログラムの振る舞いをより深く洞察し、問題解決に役立てることができます。

構文(syntax)

1class AST:
2    def __str__(self) -> str:
3        return "このASTノードを表現する文字列"

引数(parameters)

self

  • self: ASTオブジェクト自身

戻り値(return)

str

このメソッドは、AST (Abstract Syntax Tree) オブジェクトの文字列表現を返します。この文字列表現は、プログラムの構造を人間が読みやすい形式で表示するために使用されます。

関連コンテンツ

関連プログラミング言語