Ваш вопрос относится к Python IDLE.В IDLE эта функция включена по умолчанию.Чтобы это работало, функция (или метод) должна быть доступна в текущем пространстве имен. Это означает, что она должна быть определена в рабочей среде или импортирована в рабочую среду.
Например:
>>> def foo(x)
"""the foo function"""
return x
когда вы наберете >>> foo(
в приглашении после определения, вы увидите объяснение, которое действительно является документацией, содержащейся в строке документации (материал междутройные кавычки).
Если у функции или метода нет документации, вы не увидите никаких объяснений.Например,
>>> def bar(y):
return y
В этом случае, когда вы вводите bar(
в приглашении, IDLE просто покажет y
, это потому, что функция не имеет никакой документации.
Некоторые встроенные функции (называемые builtins
) не имеют строк документации, часто это происходит потому, что они реализованы на языке программирования Си.Например,
>>> from functools import reduce
>>> reduce(
В этом случае IDLE не будет давать никаких подсказок, потому что у функции нет какой-либо строки документации для отображения.
Отличным компаньоном для обучения является pythonстандартное обозначение .Вы можете найти в встроенных определениях функций четкие объяснения того, что они делают.С другой стороны, при написании своих собственных функций не забывайте помещать строки документов, поскольку они помогут вам в дальнейшем.