Python help() 関数

help()Python で組み込み関数、モジュール、オブジェクトなどのヘルプ情報を取得するための組み込み関数です。

ある関数やモジュールの使い方に疑問があるとき、help()最適な照会ツールです。詳細なドキュメント文字列（docstring）を表示し、関数の機能、パラメータ、戻り値の理解を助けます。

単語の意味： help「help」は「助ける」「ヘルプ」という意味で、ドキュメント情報を取得するために使用します。

基本構文とパラメータ

構文形式

help(object)
help('topic')

パラメータ説明

パラメータ object：
- 型: 任意のオブジェクト（関数、クラス、モジュールなど）
- 説明: ヘルプ情報を取得するオブジェクト。
パラメータ topic：
- 型: 文字列（string）
- 説明: テーマ名。モジュール名、関数名、キーワードなど。

関数の説明

戻り値：戻り値はありません。インタラクティブ環境で直接ヘルプ情報を表示します。
使用シーン：
- 関数の使い方を調べる
- モジュールの機能を調べる
- Python の構文を学ぶ

例

例1：関数のヘルプを表示

例

# len 関数のヘルプを表示
help(len)
# 出力:
# Help on built-in function len in module builtins:
# len(obj, /)
# Return the number of items in a container.

# print 関数のヘルプを表示
help(print)
# 出力:
# Help on built-in function print in module builtins:
# print(...)
# print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
# Prints the values to a stream or to sys.stdout by default.

# あるオブジェクトのヘルプを表示
help([].append)
# 出力:
# Help on method_descriptor:
# append(self, object, /) method of builtins.list instance
# L.append(object) -> None -- append object to end

コード解説:

関数名を直接渡して（括弧は不要）、ヘルプを表示します。
ヘルプ情報には、関数シグネチャ、パラメータの説明、機能の説明が含まれます。
メソッドの場合も、オブジェクトを通じてヘルプを取得できます。

例2：モジュールとトピックのヘルプを表示

例

# モジュールのヘルプを表示
import os
help(os)
# os モジュールの詳細なドキュメントが表示されます。すべての関数と定数の説明を含みます。

# 特定のトピックを表示
help("modules")
# 利用可能なすべてのモジュールが一覧表示されます

help("keywords")
# Python のすべてのキーワードが一覧表示されます

help("assert")
# assert 文の使い方が表示されます

コード解説:

モジュール全体のドキュメントを表示できます。
文字列パラメータを使用すると、特定のトピックのヘルプを表示できます。
「modules」トピックでは、インストールされているすべてのモジュールが一覧表示されます。

例3：スクリプトで help を使用する

例

# インタラクティブに使用（最も一般的）
# >>> help(list)
# list クラスのすべてのメソッドが表示されます

# データ型のヘルプを表示
help(int) # 整数型
help(str) # 文字列型
help(dict) # 辞書型
help(tuple) # タプル型

# 例外のヘルプを表示
help(ZeroDivisionError)
help(ValueError)

# 構文のヘルプを表示
help("with")
help("for")
help("if")

実行結果の想定:

実際の対話型 Python 環境で上記のコードを実行すると、詳細なヘルプドキュメントが表示されます。

help()Python を学ぶ上で最も強力なツールの一つです。日常のプログラミングで積極的に使用することをお勧めします。

Python3 組み込み関数

その他の拡張

Python3上級チュートリアル