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

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

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

作成日: 更新日:

基本的な使い方

__dir__メソッドは、AsyncFunctionDefオブジェクトが持つ属性名のリストを取得するメソッドです。

AsyncFunctionDefは、Pythonのソースコードが解析される際に作られる抽象構文木(AST)の中で、非同期関数(async defで定義されるコルーチン関数)の定義を表す要素です。

この__dir__メソッドは、Pythonのオブジェクトがどのような名前の属性(メソッドやプロパティなど)を持っているかを一覧で確認するために使われる特殊なメソッドです。対話型インタープリタでdir()関数を使ってオブジェクトの属性を確認する際に、内部的にこの__dir__メソッドが呼び出されます。

AsyncFunctionDefオブジェクトにこのメソッドを適用すると、その非同期関数の定義が持つ内部的な情報や、その構文要素に関連する属性名を調べることができます。これは、Pythonのコードがどのように内部的に構造化されているかを深く理解したい場合や、コード解析ツールなどを開発する際に、AsyncFunctionDefノードがどのような要素で構成されているかを調査するために利用されます。一般的なアプリケーション開発でこのメソッドを直接操作する機会は少ないですが、Python言語の内部的な仕組みに関心を持つ方にとって、コードの解析プロセスを理解する上で役立つ情報を提供します。

構文(syntax)

1import ast
2
3# ast.AsyncFunctionDef クラスのインスタンスを作成
4async_function_definition_node = ast.AsyncFunctionDef(
5    name="example_async_func",
6    args=ast.arguments(
7        posonlyargs=[], args=[], vararg=None, kwonlyargs=[], kw_defaults=[], kwarg=None, defaults=[]
8    ),
9    body=[ast.Pass()],
10    decorator_list=[],
11    returns=None,
12    type_comment=None
13)
14
15# AsyncFunctionDef オブジェクトの __dir__ メソッドを呼び出す構文
16async_function_definition_node.__dir__()

引数(parameters)

self

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

戻り値(return)

list[str]

このメソッドは、AsyncFunctionDef オブジェクトが持つ属性名(メソッド名やプロパティ名など)のリストを文字列の配列として返します。

関連コンテンツ

関連プログラミング言語