В Python, что делает pydoc?

Ответ 1

Pydoc - это модуль справки/документации для Python.

Используйте это на своем терминале Windows, чтобы понять, что делает функция в python:

python -m pydoc <function>

например.

python -m pydoc raw_input

Если документация для определенной функции очень длинная, используйте "q", чтобы выйти из нее.

например. в случае

python -m pydoc Tkinter

Ответ 2

Это инструмент для создания документации в стиле python, см. http://docs.python.org/2/library/pydoc.html

Вы можете также взглянуть на Сфинкса.

Ответ 3

Pydoc - это система генерации документации для Python. Скажем, вы можете документировать свои функции с использованием стандарта Pydoc, а затем его можно использовать для создания документации в вашем коде.

Ответ 4

Модуль pydoc автоматически создает документацию из модулей Python. Документация может быть представлена ​​в виде страниц текста на консоли, обслуживается веб-браузером или сохраняется в файлах HTML.

Для модулей, классов, функций и методов отображаемая документация выводится из docstring (т.е. атрибута doc) объекта и рекурсивно его документируемых членов. Если docstring отсутствует, pydoc пытается получить описание из блока строк комментариев чуть выше определения класса, функции или метода в исходном файле или в верхней части модуля.

Подробнее о соответствующих версиях Python - Python 2.7 - Python 3.5 - Python 3.6

Ответ 5

Модуль Pydoc в Python может быть использован для создания документации в виде HTML-страниц или даже на консоли

python -m pydoc 

Эта команда предоставляет такие параметры, как просмотр файла pydoc, -k поиск различных библиотек, -p позволяет открыть страницу в веб-браузере для просмотра пакетов Python, -g предоставляет графический интерфейс для просмотра документации, -w пишет вывод HTML. Ниже приведены примеры команд, которые вы можете запустить для тестирования.

python -m pydoc yourpythonfile
python -m pydoc -k ftplib
python -m pydoc -p 314
python -m pydoc -w file

Я создал два примера файлов в каталоге file1.py и file2.py, который имеет простой код с одной строкой комментария.

def f2m(ft):
    """ Return the number of meters eq to feet """
    return 0.30 * ft

Один из способов увидеть комментарий к файлам - просто написать ниже в том же файле, и вы можете запустить python file.py, и он покажет комментарии.

help(f2m)

Другой способ увидеть это - написать команду

python -m pydoc file1

Еще один способ увидеть комментарии на html-странице, набрав эту команду и экспортировав ее в html

python -m pydoc -w <dir>

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

mkdir -p htmldocs
pydoc -w 'find . -name '*.py''
mv *.html htmldocs

Ответ 6

Я, как ученик Python, проще всего описать pydoc - это команда, используемая для изучения различных команд. Синтаксис выглядит так:

> python -m pydoc 'function'

Пример:

> python -m pydoc open

Справка по встроенной функции открыта в модуле встроен:

открытый(...)   открыть (имя [, режим [, буферизация]]) → объект файла

Open a file using the file() type, returns a file object.  This is the
preferred way to open a file.  See file.__doc__ for further information. <<<

Надеюсь, это поможет!

Ответ 7

Краткое описание, предоставленное Wikipedia: "Pydoc позволяет программистам Python обращаться к файлам справки документации Python, создавать текстовые и HTML-страницы с особенностями документации и находить соответствующий модуль для конкретной работы".

Ответ 8

Просто введите pydoc в свой терминал, где вы обычно запускаете python. Это даст простое объяснение! :)

Ответ 9

pydoc генерирует документацию из модулей python в Windows 10, перейдите к приглашению cmd/тип терминала python -m pydoc, например: python -m pydoc sys