Python | 関数：help()

Python
スポンサーリンク

概要（help は「その場で公式説明を表示する」学習の最強の入口）

help() は、関数・クラス・モジュールなどの「公式説明（docstring）」を即座に表示する組み込み関数です。Web検索に行かなくても、その場で使い方・引数・戻り値・注意点にアクセスできます。初心者ほど「わからない→help→試す」を回すと理解が速く、迷いが減ります。

help(len)         # 組み込み関数の説明
import math
help(math)        # モジュールの概要と中身
from datetime import datetime
help(datetime)    # クラスの説明と主要メソッド
Python

基本の使い方（ここが重要）

help(対象) で「対象の説明」を表示する

関数、クラス、メソッド、モジュールなどをそのまま渡します。要点は「対象を値として渡す」こと。文字列ではなく実体（len, math.sqrt など）を渡すと正しく表示されます。

help(print)            # print の引数（sep, end, file など）が分かる
import math
help(math.sqrt)        # sqrt の仕様（引数・戻り値）だけに絞って読める
Python

引数なしの help() は「対話型ヘルプ」を起動する

help() とだけ打つと、対話型のヘルプ画面が立ち上がります。ここで名前を入力していくつも説明を連続で閲覧できます。終了は q などの指示に従います。

help()   # 起動後に "len" や "math" と入力していく
Python

docstring（ドキュメンテーション文字列）を表示する

help() が表示しているのは、対象に書かれた docstring です。自分で書いた関数にも docstring を付ければ、help に載る“自己説明”の関数になります。

def divide(a: float, b: float) -> float:
    """a を b で割って返す。b が 0 の場合は ZeroDivisionError。"""
    return a / b

help(divide)  # 自作関数でも説明が出る
Python

読み方のコツ（重要ポイントを深掘り）

最初の1行の「要約」を押さえる

help の最初の1行は、その対象が何者か（built-in function / class / module など）と、主な役割の要約です。まずここで方向性を掴み、引数や注意点の詳細へ進みます。

引数シグネチャを見る（位置・キーワード・デフォルト）

表示される関数のシグネチャで、位置引数・キーワード引数・デフォルト値が分かります。初心者は「省略可能か」「キーワード指定が必要か」を最優先で確認しましょう。

help(round)
# round(number[, ndigits]) のような表記から、ndigits が省略可能と分かる
Python

例外・副作用・注意書きに目を通す

失敗時の例外（例：ValueError、TypeError）や、ファイル書き込み・標準出力などの副作用、精度の注意などは help に書かれています。ここを先読みすると、デバッグが一気に楽になります。

実践の流れ（dir → help → 試す を小さく回す）

dir で「何があるか」を一覧し、help で深掘り

初めてのモジュールは、まず dir で名前をざっと見て、使いそうなものを help で詳しく読むのが近道です。

import math
print("sqrt" in dir(math))
help(math.sqrt)
Python

気になったメソッドを即試す（REPL で小さく検証）

REPL（対話モード）やノートブックで、見たばかりの関数を小さな入力で試します。help で読んだ内容を「手で確かめる」ことで、記憶と理解が定着します。

from pathlib import Path
help(Path)
p = Path("data") / "input.csv"
print(p.exists())
Python

よくあるつまずきと対策

文字列を渡しても助けてくれないことがある

help(“len”) のように文字列を渡すより、help(len) のように“実体”を渡すほうが確実です。モジュール名も import 済みのオブジェクトを渡しましょう。

import json
help(json)        # OK
# help("json")    # 環境によっては出ないことがある
Python

サードパーティライブラリは docstring の質がまちまち

外部ライブラリでは、docstring が簡素な場合があります。そのときは公式ドキュメントやソースを補助的に参照します。標準ライブラリは比較的充実しています。

ヘルプ表示が長いときは検索や絞り込みを意識する

表示が長い場合は “find” で探す（ターミナルやエディタの検索機能）か、対象を絞って help する（例：help(datetime) ではなく help(datetime.strptime)）と読みやすくなります。

例題で身につける（定番から一歩先まで）

例題1：組み込み関数の仕様を確認

help(len)
# 何に対して長さが取れるか、戻り値の型、注意点が分かる
Python

例題2：モジュールと特定関数の違いを読む

import math
help(math)         # 概要と包含関数の説明
help(math.hypot)   # 2次元ベクトル長の仕様をピンポイントで
Python

例題3：クラスのコンストラクタとメソッドを確認

from datetime import datetime
help(datetime)          # クラス全体像
help(datetime.strptime) # 文字列→日時の変換メソッド
print(datetime.strptime("2025-12-13", "%Y-%m-%d"))
Python

例題4：自作関数の docstring を help で確認

def slugify(text: str) -> str:
    """見出し文字列をURL用スラッグに変換する。
    前後空白を除去し、小文字化し、空白をハイフンに置換する。
    """
    s = text.strip().casefold()
    return "-".join(s.split())

help(slugify)
Python

まとめ

help() は「その場で公式説明を呼び出す」ための入口です。対象の実体を渡し、最初の1行で要点を掴み、引数・例外・注意点を読み切る。dir → help → 試す の小さなサイクルを回すと、標準ライブラリも外部ライブラリも怖くなくなる。自作関数にも docstring を付ければ、あなた自身のコードも “help 可能”になり、未来の自分と仲間が迷わなくなります。

スポンサーリンク
タイトルとURLをコピーしました