Определение
Функция help() в Python используется для получения информации о модулях, классах, методах, функциях и других объектах. Она является встроенной функцией, которая предоставляет интерактивную справочную систему, аналогичную документации.
Синтаксис
Синтаксис функции help() выглядит следующим образом:
help(object)
Где:
- object — это объект, о котором необходимо получить информацию.
Примеры
Справка по функции
К примеру получим справку по функции print:
help(print)
# Вывод:
# Help on built-in function print in module builtins:
#
# print(...)
# print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
#
# Prints the values to a stream, or to sys.stdout by default.
# Optional keyword arguments:
# file: a file-like object (stream); defaults to the current sys.stdout.
# sep: string inserted between values, default a space.
# end: string appended after the last value, default a newline.
# flush: whether to forcibly flush the stream.
#
# None
Справка по модулю
К примеру получим справку по модулю math:
import math
help(math)
# Вывод:
# Help on built-in module math:
#
# NAME
# math
#
# DESCRIPTION
# This module provides access to the mathematical functions
# defined by the C standard.
#
# FUNCTIONS
# acos(x, /)
# Return the arc cosine (measured in radians) of x.
#
# The result is between 0 and pi.
#
# acosh(x, /)
# Return the inverse hyperbolic cosine of x.
#
# asin(x, /)
# Return the arc sine (measured in radians) of x.
#
# The result is between -pi/2 and pi/2.
#
# asinh(x, /)
# Return the inverse hyperbolic sine of x.
#
# atan(x, /)
# Return the arc tangent (measured in radians) of x.
#
# The result is between -pi/2 and pi/2.
#
# atan2(y, x, /)
# Return the arc tangent (measured in radians) of y/x.
#
# Unlike atan(y/x), the signs of both x and y are considered.
#
# atanh(x, /)
# Return the inverse hyperbolic tangent of x.
#
# ...
Справка по модулю math на самом деле выглядит больше, в примере показана лишь часть из неё.
Справка по строке
Если передать строку, которая соответствует ключевому слову, библиотеке или модулю, функция help() постарается найти и отобразить соответствующую документацию.
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
# True def if raise
# and del import return
# as elif in try
# assert else is while
# async except lambda with
# await finally nonlocal yield
# break for not
Справка по пользовательской функции
Также мы можем получать справку по пользовательским функциям. Например создадим простую функцию и добавим к ней справку.
def my_function():
"""Это пользовательская функция."""
pass
help(my_function)
# Вывод:
# Help on function my_function in module __main__:
#
# my_function()
# Это пользовательская функция.
Заключение
В ходе статьи мы с Вами узнали как работает функция help() в Python. Надеюсь Вам понравилась статья, желаю удачи и успехов! 🙂
Мой Telegram канал
Мой YouTube канал
Курс по Python (50 видоуроков + дополнительные уроки)
Курс по созданию телеграм-ботов на Python с фреймворком Aiogram