Pythonのhelp()関数の使い方 – ドキュメントを手軽に参照する方法

Pythonでプログラミングをしていると、関数やモジュールの詳細な仕様をドキュメントで確認したくなる場面が多くあります。そんなときに役立つのが、Pythonに標準で組み込まれている help() 関数です。この関数を使えば、インタプリタやスクリプトから直接、必要なドキュメント情報を素早く参照できます。

基本構文

help('term')

「term」には、ヘルプを表示したい対象(モジュール名、関数名、クラス名、キーワードなど)を文字列で指定します。

使用例

以下の例では、「time」モジュールに関するヘルプを取得しています。出力はPython公式ドキュメントをもとに生成されており、非常に網羅的な内容となっています。

print(help('time'))

実行結果

上記のコードを実行すると、以下のような結果が出力されます。

Help on built-in module time:
NAME
time - This module provides various functions to manipulate time values.

DESCRIPTION
There are two standard representations of time. One is the number
of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer
or a floating point number (to represent fractions of seconds).
The Epoch is system-defined; on Unix, it is generally January 1st, 1970.
The actual value can be retrieved by calling gmtime(0).
………………

補足：対話モードの活用

help() を引数なしで呼び出すと、対話型のヘルプユーティリティが起動します。このモードでは、調べたいキーワードを続けて入力でき、終了するには「q」を入力します。また、help(print) のように組み込み関数を直接指定することも可能です。

まとめ

help() 関数を活用すれば、Webでドキュメントを検索しなくても、その場ですぐに仕様を確認できます。日々の開発作業を効率化するための基本的かつ強力なツールなので、ぜひ習慣として使いこなしましょう。