help()

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

Сигнатура

help()
help(object)

Параметры:

• object — модуль, класс, функция, метод, ключевое слово или строка с именем.

Возвращает: None (выводит текст в стандартный поток).

Примеры

Справка по встроенной функции:

help(len)

Help on built-in function len in module builtins:

len(obj, /)
    Return the number of items in a container.

Справка по методу строкового типа:

help(str.upper)

Help on method_descriptor:

upper(self, /)
    Return a copy of the string converted to uppercase.

Документация своего класса:

class Robot:
    """Простая модель робота с двумя моторами."""
    def move(self, speed):
        """Запустить движение с заданной скоростью."""

help(Robot)

Help on class Robot in module __main__:

class Robot(builtins.object)
 |  Простая модель робота с двумя моторами.
 |
 |  Methods defined here:
 |
 |  move(self, speed)
 |      Запустить движение с заданной скоростью.

Передача имени строкой:

help("keywords")

Here is a list of the Python keywords.  Enter any keyword to get more help.

False               class               from                or
None                continue            global              pass
...

Запуск интерактивного режима:

help()

Welcome to Python 3.x's help utility!
...
help>

Совет

В IDE и Jupyter удобнее вызывать help() в отдельной ячейке: вывод может быть длинным и заполнит окно. Для краткой подсказки используйте ? (IPython) или встроенный поиск.

См. также

• dir()

• getattr()

• hasattr()

Примечание

Описание основано на официальной документации Python (docs.python.org), распространяемой под лицензией PSF License v2. © Python Software Foundation.