pydoc – Генератор документации и интерактивная справочная система¶pydoc – Documentation generator and online help system
Модуль pydoc автоматически создаёт документацию из модулей Python. Документация может быть отображена в виде текстовых страниц на консоли, передана веб-браузеру или сохранена в HTML-файлы.
Встроенная функция help() вызывает справочную систему в интерактивном интерпретаторе, которая использует pydoc для создания своей документации в виде текста на консоли. Эту же текстовую документацию можно просмотреть и за пределами интерпретатора Python, запустив pydoc как скрипт из командной строки операционной системы. Например, выполнение
pydoc sys
в командной строке отобразит документацию по модулю sys в стиле, напоминающем страницы руководства Unix-команды man. Аргументом pydoc может быть имя функции, модуля или пакета, а также точечная ссылка на класс, метод или функцию внутри модуля или пакета. Если аргумент pydoc выглядит как путь (то есть содержит разделитель пути для вашей операционной системы, например, косую черту в Unix) и указывает на существующий файл исходного кода Python, то документация создаётся для этого файла.
Примечание
Чтобы найти объекты и их документацию, pydoc импортирует документируемый модуль (модули). Поэтому любой код на уровне модуля будет выполнен в этот момент. Используйте защиту if __name__ == '__main__':, чтобы код выполнялся только при запуске файла как скрипта, а не при импорте.
Указание флага -w перед аргументом приведёт к записи HTML-документации в файл в текущей директории, вместо вывода текста на консоль.
Указание флага -k перед аргументом приведёт к поиску по строкам синопсиса всех доступных модулей для ключевого слова, переданного в качестве аргумента, снова в манере, подобной команде Unix man. Строка синопсиса модуля – это первая строка его строки документации.
Вы также можете использовать pydoc для запуска HTTP-сервера на локальной машине, который будет предоставлять документацию для посещающих веб-браузеров. pydoc -p 1234 запустит HTTP-сервер на порту 1234, позволяя вам просматривать документацию по адресу http://localhost:1234/ в предпочитаемом вами веб-браузере. pydoc -g запустит сервер и дополнительно откроет небольшой графический интерфейс на основе Tkinter, чтобы помочь вам искать страницы документации.
Когда pydoc генерирует документацию, он использует текущее окружение и путь для поиска модулей. Таким образом, вызов pydoc spam документирует именно ту версию модуля, которую вы получили бы, если бы запустили интерпретатор Python и ввели import spam.
Документация основных модулей предполагается находящейся по адресу http://docs.python.org/library/. Это можно изменить, установив переменную окружения PYTHONDOCS на другой URL или локальную директорию, содержащую страницы справочного руководства по библиотеке.