Pythonのhelp()関数を日本語で言い換えてください。

12か月 ago

2 minutes

Pythonのhelp()関数は、指定されたモジュール、クラス、関数、変数などのドキュメントを取得するために使用されます。このメソッドは通常、Pythonのインタプリタコンソールで使用され、Pythonオブジェクトに関する詳細を取得します。

パイソンのhelp()関数の使い方

Pythonのhelp()関数の文法は次のようです。

help([object])

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

ヘルプコンソールから抜けたい場合は、quitと入力してください。また、help()関数にパラメータを渡すことで、Pythonコンソールから直接ヘルプドキュメントを取得することもできます。

>>> help('collections')

>>> help(print)

>>> help(globals)

globals()関数のhelp()関数の出力を見てみましょう。

>>> help('builtins.globals')

Help on built-in function globals in builtins:

builtins.globals = globals()
    Return the dictionary containing the current scope's global variables.
    
    NOTE: Updates to this dictionary *will* affect name lookups in the current global scope and vice-versa.

カスタムクラスや関数用のhelp（）を定義する

私たちは、docstring（ドキュメンテーション文字列）を定義することで、カスタムクラスや関数のhelp()関数の出力を定義することができます。デフォルトでは、メソッドの本体で最初のコメント文字列がそのドキュメンテーション文字列として使用されます。これは3つの二重引用符で囲まれています。次のコードが含まれるpython_help_examples.pyというPythonファイルがあるとします。

def add(x, y):
    """
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
    """
    return x + y


class Employee:
    """
    Employee class, mapped to "employee" table in Database
    """
    id = 0
    name = ''

    def __init__(self, i, n):
        """
        Employee object constructor
        :param i: integer, must be positive
        :param n: string
        """
        self.id = i
        self.name = n

関数、クラス、そのメソッドのドクストリングを定義していることに注意してください。ドキュメントには特定のフォーマットに従う必要があります。PyCharm IDEを使用して一部を自動生成しました。NumPyドクストリングガイドは、ヘルプドキュメントの適切な方法についてのアイデアを得るための良い場所です。次に、Pythonコンソールでこのドクストリングをヘルプドキュメントとして取得する方法を見てみましょう。まず、このスクリプトをコンソールで実行して、関数とクラスの定義を読み込む必要があります。これはexec()コマンドを使用して行うことができます。

>>> exec(open("python_help_examples.py").read())

我々は、globals() コマンドを使用して、関数とクラス定義が存在することを検証できます。

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__warningregistry__': {'version': 0}, 'add': <function add at 0x100dda1e0>, 'Employee': <class '__main__.Employee'>}

「Employee」と「add」という単語がグローバルスコープの辞書に存在していることに注意してください。help()関数を使用してヘルプドキュメントを取得できます。いくつかの例を見てみましょう。

>>> help('python_help_examples')

>>> help('python_help_examples.add')

Help on function add in python_help_examples:

python_help_examples.add = add(x, y)
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
(END)

>>> help('python_help_examples.Employee')

>>> help('python_help_examples.Employee.__init__')


Help on function __init__ in python_help_examples.Employee:

python_help_examples.Employee.__init__ = __init__(self, i, n)
    Employee object constructor
    :param i: integer, must be positive
    :param n: string
(END)

要約すると、日本語でネイティブに表現すると以下のようになります。「概要」

Pythonのhelp()関数は、モジュール、クラス、関数の詳細情報を取得するのに非常に役立ちます。自作のクラスや関数には、使用方法を説明するためのdocstringを定義することが常に最善の方法です。

私たちのGitHubのリポジトリから、完全なPythonスクリプトとさらに多くのPythonの例をチェックアウトできます。

参照: 公式ドキュメンテーション