Как просмотреть только документ документа с pydoc

Question

Как просмотреть только документ документа с pydoc

1

Будучи разработчиком perl, я знаю утилиту perldoc. Я новичок в python, и я искал то же самое и нашел pydoc. Но проблема с pydoc заключается в том, что он также выполняет мой скрипт, в то время как я хочу видеть только документ, написанный внутри тройных кавычек. Любая помощь будет оценена по достоинству.

krish___na 20 авг. 2018, в 08:48

Источник

Теги:

python

perl

pydoc

perldoc

1 ответ

Ещё вопросы

Hoenie · Accepted Answer · 2018-08-20T04-23-00.000Z

Вероятно, лучший способ - работать в Python (вместо командной строки). В качестве примера возьмем модуль sys. Сначала импортируйте свой модуль, а затем используйте help(), например:

import sys
help(sys)

Если вы хотите увидеть docstrings:

print(sys.__doc__)

Для модулей, которые вы разрабатываете самостоятельно, вы можете создать защитную оболочку, чтобы модуль не выполнялся, как описано в документации:

Примечание. Чтобы найти объекты и их документацию, pydoc импортирует модули (модули) для документирования. Поэтому в этом случае будет выполнен любой код на уровне модуля. Используйте if __name__ == '__main__': guard только для выполнения кода, когда файл вызывается как скрипт, а не только импортируется.

Сценарий мой сценарий ожидает некоторые аргументы командной строки. Когда я использую то, что вы предложили, или pydoc, он запрашивает эти аргументы. В идеале он должен отображать только строки документа.
Хорошо, я вижу, я обновил свой ответ. Это работает?
Это сработало @Honie. Хотя мне пришлось собирать весь код в этом блоке IF. Благодарю.