Обратите внимание, что запуск Python с -OO удаляет строки документации. Если вы намереваетесь распространять свой код среди других, имейте в виду, что они могут выполнять его таким образом. Это действительно сделает тех людей действительно несчастными, если ваш код опирается на строки документации, но не поймает тот случай, когда они не существуют.
Кстати: этот метод работает со встроенными функциями, а также с модулями и классами (test help () также с объектами - также может работать). Это делает вашу оболочку python интерактивной справочной оболочкой!
Дарен Томас
3
В приглашении ipython вы можете сделать my_func ?? и это также покажет строку документации.
Ронак
1
help (func) дает читабельный вывод, а func .__ doc__ - встроенный вывод. Спасибо за ответ.
imsrgadich
77
Вы также можете использовать inspect.getdoc. Он очищает __doc__, нормализуя вкладки до пробелов и сдвигая влево тело документа, чтобы удалить общие пробелы.
Ответы:
Интерактивно вы можете отобразить его с помощью
Или из кода вы можете получить его с
источник
Вы также можете использовать
inspect.getdoc. Он очищает__doc__, нормализуя вкладки до пробелов и сдвигая влево тело документа, чтобы удалить общие пробелы.источник
На ноутбуке ipython или jupyter вы можете использовать все вышеперечисленные способы, но я иду с
или
для быстрого суммирования как сигнатуры метода, так и строки документа.
Я избегаю использования
(как прокомментировал @rohan) для строки документации и используйте ее только для проверки исходного кода
источник