Python Help () Функция

Автор оригинала: Pankaj Kumar.

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

Python Help () Функция

Синтаксис функциональной помощи Python Help ():

help([object])

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

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

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Если вы хотите выйти из помощи консоли, введите Выйти Отказ

Мы также можем получить справочную документацию непосредственно из консоли Python, передав параметр, чтобы помочь () функции.

>>> help('collections')

>>> help(print)

>>> 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.

Определение справки () для пользовательских классов и функций

Мы можем определить вывод функции справки () для наших пользовательских классов и функций, определяя DocString (строку документации). По умолчанию первая строка комментариев в теле метода используется в качестве его 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

Обратите внимание, что мы определили DOCSTRING для функции, класса и его методов. Вы должны следовать некоторому формату для документирования, я создал некоторую часть из них автоматически с помощью Pycharm IDE. Numpy Docstring Guide это хорошее место, чтобы получить некоторую идею вокруг правильного способа помощи документации.

Давайте посмотрим, как получить эту DOCSTRING как справочную документацию в Python Console.

Прежде всего, нам придется выполнить этот скрипт в консоли для загрузки нашей функции и определения класса. Мы можем сделать это, используя EXEC () команда.

>>> exec(open("python_help_examples.py").read())

Мы можем проверить, что определения функций и классов присутствуют с использованием команды Globals ().

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': , '__spec__': None, '__annotations__': {}, '__builtins__': , '__warningregistry__': {'version': 0}, 'add': , 'Employee': }

Обратите внимание, что «работник» и «добавить» присутствуют в словаре глобального объема.

Теперь мы можем получить справочную документацию, используя функцию справки (). Давайте посмотрим на некоторые из примеров.

>>> 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)

Резюме

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

Ссылка: Официальная документация