Рубрики
Без рубрики

Pydoc – онлайн-справка для модулей

Автор оригинала: Doug Hellmann.

Цель:

Генерирует помощь для модулей Python и классов из кода.

Модуль PYDOC импортирует модуль Python и использует содержимое для генерации текста справки во время выполнения. Выход включает в себя DocStrings для любых объектов, которые имеют их, и все классы, методы и функции модуля описаны.

Обычная текстовая помощь

Бег <код> PYDOC как программа командной строки и передача имени модуля производит справочный текст для модуля и его содержимого на консоли, используя программу Pager, если он настроен. Например, чтобы увидеть текст справки для модуля ATexit, запустите PYDOC ATEXIT .

$ pydoc atexit

Help on built-in module atexit:

NAME
    atexit - allow programmer to define multiple exit functions
to be executed upon normal program termination.

DESCRIPTION
    Two public functions, register and unregister, are defined.

FUNCTIONS
    register(...)
        register(func, *args, **kwargs) -> func

        Register a function to be executed upon normal program
termination

            func - function to be called at exit
            args - optional arguments to pass to func
            kwargs - optional keyword arguments to pass to func

            func is returned to facilitate usage as a decorator.

    unregister(...)
        unregister(func) -> None

        Unregister an exit function which was previously
registered using
        atexit.register

            func - function to be unregistered

FILE
    (built-in)

HTML HELP.

PYDOC также генерирует выход HTML, либо записывая статический файл в локальный каталог, либо запускает веб-сервер, чтобы просмотреть документацию в Интернете.

$ pydoc -w atexit

Создает ATEXIT.HTML в текущем каталоге.

$ pydoc -p 5000
Server ready at http://localhost:5000/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

Запускает веб-сервер, прослушивающий в <Код> http://localhost: 5000/. Сервер генерирует документацию на лету, как вы просматриваете. Используйте команду <код> B , чтобы открыть окно браузера автоматически, и <код> q , чтобы остановить сервер.

Интерактивная помощь

PYDOC также добавляет функцию HELP () к ___ Встроенные __ , поэтому та же информация может быть доступна из подсказки переводчика Python.

$ python

Python 3.5.2 (v3.5.2:4def2a2901a5, Jun 26 2016, 10:47:25)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more
information.
>>> help('atexit')
Help on module atexit:

NAME
    atexit - allow programmer to define multiple exit functions
to be executed upon normal program termination.

...

Смотрите также