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

【Python3.x】dir()関数の使い方

dir関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

dir関数は、オブジェクトがどのような属性(メソッドや変数など)を持っているかを確認するために使用する関数です。この関数は、引数を指定して呼び出す場合と、引数なしで呼び出す場合の二つの主な使い方があります。

オブジェクトを引数としてdir関数に渡すと、そのオブジェクトが持つ有効な属性の名前を文字列のリストとして返します。例えば、あるデータ型やモジュールがどのような操作を提供しているのか、どのような情報にアクセスできるのかを知りたいときに非常に役立ちます。これにより、オブジェクトの構造を理解し、利用可能な機能を発見する手助けとなります。

一方、引数を指定せずにdir関数を呼び出すと、現在のスコープ(現在実行中のコードの文脈)で定義されている名前の一覧を文字列のリストとして返します。これには、現在のモジュールで定義されている変数、関数、クラス、インポートされたモジュールなどが含まれます。これにより、現在の実行環境で利用可能な名前空間の内容を把握することができます。

dir関数は、Pythonのインタラクティブシェルでの探索や、プログラムのデバッグ時、または新しいライブラリやフレームワークを学習する際に、オブジェクトの機能を素早く理解するための強力なツールとして利用されます。返されるリストはアルファベット順にソートされており、特殊な属性(アンダースコアで始まる属性など)も含まれることがあります。

構文(syntax)

1dir([object])

引数(parameters)

obj: object = None

  • obj: object = None: 属性やメソッドを調べたいオブジェクト。指定しない場合は現在のローカルスコープとグローバルスコープの属性・メソッドを調べます。

戻り値(return)

list

指定されたオブジェクト(モジュール、クラス、インスタンスなど)が持つ属性(メソッド、プロパティ、定数など)の名前を文字列として格納したリストを返します。

関連コンテンツ

関連プログラミング言語