Функция help в python: Функция help() в Python, справка по любому объекту.

Способ справки Python () — pythobyte.

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

Эй, ребята! В этой статье мы будем сосредоточиться на важной объяснительной функции в Python – Python Help () Функция Отказ

Нужен метод справки ()

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

Эта функция предоставляет нам основную документацию языка Python. Это дает нам информацию о методах и экземплярах, связанных с конкретным методом или классом.

Способ справки () работает с Ключевые слова , Классы , Функции и модули Чтобы помочь нам получить основные терминологии, экземпляры и работать с ней соответственно.

Обычно Справка () Метод используется рядом с Переводчик Python Чтобы получить доступ к основным деталям о объектах Python, переданному ему в качестве параметра.

Метод работы Python Help ()

Как упомянуто выше, метод справки () предоставляет информацию о объектах Python, переданной ему.

Если Справка () Функция упоминается без какого-либо параметра, он запускает консоль интерпретатора, в которой мы можем упомянуть любой

Пример:

help()

Выход:

Python Help () Функция с классом

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

Пример:

class Info:
    lang = "Python"
    name = "JournalDev"
obj = Info()
help(Info)

Мы создали пользовательский класс и передали его на функцию справки ().

Выход:

Help on class Info in module __main__:
class Info(builtins.object)
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)
 |  
 |  ----------------------------------------------------------------------
 |  Data and other attributes defined here:
 |  
 |  lang = 'Python'
 |  
 |  name = 'JournalDev'

Python Help () Функция с функцией

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

Синтаксис:

 
help('function-name')

Пример 1:

help('getattr')

Выход:

Пример 2:

 
help('map')

Выход:

Python Help () Функция с модулем

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

Синтаксис:

help('module-name')

Пример:

help('seaborn')

Выход:

Функция справки () с ключевым словом

При прохождении ключевого слова Python в качестве параметра на функцию справки () функция возвращает документацию в терминах класса ключевого слова, методы, связанные с ним и т. Д.

Синтаксис:

help('keyword-name')

Пример 1:

help(True)

Выход:

Пример 2:

help(int)

Выход:

Заключение

Этим мы дошли до конца этой темы. Мы поняли необходимость и работаю функцией справки (). Я надеюсь, что эта концепция ясна всем читателям.

Пожалуйста, не стесняйтесь комментировать, на случай, если вы возникли сомнения.

Рекомендации

• Справка () Метод – MountainDev
• Документация по справке () методу

синтаксис и примеры получения сведений

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

Синтаксис функции:

help([object])

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

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

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Если вы хотите выйти из справочной консоли, введите quit.

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

>>> help('collections')

>>> help(print)

>>> help(globals)

Посмотрим, что выводит функция 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.

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

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

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

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

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

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

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

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__warningregistry__': {'version': 0}, 'add': <function add at 0x100dda1e0>, 'Employee': <class '__main__.Employee'>}

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

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

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

Вывод

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

Функция Python help()

Нам всем нужна помощь в какой-то момент времени, когда мы застряли. Каждый раз, когда учитель или старший не остается, чтобы помочь нам. При написании кода Python нам может понадобиться знать значение определенных ключевых слов Python , классов , модулей , функций и т. д. К счастью, Python также предлагает решение для таких безвыходных ситуаций. В этой статье вы узнаете о функции help() Python.

Что такое функция Python help()?

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

Синтаксис его использования:

  help(object)  

Здесь объект — это параметр, который функция help() принимает для предоставления документации об этом конкретном ключевом слове Python, классе, модуле, функции.

Различные способы использования help() :

Есть два разных способа использования help(). Это:

Программисты Python могут напрямую использовать справку в консоли . Для этого программист должен вызвать функцию help() сразу после приглашения Python .

  >>> help(['1', '2', '3'])  

Или,

  >>> help(print)  

Программисты Python также могут использовать функцию help() в Режим сценария . Но в этой ситуации программист должен использовать функцию help() внутри функции print(). В противном случае документация не будет отображаться.

  print(help(['1', '2', '3']))  

или,

  а= справка(['1', '2', '3'])
print(a)  

Вывод:

Передача строкового аргумента в функцию help():

Когда программист передает строку в help() в качестве параметра функция преобразует строку в допустимое имя токена Python, такое как ключевое слово, модуль, функция, метод, класс или раздел документации. Затем он отобразит соответствующую справочную документацию, связанную с этим именем строки. Одинарная кавычка или двойная кавычка  – допустимый способ указать строку в функции help().

Например:

  >>> помощь('для')
>>> help("def")  

Вывод:

help() Работает с библиотекой:

Существуют ситуации, когда функция help() требует импорта библиотеки для вызова документации для любого конкретного метода или функции, находящейся в этой библиотеке или модуле. Возьмем ситуацию, когда:

  print(help(log))  

или,

  print(help(math.log))  

В такой ситуации программистам необходимо использовать оператор импорта и включить имя библиотеки в программу. Затем с помощью функции help() будет работает нормально, так как библиотека содержит документацию , которая вызывается функцией help().

Пример:

  импорт математики
print(help(math.log))  

Вывод:

Функция help() без аргументов:

Мы можем использовать функцию справки, не передавая ей никаких аргументов. Если вы запустите эту функцию без аргументов, она автоматически запустит интерактивную справочную утилиту Python на консоли интерпретатора.

  >>> help()  

В режиме сценария мы можем использовать print(help()). Он также открывает утилиту справки в разделе консоли.

Пример:

  print(help())  

Вывод:

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

Создание пользовательской документации help() для пользовательских функций:

Программисты также могут подготовить документацию для пользовательских или пользовательских функций. Программисты должны воспользоваться строкой документации  , чтобы сделать то же самое. Строки документации объявляются с использованием «набора тройных одинарных кавычек » или «набора тройных двойных кавычек»» прямо под объявлением функции, метода или класса.

Когда мы предоставляем строку документации под телом функции, интерпретатор Python принимает ее как документацию, описывающую, что делает функция.

Программа:

  по определению addi(a, b, c):
    """
    Эта функция складывает три заданных целых числа g, h и i.
    :1-й параметр: целое число
    :2-й параметр: целое число
    :3-й параметр: целое число
    : возвращает: целое
    """
    вернуть а + б + с

print(help(addi))  

Вывод:

Вывод:

Поскольку вы ознакомились со справкой по Python, теперь вы не застряли и можете легко обратиться за помощью к этой функции. Всегда рекомендуется использовать режим консоли  для поиска помощи с помощью функции help(). Справка по использованию консольного режима — это простой способ получить и прочитать документацию.

Функция Python help() — пример и объяснение

Python help() — это встроенная функция, которая вызывает встроенную справочную систему. Он возвращает всю справку, связанную с любым модулем, функцией или объектом, переданным в качестве аргумента функции.

Python help() Синтаксис

 help(object) 

Python help() функция принимает один аргумент.

• объект (опционально) – название объекта, для которого должна быть сформирована справка.

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

Аргумент может быть строкой или нестроковым объектом.

• Если аргумент является строкой, то строка ищется как имя модуля, функции, класса, метода, ключевого слова или раздела документации, и на консоли печатается страница справки.
• Если аргументом является любой другой объект, а не строка, создается страница справки по соответствующему объекту.

Как работает help() в Python?

Функция Python help() показывает встроенную справочную утилиту в консоли, если не указан аргумент.

Вот пример.

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

 справка > установить
Справка по набору классов во встроенных модулях:

набор классов (объект)
 | set() -> новый пустой объект набора
 | set(iterable) -> новый заданный объект
 |
 | Создайте неупорядоченную коллекцию уникальных элементов.
 |
 | Определенные здесь методы:
 |
 | __and__(я, значение, /)
 | Вернуть себя и ценность.
 |
 | __содержит__(...)
 | x.__contains__(y) <==> y в x.
 |
 | __eq__(я, значение, /)
 | Вернуть значение self==.
 |
 | __ge__(я, значение, /)
 | Вернуть self>=значение.  себя.
 |
 | __размер__(...)
 | S.__sizeof__() -> размер S в памяти, в байтах
 |
 | __sub__(я, значение, /)
 | Вернуть самооценку.
 |
 | __xor__(я, значение, /)
 | Возвратить собственное значение.
 |
 | добавлять(...)
 | Добавьте элемент в набор.
 |
 | Это не имеет никакого эффекта, если элемент уже присутствует.
 |
 | Чисто(...)
 | Удалите все элементы из этого набора.
 |
 | копировать(...)
 | Возвращает неглубокую копию набора.
 |
 | разница(...)
 | Верните разницу двух или более наборов в качестве нового набора.
 |
 | (т.е. все элементы, которые есть в этом наборе, но не в других.)
 |
 | разность_обновление(...)
 | Удалить все элементы другого набора из этого набора.
 |
 | отказаться(...)
 | Удалить элемент из набора, если он является членом.
 |
 | Если элемент не является членом, ничего не делайте.
 |
 | пересечение (...)
 | Верните пересечение двух наборов как новый набор.
 |
 | (т.е. все элементы, которые есть в обоих наборах.)
 |
 | пересечение_обновление(. ..)
 | Обновите набор с пересечением себя и другого.
 |
 | является непересекающимся (...)
 | Возвратите True, если два набора имеют нулевое пересечение.
 |
 | подмножество(...)
 | Сообщите, содержит ли другой набор этот набор.
 |
 | issuperset(...)
 | Сообщите, содержит ли этот набор другой набор.
 |
 | поп(...)
 | Удалить и вернуть произвольный элемент множества.
 | Вызывает KeyError, если набор пуст.
 |
 | удалять(...)
 | Удалить элемент из множества; это должен быть член.
 |
 | Если элемент не является членом, вызовите KeyError.
 |
 | симметричная_разность(...)
 | Верните симметричную разность двух наборов как новый набор.
 |
 | (т.е. все элементы, которые находятся ровно в одном из наборов.)
 |
 | симметричное_difference_update(...)
 | Обновите набор с симметричной разностью себя и другого.
 |
 | союз(...)
 | Вернуть объединение наборов как новый набор.
 |
 | (т.е. все элементы, которые есть в любом наборе.)
 |
 | Обновить(...)
 | Обновите набор с объединением себя и других. 
 |
 | -------------------------------------------------- --------------------
 | Данные и другие атрибуты, определенные здесь:
 |
 | __хэш__ = нет

 

Эту справочную утилиту можно закрыть, просто введя следующие команды.

 help > quit 

Это все для справочной утилиты, которая открывается в консоли при запуске функции help() без каких-либо аргументов. Вы также можете просмотреть документацию и всю справку, связанную с ключевым словом, передав это ключевое слово в качестве аргумента функции справки.

Python help() Пример — с аргументами

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

Вот пример.

 >>> справка(дикт)
Справка по классу dict во встроенных модулях:

класс dict (объект)
 | dict() -> новый пустой словарь
 | dict(mapping) -> новый словарь, инициализированный из объекта сопоставления
 | (ключ, значение) пары
 | dict(iterable) -> новый словарь инициализируется как бы через:
 | д = {}
 | для k, v в итерации:
 | д[к] = v
 | dict(**kwargs) -> новый словарь, инициализированный парами имя=значение
 | в списке аргументов ключевого слова.  Например: dict(один=1, два=2)
 |
 | Определенные здесь методы:
 |
 | __contains__(я, ключ, /)
 | Истинно, если D имеет ключ k, в противном случае — Ложь.
 |
 | __delitem__(я, ключ, /)
 | Удалить себя [ключ].
 |
 | __eq__(я, значение, /)
 | Вернуть значение self==.
 |
 | __ge__(я, значение, /)
 | Вернуть self>=значение.
 |
 | __getattribute__(я, имя, /)
 | Вернуть getattr(я, имя).
 |
 | __получить элемент__(...)
 | x.__getitem__(y) <==> x[y]
 |
 | __gt__(я, значение, /)
 | Возвращает значение self>value.
 |
 | __init__(я, /, *args, **kwargs)
 | Инициализировать себя. См. help(type(self)) для точной подписи.
 |
 | __iter__(я, /)
 | Реализовать iter(self).
 |
 | __le__(я, значение, /)
 | Вернуть self<=значение.
 |
 | __len__(я, /)
 | Вернуть лен(себя).
 |
 | __lt__(я, значение, /)
 | Вернуть себя<значение.
 |
 | __ne__(я, значение, /)
 | Вернуть себя!=значение.
 |
 | __new__(*args, **kwargs) из builtins.type
 | Создать и вернуть новый объект. См.  справку (тип) для точной подписи.
 |
 | __repr__(я, /)
 | Вернуть репр(себя).
 |
 | __setitem__(я, ключ, значение, /)
 | Установите для себя [ключ] значение.
 |
 | __размер__(...)
 | D.__sizeof__() -> размер D в памяти, в байтах
 |
 | Чисто(...)
 | D.clear() -> Нет. Удалите все элементы из D.
 |
 | копировать(...)
 | D.copy() -> мелкая копия D
 |
 | fromkeys(iterable, value=None, /) из builtins.type
 | Возвращает новый словарь с ключами из итерации и значениями, равными значению.
 |
 | получить(...)
 | D.get(k[d]) -> D[k], если k в D, иначе d. d по умолчанию имеет значение Нет.
 |
 | Предметы(...)
 | D.items() -> объект, похожий на набор, обеспечивающий просмотр элементов D.
 |
 | ключи(...)
 | D.keys() -> объект, подобный набору, предоставляющий представление о клавишах D.
 |
 | поп(...)
 | D.pop(k[d]) -> v, удалить указанный ключ и вернуть соответствующее значение.
 | Если ключ не найден, возвращается d, если он задан, в противном случае возникает KeyError
 |
 | попить(. ..)
 | D.popitem() -> (k, v), удалить и вернуть некоторую пару (ключ, значение) в виде
 | 2-кортеж; но вызовите KeyError, если D пуст.
 |
 | установить по умолчанию(...)
 | D.setdefault(k[d]) -> D.get(k,d), также установите D[k]=d, если k не в D
 |
 | Обновить(...)
 | D.update([E,]**F) -> Нет. Обновите D из dict/iterable E и F.
 | Если E присутствует и имеет метод .keys(), то делает: для k в E: D[k] = E[k]
 | Если E присутствует и не имеет метода .keys(), то имеет: для k, v в E: D[k] = v
 | В любом случае за этим следует: для k в F: D[k] = F[k]
 |
 | ценности(...)
 | D.values() -> объект, предоставляющий представление о значениях D
 |
 | -------------------------------------------------- --------------------
 | Данные и другие атрибуты, определенные здесь:
 |
 | __хэш__ = нет
 

Встроенные функции Python

❮ Предыдущий Далее ❯

Python имеет набор встроенных функций.

Функция	Описание
abs()	Возвращает абсолютное значение числа
all()	Возвращает True, если все элементы в итерируемом объекте истинны итерируемый объект верен
ascii()	Возвращает читаемую версию объекта. Заменяет символы NON-ASCII с помощью экологического символа
BIN ()	Возвращает бинарную версию числа
Bool ()	Возвращает значение Boolean aeppied object	. Возвращает массив байтов
bytes()	Возвращает объект байтов
callable()	Возвращает True, если указанный объект является вызываемым, иначе False
chr()	Возвращает символ из указанного Юникод код.
classmethod()	Преобразует метод в метод класса
compile()	Возвращает указанный источник как объект, готовый к выполнению
delattr()	Удаляет указанный атрибут (свойство или метод) из указанного объекта
DICT ()	Возвращает словарь (массив)
DIR ()	Возвращает список указанных свойств объекта и методов
2	2	2	2
363770 2	2	2
enumerate()	Берет набор (например, кортеж) и возвращает его как перечисляемый объект
eval()	Вычисляет и выполняет выражение
exec()	Выполняет указанный код (или объект)
filter()	Использовать функцию фильтра для исключения элементов в итерируемом объекте number
format()	Форматирует указанное значение
FrozenSet()	Возвращает объект Frozenset
getattr()	1 71
globals()	Возвращает текущую глобальную таблицу символов в виде словаря
hasattr()	Возвращает True, если указанный объект имеет указанный атрибут (свойство/метод)	Возвращает хеш-значение указанного объекта
help()	Выполняет встроенную справочную систему
hex()	Преобразует число в шестнадцатеричное значение
id()	Returns the id of an object
input()	Allowing user input
int()	Returns an integer number
isinstance()	Returns True, если указанный объект является экземпляром указанного объекта
issubclass()	Возвращает True, если указанный класс является подклассом указанного объекта
iter()	Возвращает объект итератора
len()	Возвращает длину объекта
list()	Возвращает список table
map()	Возвращает указанный итератор с указанной функцией, примененной к каждому элементу
max()	Возвращает самый большой элемент в итерируемом
memoryview()	Returns a memory view object
min()	Returns the smallest item in an iterable
next()	Returns the next item in an iterable
object ()	Возвращает новый объект
oct()	Преобразует число в восьмеричное
open()	Открывает файл и возвращает файловый объект	8	0270 ord()	Преобразование целого числа представляет Unicode указанного символа
pow()	Возвращает значение x в степени y
print()	Выводит на стандартное устройство вывода
range()	Возвращает последовательность чисел, начиная с 0 и увеличивая на 1 (по умолчанию)
repr ()	Возвращает читаемую версию объекта
. set object
setattr()	Устанавливает атрибут (свойство/метод) объекта
slice()	Возвращает отсортированный список объектов
sorted()0271
staticmethod()	Converts a method into a static method
str()	Returns a string object
sum()	Sums the items of an iterator
super( )	Возвращает объект, представляющий родительский класс
tuple()	Возвращает кортеж
type()	Возвращает тип объекта
vars()	Возвращает свойство __dict__ объекта
zip()	Возвращает итератор из двух или более итераторов

❮ Предыдущий Далее ❯

НОВИНКА

Мы только что запустили
Видео W3Schools

Узнать

ВЫБОР ЦВЕТА

КОД ИГРЫ

Играть в игру

Top Tutorials

Основные ссылки

Лучшие примеры

W3Schools оптимизирован для обучения и обучения. Примеры могут быть упрощены для улучшения чтения и обучения. Учебники, ссылки и примеры постоянно пересматриваются, чтобы избежать ошибок, но мы не можем гарантировать полную правильность всего содержания.