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

pydoc – интерактивная справка для модулей

Создает справку по модулям и классам Python из кода.

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

Справка в виде обычного текста

Запуск pydoc в качестве программы командной строки и передача имени модуля создает текст справки для модуля и его содержимого на консоли с помощью программы-пейджера, если она настроена. Например, чтобы увидеть текст справки для модуля 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-справка

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 () в __builtins__ , чтобы та же информация могла быть доступна из командной строки интерпретатора 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.

...

См. также