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

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

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

作成日: 更新日:

基本的な使い方

__dir__メソッドは、あるオブジェクトがどのような属性(メソッドや変数など)を持っているかをリスト形式で確認するために実行するメソッドです。Pythonの組み込み関数であるdir()が内部的に呼び出す特殊なメソッドであり、オブジェクトが持つべき属性の名前を動的に提供する役割を担っています。

このメソッドは、特にPythonの対話型インタープリタを利用する際に非常に便利です。例えば、特定のオブジェクトがどのような操作をサポートしているか、どのようなデータにアクセスできるかを調べたい場合に、そのオブジェクトに対してdir()関数を実行することで、利用可能な属性名を一覧できます。これにより、オブジェクトの機能を直感的に理解し、コード補完のヒントとしても役立ちます。

カスタムクラスを定義する際、開発者が__dir__メソッドを独自に実装(オーバーライド)することも可能です。これにより、dir()関数がそのクラスのインスタンスに対して返す属性のリストをカスタマイズできます。例えば、特定の条件に基づいて一部の属性のみを表示したり、動的に生成される属性名を含めたりするなど、柔軟な振る舞いを定義することが可能です。これは、複雑なオブジェクトの内部構造をユーザーに分かりやすく提示したり、特定のインターフェース規約に沿った属性リストを提供したりする際に役立ちます。

構文(syntax)

1import ast
2node_example = ast.parse("x += 1").body[0]
3node_example.__dir__()

引数(parameters)

self, /

  • self: 演算対象のオブジェクト自体

戻り値(return)

list[str]

このメソッドは、AugAssignオブジェクトが持つ属性名(メンバ変数やメソッドの名前)を文字列のリストとして返します。

関連コンテンツ

関連プログラミング言語