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

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

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

作成日: 更新日:

基本的な使い方

__dir__メソッドは、Pythonのオブジェクトが持つ属性(メソッドやプロパティ、フィールドなど)の名前のリストを返すメソッドです。このメソッドは、dir() 関数がオブジェクトの属性を一覧表示する際に内部的に呼び出されます。また、対話型シェルでオブジェクト名の後にドット(.)を入力してタブキーを押したときに表示される候補も、このメソッドが利用されて提供されています。これにより、オブジェクトがどのような要素を持っているのかを簡単に探索することができます。

AnnAssign クラスは、Pythonのコードが内部でどのように表現されているかを示す「抽象構文木(AST)」の一部であり、特に型ヒント付きの代入文(例えば variable: int = 10 のような構文)を表すノードです。この AnnAssign オブジェクトの __dir__ メソッドは、その型ヒント付き代入文が持つ具体的な情報、例えば代入対象の変数名、それに付けられた型アノテーション、そして代入される値など、関連する属性の名前をリストとして返します。

システムエンジニアを目指す初心者の方にとって、この __dir__ メソッドは、オブジェクトの内部構造を理解し、そのオブジェクトで利用可能な操作や情報を把握するための基本的なツールとして非常に有用です。既存のライブラリやフレームワークのオブジェクトが持つ機能を調べる際や、自分で作成したカスタムオブジェクトの振る舞いをデバッグする際などに役立ちます。

構文(syntax)

1import ast
2
3# Annotated assignment statement example: x: int = 1
4# Parse the code to create an Abstract Syntax Tree (AST)
5tree = ast.parse("x: int = 1")
6
7# The AnnAssign node is the first statement in the parsed tree's body
8ann_assign_node = tree.body[0]
9
10# Call the __dir__ method on the AnnAssign instance
11# This method lists the attributes and methods available on the object
12attributes = ann_assign_node.__dir__()

引数(parameters)

self

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

戻り値(return)

list[str]

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

関連コンテンツ

関連プログラミング言語