help
Выводит справку по функции, классу, модулю или другому объекту.
Python 3.13
help([request])Параметры
- requestAnyнеобязательный
- Объект, по которому нужна справка, например len или str.split; строкой можно задать имя модуля или ключевого слова.
Возвращаемое значение
Ничего (None) — справка выводится на экран.
Примеры
Справка по своей функции
Python 3.13
def area(width, height):
"""Return the area of a rectangle."""
return width * height
help(area)Help on function area in module __main__:
area(width, height)
Return the area of a rectangle.Справка по встроенной функции
Python 3.13
help(len)Help on built-in function len in module builtins:
len(obj, /)
Return the number of items in a container.Подробности
Справка собирается из сигнатуры и строки документации (docstring), поэтому для своих функций стоит писать docstring. Без аргумента help() запускает интерактивную справку, которая ждёт ввода с клавиатуры, поэтому в программах передают конкретный объект. Справка по целому модулю, например help(math), очень длинная.