синтаксис и примеры получения сведений

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

Синтаксис функции:

help([object])

Если аргумент не указан, интерактивная справочная система запускается на консоли интерпретатора.

В справочной консоли python мы можем указать имена модулей, классов и функций, чтобы получить справочную документацию. Некоторые из них:

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.

Давайте посмотрим, как получить эту строку документации в качестве справочной документации в консоли 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)

Вывод

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

help в Python

23 mar. 15 21:18 21 dec. 17 15:40

Добавлено в Python 2.2

Вызывает встроенную справочную систему.

help([obj])

obj — Если передана строка, то производится попытка интерпретировать её как имя модуля, функции, класса, метода, или раздела документации, после чего справка выводится в консоль. Если передан объект любого другого типа, страница справки генерируется по его данным.

Функция предназначена в основном для использования в интерактивном режиме интерпретатора.

Если функция вызвана без аргументов, справочная система запускается в интерактивном режиме.

    help(str.split)
# Help on method_descriptor:
 
# split(...)
#    S.split(sep=None, maxsplit=-1) -> list of strings
# ...

Функция добавляется в пространство имён встроенных объектов модулем site.

Синонимы поиска: help