Pythonのhelp()関数を徹底解説！困ったときに頼れる情報源

# 関数に関するヘルプ
print("--- len() 関数のヘルプ ---")
help(len)
# 出力例:
# Help on built-in function len in module builtins:
#
# len(obj, /)
#     Return the number of items in a container.

# モジュールに関するヘルプ
print("\n--- math モジュールのヘルプ ---")
import math
help(math)
# 出力例: (mathモジュール全体のドキュメントが表示される)
# Help on built-in module math:
#
# NAME
#     math
#
# DESCRIPTION
#     This module provides access to the mathematical functions defined by the C standard.
# ... (以下省略)

# クラスに関するヘルプ
print("\n--- str クラスのヘルプ ---")
help(str)
# 出力例: (strクラス全体のドキュメントが表示される)
# Help on class str in module builtins:
#
# class str(object)
#  |  str(object='') -> str
#  |  str(bytes_or_bytearray, encoding='utf-8', errors='strict') -> str
# ... (以下、メソッドなどの説明が続く)

# オブジェクトのメソッドに関するヘルプ
print("\n--- list.append() メソッドのヘルプ ---")
my_list = []
help(my_list.append)
# 出力例:
# Help on built-in method append of list instance:
#
# append(object, /) method of builtins.list instance
#     Append object to the end of the list.

# 対話型シェルで実行
# >>> help()
#
# Welcome to Python 3.x's help utility!
#
# If this is your first time using Python, you should definitely check out
# the tutorial at https://docs.python.org/3/tutorial/.
#
# Enter the name of any module, keyword, or topic to get help on.
# To quit this help utility and return to the interpreter, enter "quit".
#
# help> list
# ... (listに関するヘルプが表示される)
# help> topics
# ... (ヘルプトピックの一覧が表示される)
# help> quit
# You are now leaving help and returning to the Python interpreter.

def calculate_area(length, width):
    """
    長方形の面積を計算します。

    Args:
        length (int or float): 長方形の長さ。
        width (int or float): 長方形の幅。

    Returns:
        int or float: 計算された長方形の面積。

    Raises:
        ValueError: 長さまたは幅が非負でない場合に発生します。
    """
    if length < 0 or width < 0:
        raise ValueError("長さと幅は非負の数値である必要があります。")
    return length * width

class Circle:
    """
    円の情報を表すクラス。
    """
    def __init__(self, radius):
        """
        Circleオブジェクトを初期化します。

        Args:
            radius (int or float): 円の半径。
        """
        self.radius = radius

    def get_circumference(self):
        """
        円周を計算して返します。

        Returns:
            float: 円周の値。
        """
        return 2 * math.pi * self.radius

# help()で確認
print("\n--- calculate_area() 関数のヘルプ ---")
help(calculate_area)

print("\n--- Circle クラスのヘルプ ---")
help(Circle)

print("\n--- Circle.get_circumference() メソッドのヘルプ ---")
my_circle = Circle(5)
help(my_circle.get_circumference)