Pythonには、モジュールやパッケージに含まれる属性や関数を調べるための便利な組み込み関数があります。それがdir
とhelp
関数です。
dir
関数は、オブジェクトが持っている属性やメソッドのリストを返します。具体的には、モジュールやパッケージ、クラス、または任意のオブジェクトに対して使用することができます。
例えば、Pythonの標準ライブラリのmath
モジュールが提供する関数や属性を調べるには、以下のようにします。
import math
print(dir(math))
Pythonこのコードを実行すると、math
モジュールが提供するすべての関数名や定数名のリストが出力されます。
一方、help
関数は、モジュール、パッケージ、関数、クラスなどについての詳細な情報を提供します。これはPythonのドキュメンテーション(Docstring)から情報を引き出しています。
例えば、math
モジュールのsqrt
関数についての詳細な情報を得るには、以下のようにします。
import math
help(math.sqrt)
Pythonこのコードを実行すると、sqrt
関数の説明、引数の型、戻り値の型、および使用例などの詳細な情報が表示されます。
これらのdir
とhelp
関数は、Pythonのコードを理解するための強力なツールです。新しいモジュールやパッケージを学ぶ際には、これらの関数を活用してください。