Функция help( ) в Python

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

Синтаксис

help([object])

Параметры

• object: Необязательный параметр. Объект, для которого нужно получить справочную информацию. Это может быть модуль, функция, класс, метод, переменная или строка. Если параметр не указан, будет запущена интерактивная система справки.

Возвращаемое значение

Функция help не возвращает значения. Она выводит справочную информацию в стандартный поток вывода. Для выхода из справочной информации нажмите q.

Примеры использования

Пример 1: Вызов справки по встроенной функции

help(len)

Вывод:

Help on built-in function len in module builtins:

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

Пример 2: Вызов справки по модулю

import math
help(math)

Вывод:

Help on module math:

NAME
    math

MODULE REFERENCE
    https://docs.python.org/3.9/library/math.html

    The following documentation is automatically generated from the Python
    source files. It may be incomplete, incorrect or include features that
    are considered implementation details and may vary between Python
    implementations. When in doubt, consult the module reference at the
    location listed above.

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.

    acosh(x, /)
        Return the inverse hyperbolic cosine of x.

    ...

Пример 3: Вызов справки по классу

class MyClass:
    """Пример пользовательского класса."""
    
    def __init__(self, value):
        self.value = value

    def greet(self):
        """Приветствие."""
        return f"Hello, {self.value}!"

help(MyClass)

Вывод:

Help on class MyClass in module __main__:

class MyClass(builtins.object)
 |  Пример пользовательского класса.
 |  
 |  Methods defined here:
 |  
 |  __init__(self, value)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  greet(self)
 |      Приветствие.
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Пример 4: Вызов общей справки

help()

Вывод:

Welcome to Python 3.9's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.9/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

...

help>

Важные замечания

1. Докстринги: Справка, которую выводит функция help, основывается на докстрингах (docstrings). Поэтому важно включать докстринги в определение функций, классов и модулей для предоставления полезной информации.
2. Интерактивная справка: Если вызвать help без аргументов, запускается интерактивная система справки, которая позволяет исследовать доступные модули и функции в режиме реального времени.
3. Использование в IDE: Многие интегрированные среды разработки (IDE) и редакторы поддерживают отображение справочной информации по объектам прямо в редакторе кода, что делает использование helpеще удобнее.