pydoc — Documentation generator and online help system

Вихідний код: Lib/pydoc.py

The pydoc module automatically generates documentation from Python modules. The documentation can be presented as pages of text on the console, served to a web browser, or saved to HTML files.

For modules, classes, functions and methods, the displayed documentation is derived from the docstring (i.e. the __doc__ attribute) of the object, and recursively of its documentable members. If there is no docstring, pydoc tries to obtain a description from the block of comment lines just above the definition of the class, function or method in the source file, or at the top of the module (see inspect.getcomments()).

The built-in function help() invokes the online help system in the interactive interpreter, which uses pydoc to generate its documentation as text on the console. The same text documentation can also be viewed from outside the Python interpreter by running pydoc as a script at the operating system’s command prompt. For example, running

python -m pydoc sys

у підказці оболонки відобразить документацію щодо модуля sys у стилі, подібному до сторінок посібника, показаних командою Unix man. Аргументом pydoc може бути назва функції, модуля чи пакета, або посилання з крапками на клас, метод або функцію в межах модуля чи модуля в пакеті. Якщо аргумент pydoc виглядає як шлях (тобто він містить роздільник шляхів для вашої операційної системи, наприклад косу риску в Unix), і посилається на існуючий вихідний файл Python, тоді створюється документація для цей файл.

Примітка

In order to find objects and their documentation, pydoc imports the module(s) to be documented. Therefore, any code on module level will be executed on that occasion. Use an if __name__ == '__main__': guard to only execute code when a file is invoked as a script and not just imported.

Під час друку виведення на консоль pydoc намагається розбити вивід на сторінки для легшого читання. Якщо встановлено змінну середовища PAGER, pydoc використовуватиме її значення як програму розбиття на сторінки.

Якщо вказати прапорець -w перед аргументом, документація HTML буде записана у файл у поточному каталозі замість відображення тексту на консолі.

Якщо вказати прапорець -k перед аргументом, буде здійснюватися пошук ключових слів, указаних як аргумент, у рядках короткого опису всіх доступних модулів, знову ж таки, як у команді Unix man. Рядок короткого опису модуля є першим рядком рядка документації.

You can also use pydoc to start an HTTP server on the local machine that will serve documentation to visiting web browsers. python -m pydoc -p 1234 will start a HTTP server on port 1234, allowing you to browse the documentation at http://localhost:1234/ in your preferred web browser. Specifying 0 as the port number will select an arbitrary unused port.

python -m pydoc -n <hostname> will start the server listening at the given hostname. By default the hostname is „localhost“ but if you want the server to be reached from other machines, you may want to change the host name that the server responds to. During development this is especially useful if you want to run pydoc from within a container.

python -m pydoc -b will start the server and additionally open a web browser to a module index page. Each served page has a navigation bar at the top where you can Get help on an individual item, Search all modules with a keyword in their synopsis line, and go to the Module index, Topics and Keywords pages.

Коли pydoc створює документацію, вона використовує поточне середовище та шлях для пошуку модулів. Таким чином, виклик pydoc spam документує саме ту версію модуля, яку ви отримаєте, якщо запустите інтерпретатор Python і введете import spam.

Module docs for core modules are assumed to reside in https://docs.python.org/X.Y/library/ where X and Y are the major and minor version numbers of the Python interpreter. This can be overridden by setting the PYTHONDOCS environment variable to a different URL or to a local directory containing the Library Reference Manual pages.

Змінено в версії 3.2: Додано опцію -b.

Змінено в версії 3.3: Параметр командного рядка -g видалено.

Змінено в версії 3.4: pydoc now uses inspect.signature() rather than inspect.getfullargspec() to extract signature information from callables.

Змінено в версії 3.7: Додано опцію -n.