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

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

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

作成日: 更新日:

基本的な使い方

__dir__メソッドは、あるオブジェクトが持つ属性やメソッドの名前のリストを取得するために使用される特殊メソッドです。Pythonの組み込み関数であるdir()が呼び出された際に、そのオブジェクトの内部でこの__dir__メソッドが実行され、利用可能な属性の一覧を返します。

例えば、Pythonの対話型インタープリタでオブジェクトに対してdir()関数を使うと、そのオブジェクトがどのようなデータ(プロパティ)や操作(メソッド)を持っているかを確認できます。このとき、裏側ではオブジェクトの__dir__メソッドが動いて、その情報を提供しているのです。

このメソッドは、クラスの設計者が特定のオブジェクトについてdir()関数が返す内容をカスタマイズしたい場合に、独自に実装(オーバーライド)することができます。これにより、オブジェクトの内部構造を外部から隠蔽したり、ユーザーにとって関連性の高い属性だけを表示したりといった、より柔軟な制御が可能になります。

システムエンジニアを目指す方々にとって、オブジェクトがどのような機能を持つのかを探索し、理解するための強力なツールとなります。Pythonのオブジェクト指向プログラミングにおいて、オブジェクトの振る舞いや構造を把握する上で非常に重要な役割を果たすメソッドの一つと言えるでしょう。

構文(syntax)

1class MyCustomClass:
2    def __init__(self):
3        self.public_attribute = "example"
4
5    def __dir__(self):
6        # This method defines the list of names (attributes and methods)
7        # that the built-in dir() function will return for instances
8        # of MyCustomClass. It must return a list of strings.
9        return ['public_attribute', 'custom_entry_a', 'another_item_b']
10
11instance = MyCustomClass()
12dir(instance)

引数(parameters)

self, /

  • self: オブジェクト自身

戻り値(return)

list[str]

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

関連コンテンツ

関連プログラミング言語