Pythonの__dir__関数について現役エンジニアが解説【初心者向け】

初心者向けにPythonの__dir__関数について現役エンジニアが解説しています。dir()関数とは、定義されている関数や属性などの一覧を調べることができる組み込み関数です。自分で変数などを定義してdir関数を呼び出して確認してみましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonの__dir__関数について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

 

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonの__dir__関数について詳しく説明していくね!

大石ゆかり

お願いします!

 

__dir__関数とは

dir()関数とは、定義されている関数や属性などの一覧を調べることができる組み込み関数です。

現在使用しているファイルで定義されている関数、属性などの名前を一覧で取得できます。

dir関数のPython公式ドキュメント
 

__dir__関数の使い方

dir()関数は組み込み関数なので宣言などは必要なく、Pythonプログラム上であればどこからでも呼び出すことができます。

下記文法でdir()関数が使用できます。

dir(引数)

引数を設定しない場合は、自分自身の属性返します。引数にモジュールを渡した時には、そのモジュール内で定義されている属性のファイルで定義されている名前がリストで返されます。
 

[PR] Pythonで挫折しない学習方法を動画で公開中

実際に書いてみよう

それではdir()関数を使用して、関数や属性などを取得するプログラムをサンプルコードを例に実際に書いてみましょう。
 

サンプルコード

print(dir())

 

実行結果

["__annotations__", "__builtins__", "__cached__","__doc__", "__file__", "__loader__", "__name__", "__package__", "__spec__"]

 

解説

まずはシンプルにdir()関数だけを 出力するサンプルコードになります。

コード1行目では、dir()関数の結果を出力しています。実行結果では組み込み関数がリスト形式で出力されていることが確認できます。
 

変数を追加して再度、dir()関数を実行

それでは先ほどのサンプルコードにいくつか変数を追加して、再度dir()関数を実行してみましょう。
 

サンプルコード

print(dir())

sample_txt = "sample"

sample_no = ["1","2","3","4","5"]

print(dir())

 

実行結果

['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']

['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'sample_no', 'sample_txt']

 

解説

コード1行目では、dir()関数の結果を出力しています。コード2行目では、変数”sample_txt”に文字列”sample”を設定しています。

コード3行目では、変数”sample_no”にリストで[“1″,”2″,”3″,”4″,”5”]を設定しています。コード4行目では、再度dir()関数の結果を出力しています。

実行結果ではコード1行目に対してコード4行目のdir()関数の結果が変数が追加されていることが確認できます。
 

まとめ

今回は、Pythonの__dir__関数について紹介しました。

この関数はプログラムのデバッグ作業などでよく使用されるものです。

また、コードを書いている途中で現在使用している変数の一覧などを知りたい時などに1行追加するだけで情報の取得が出来るので是非使い方を覚えておきましょう。
 

監修してくれたメンター

菅繕久(すがよしひこ)

現在はフリーランスのエンジニアをしていてプログラミング歴は8年目になります。

普段は Python、FileMaker等を使って様々な業務で活用できるIoTプロダクトRPAツールを作成しています。
開発実績としては、業務自動化ツール(在庫管理・発注・ファイル操作 etc)、電子カルテシステム、ロボット用プログラムなどがあります。
TechAcademyではPythonコースを担当しております。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。