Python|help()関数の使い方

1. はじめに

Pythonでプログラミング学習を進める中で、「関数の使い方がわからない」「あるモジュールが何をするのか確認したい」と感じたことはありませんか?
そんな時に便利なのが、Pythonの組み込み関数である help() 関数です。

本記事では、Python|help()関数の使い方を、初心者の方にもわかりやすく丁寧に解説します。
基本的な使い方から、実務で役立つ活用方法、そして注意点まで具体的なコード例付きで紹介していきます。

 

2. help()関数とは?基本の使い方を解説

2-1. help()関数の概要

help()関数は、Pythonの標準組み込み関数のひとつで、関数やクラス、モジュールなどの情報を表示するために使います。
学習中に「この関数はどんな引数が使えるんだろう?」という場面で活躍する便利なヘルプ機能です。

Pythonのインタプリタ上で実行すると、インタラクティブなドキュメント表示が可能になります。

2-2. 基本的な使い方(変数や関数のヘルプを表示)

help(len)

実行結果:

Help on built-in function len in module builtins:

len(obj, /)
    Return the number of items in a container.

2-3. モジュール全体のヘルプを表示する

import math
help(math)

実行結果(抜粋):

Help on built-in module math:

NAME
    math - This module provides access to the mathematical functions...

FUNCTIONS
    acos(...)
    acosh(...)
    asin(...)
    ...

 

3. help()関数のよくある使い方・応用例

3-1. クラスやオブジェクトの情報を確認する

class Animal:
    """動物クラス"""
    def __init__(self, name):
        self.name = name

    def speak(self):
        """鳴き声を出す"""
        return "..."

help(Animal)

実行結果:

Help on class Animal in module __main__:

class Animal(builtins.object)
 |  動物クラス
 |
 |  Methods defined here:
 |
 |  __init__(self, name)
 |      Initialize self.
 |
 |  speak(self)
 |      鳴き声を出す

3-2. インタラクティブモードで使う場合の便利な使い方

help()

実行結果:

Welcome to Python 3.XX's help utility!
If this is your first time using Python, type "help", "copyright", "credits" or "license" for more information.
Type "modules" to see a list of available modules...

 

4. help()関数の注意点・エラー対策

4-1. 引数が不適切だとエラーになる

help(unknown_function)

実行結果:

NameError: name 'unknown_function' is not defined

このように、help()関数は定義済みの関数やモジュールでしか使えないことに注意しましょう。

4-2. インタラクティブシェル以外では出力が端末に依存

Jupyter Notebookなどの一部環境では、help()の出力が見づらい場合があります。
その場合は以下のように関数名のあとに?を付けることで、同様の情報を表示できます。

len?

 

5. まとめ

本記事ではPythonのhelp()関数の使い方について、基本から応用まで具体的なコード付きで解説しました。
help()関数を活用することで、関数やモジュールの仕様をすぐに確認でき、効率よく学習が進められます

最後にポイントをまとめておきましょう:

  • help()関数はPythonの関数・クラス・モジュールの情報確認に便利
  • 独自に定義したクラスや関数にも対応
  • Jupyter Notebookでは ? を使った確認も可能

💡実務や学習で困ったとき、「まずはhelp()で確認する」クセをつけておくと、ドキュメント検索の手間も減り、トラブル時にもすぐに対応できます!

タイトルとURLをコピーしました