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

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

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

作成日: 更新日:

基本的な使い方

__dir__ メソッドは、指定されたオブジェクトがどのような属性(メソッド、プロパティ、フィールドなど)を持っているかを示す文字列のリストを返すために使用されるメソッドです。Pythonの標準機能である dir() 関数は、引数なしで呼び出された場合や、特定のオブジェクトを引数として渡された場合に、内部的にこの __dir__ メソッドを呼び出して、オブジェクトが持つ利用可能な属性名の一覧を取得します。

例えば、dir(some_object) のように利用すると、some_object が提供する機能や保持する情報に関連する名前を確認できます。これは、初めて触れるオブジェクトの機能を探索する際や、プログラムのデバッグ中にオブジェクトの内部状態を理解する上で非常に役立ちます。

ほとんどのオブジェクトは、Pythonの基底クラスである object クラスから標準の __dir__ メソッドを継承していますが、必要に応じてユーザーが独自にこのメソッドをクラス内で定義し直す(オーバーライドする)ことが可能です。__dir__ メソッドをオーバーライドすることで、dir() 関数がそのオブジェクトに対して返す属性のリストを自由にカスタマイズできます。これにより、特定の条件に応じて属性の表示・非表示を制御したり、動的に生成される属性名を含めたりするなど、より柔軟な属性管理を実現できます。このメソッドは、オブジェクトの自己検査(イントロスペクション)を可能にし、開発者がコードの動作を深く理解する手助けとなる重要な仕組みです。

構文(syntax)

1class MyObject:
2    def __dir__(self):
3        return ['attribute_name', 'method_name']

引数(parameters)

self, /

  • self: メソッドを呼び出しているオブジェクト自身

戻り値(return)

list[str]

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

関連コンテンツ

関連プログラミング言語