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

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

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

作成日: 更新日:

基本的な使い方

__dir__メソッドは、Pythonオブジェクトが持つ属性の名前リストを返すために使用される特殊メソッドです。このメソッドは、Pythonが特定の目的のために内部的に呼び出すことができるよう、あらかじめ定められた名前の規約に従っています。

具体的には、標準のdir()関数にオブジェクトを渡した際に、そのオブジェクトが持つメソッド、プロパティ、フィールドなどの識別子(名前)の一覧を取得するために内部的に呼び出されます。例えば、dir(my_object)と実行すると、my_objectがどのような操作やデータを持っているかを確認できますが、その際にmy_object.__dir__()が裏側で実行され、返されたリストが表示されています。

システムエンジニアを目指す方にとって特に重要な点として、自分で定義したカスタムクラスにおいてこの__dir__メソッドをオーバーライド(上書き)することで、dir()関数がそのクラスのインスタンスに対して返す属性リストをカスタマイズできることが挙げられます。これにより、特定の属性を動的に生成してリストに含めたり、外部から見せたくない内部的な属性を隠したりするなど、オブジェクトの振る舞いを柔軟に制御することが可能になります。 この機能は、Pythonオブジェクトの内部構造を理解し、デバッグ作業を行う際や、より高度な動的プログラミングを実現する上で非常に役立ちます。

構文(syntax)

1class MyObject:
2    pass
3
4obj = MyObject()
5obj.__dir__()

引数(parameters)

self

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

戻り値(return)

list[str]

Callクラスのインスタンスが持つ属性やメソッドの名前を文字列のリストとして返します。

関連コンテンツ

関連プログラミング言語