Функция справки Python()

Функция Python help() используется для получения документации по указанному модулю, классу, функции, переменным и т. д. Этот метод обычно используется с консолью интерпретатора Python для получения подробной информации об объектах Python.

Функция справки Python()

Синтаксис функции Python help():

help([object])

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Если вы хотите выйти из справочной консоли, введите quit. Мы также можем получить справочную документацию непосредственно из консоли Python, передав параметр функции help().

>>> help('collections')

>>> help(print)

>>> help(globals)

Давайте посмотрим, что выдает функция help() для функции globals().

>>> 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() для пользовательского класса и функций

Мы можем определить вывод функции help() для наших пользовательских классов и функций, определив docstring (строку документации). По умолчанию в качестве строки документации используется первая строка комментария в теле метода. Оно заключено в три двойных кавычки. Допустим, у нас есть файл python python_help_examples.py со следующим кодом.

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'>}

Обратите внимание, что «Сотрудник» и «Добавить» присутствуют в словаре глобальной области видимости. Теперь мы можем получить справочную документацию с помощью функции 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() очень полезна для получения подробной информации о модулях, классах и функциях. Всегда лучше определить строку документации для пользовательских классов и функций, чтобы объяснить их использование.

Вы можете проверить полный скрипт Python и другие примеры Python в нашем репозитории GitHub.

Ссылка: Официальная документация