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

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

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

作成日: 更新日:

基本的な使い方

__dir__メソッドは、PythonのAST(Abstract Syntax Tree)オブジェクトが持つ属性の一覧を取得する機能を実行するメソッドです。ASTクラスは、Pythonのソースコードがどのように構成されているかをコンピュータが理解しやすい木構造で表現するための基盤となるクラスです。コンパイラやリンター、コードフォーマッターなどのツールが、Pythonコードを解析したり変換したりする際にこのAST構造を利用します。

この__dir__メソッドは、Pythonの組み込み関数であるdir()がオブジェクトに対して呼び出された際に、そのオブジェクトが公開している属性(メソッドやプロパティなど)の名前のリストを返す特殊メソッドです。ASTオブジェクトの場合、このメソッドは、その特定のASTノードが保持しているフィールド名や、そのノードのタイプに固有の属性といった情報をリストとして提供します。

例えば、ast.ExprのようなASTノードがどのような内部情報(表現している式の内容など)を持っているかを知りたい場合に、dir()関数を使用して__dir__メソッドが返すリストを参照することで、利用可能な属性をプログラムから動的に確認することができます。これにより、開発者はASTオブジェクトの内部構造を効率的に探索し、コードの解析や操作を行う上で必要な情報を正確に取得することが可能になります。システムエンジニアを目指す方にとって、Pythonコードのより低レベルな構造を理解し、分析するための重要な手段の一つとなります。

構文(syntax)

1import ast
2
3node = ast.Constant(value=1)
4print(node.__dir__())

引数(parameters)

self: AST

  • self: AST: __dir__ メソッドが呼び出された AST オブジェクト自身

戻り値(return)

list[str]

このメソッドは、astモジュールのASTクラスのインスタンスが持つ、利用可能な属性名(メソッドやプロパティなどの名前)のリストを文字列の形式で返します。

関連コンテンツ

関連プログラミング言語