Функція help() в Python використовується для відображення документації модулів, функцій, класів, ключових слів тощо. Наприклад:
|
1 |
help(print) |
Результат:
Help on built-in function print in module builtins:
print(*args, sep=' ', end='\n', file=None, flush=False)
Prints the values to a stream, or to sys.stdout by default.
sep
string inserted between values, default a space.
end
string appended after the last value, default a newline.
file
a file-like object (stream); defaults to the current sys.stdout.
flush
whether to forcibly flush the stream.
Синтаксис функції help()
|
1 |
help(object) |
Параметри функції help()
Функція help() приймає один параметр:
object (не обов’язково) — об’єкт, за яким потрібно згенерувати довідку.
Значення, яке повертає функція help()
Функція help() повертає довідку за вказаним object.
Як працює функція help() в Python?
Функція help() має інтерактивне використання.
Спробуйте ввести наступне у вашій оболонці Python:
|
1 |
>>> help(list) |
|
1 |
>>> help(dict) |
|
1 |
>>> help(print) |
|
1 |
>>> help([1, 2, 3]) |
Примітка: В функцію help() передається об’єкт (а не рядок).
Якщо рядок передається як аргумент, він розглядається як назва модуля, функції, класу, методу, ключового слова або розділу документації, і виводиться сторінка довідки.
Спробуйте ввести наступне у вашій оболонці Python:
|
1 |
>>> help('random thing') |
|
1 |
>>> help('print') |
|
1 |
>>> help('def') |
|
1 2 |
>>> from math import * help('math.pow') |
Примітка: Рядок передається в якості аргументу в функцію help().
Якщо аргумент не передано, у консолі запускається довідкова утиліта Python (інтерактивна довідкова система):
|
1 |
>>> help() |
Потім ми можемо ввести назву об’єкта для отримання допомоги з написання Python-програм і використання модулів. Наприклад:
|
1 |
help > True |
|
1 |
help > 'print' |
|
1 |
help > print |
Щоб вийти з довідкової утиліти та повернутися до інтерпретатора, потрібно ввести quit та натиснути Enter.
|
1 |
help > quit |
