今回は、Pythonの重要な説明関数であるPython help()関数を取り上げます。
help() メソッドの必要性
特定のプログラミング言語でコーディングしているとき、フレーム化された言語の基本的なドキュメントを知ることは非常に重要です。
このようなときに、help()関数の出番です。
この関数は、Python言語の基本的なドキュメントを私たちに提供します。
これは、特定のメソッドやクラスに関連するメソッドやインスタンスに関する情報を私たちに提供します。
help() メソッドはキーワード、クラス、関数、モジュールと連携し、それぞれ基本的な用語やインスタンス、それに付随する作業を理解する手助けをしてくれます。
通常、`help()’ メソッドは Python インタープリタと一緒に、パラメータとして渡された Python オブジェクトの基本的な詳細にアクセスするために使用されます。
Pythonのhelp()メソッドの動作について
上で述べたように、help()メソッドは渡されたPythonオブジェクトに関する情報を提供します。
もし help() function がパラメータなしで指定された場合、インタプリタコンソールが起動し、そこで任意のモジュール、オブジェクト、クラスなどを指定して、それに関するドキュメントを参照することができます。
例:
help()
|
結果は以下の通りです。
class Info:
lang = "Python"
name = "JournalDev"
obj = Info()
help(Info)
|
Pythonのhelp()関数とクラス
help 関数には、カスタマイズされた、あるいはあらかじめ定義されたパラメータを与えて作業することができます。
カスタマイズしたクラスを作成し、それを help() 関数に渡すことで、関数が提供するドキュメントを調査することができます。
例えば、以下の様になります。
Help on class Info in module __main__:
class Info(builtins.object)
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| lang = 'Python'
|
| name = 'JournalDev'
|
ユーザー定義のクラスを作成し、help()関数に渡しました。
help() 関数は、クラス ‘Info’ の必要なドキュメントを返しました。
結果は以下の通りです。
help('function-name')
|
Python help() 関数を使用した場合
help() 関数は、以下のコマンドを使用して、渡された関数の構文、パラメータリスト、説明文にアクセスするのに便利です。
構文は以下の様な感じです。
help('getattr')
|
例 1:
help('map')
|
結果は、以下の通りになります。
help('module-name')
|
例として以下の様になります。
help('seaborn')
|
結果を出力すると、以下の様になります。
help('keyword-name')
|
Pythonのhelp()関数とモジュール
help()関数を使うと、モジュールに関する情報を得ることができます。
モジュールが help() 関数に渡されると、バージョン、ファイルの場所、モジュールの内容、モジュールに関連するデータなどのドキュメントが提供されます。
構文は以下の通りです。
help(True)
|
例えば、以下の様になります。
help(int)
|
結果は以下の通りです。
キーワードを含む help() 関数
Python のキーワードを help() 関数のパラメータとして渡すと、そのキーワードのクラスや関連するメソッドなどのドキュメントが返されます。
構文は以下の様な感じです。
例 1:
結果は以下の通りです。
例として以下の様になります。
結果を出力すると、以下の様になります。
まとめ
ここまでで、このトピックは終了です。
help()関数の必要性と働きについて理解できました。
このコンセプトがすべての読者に理解されることを願っています。
もし何か疑問があれば、お気軽にコメントください。
参考文献
- help() メソッド – JournalDev
- help() メソッドに関するドキュメント