pytools.api.doc.ModuleDefinition

class pytools.api.doc.ModuleDefinition(module)

A reference to a Python module definition.

Bases:

APIDefinition

Metaclasses:

ABCMeta

Parameters:

module (ModuleType) – the module

Method summary

list_documented_parameters

Extract all documented parameter names from the docstring, including "return" if the return parameter is documented.

Attribute summary

docstring	The docstring of this API element; None if the docstring is undefined.
full_name	The full name of this API element, including the full module name and containing element names.
name	The name of this API element.
public_module	The public module that exposes the API definition.
module	the module

Definitions

list_documented_parameters()

Extract all documented parameter names from the docstring, including "return" if the return parameter is documented.

Return type:

Optional[list[str]]

Returns:

list of parameter names

property docstring: str | None

The docstring of this API element; None if the docstring is undefined.

property full_name: str

The full name of this API element, including the full module name and containing element names.

module: ModuleType

the module

property name: str

The name of this API element.

property public_module: str

The public module that exposes the API definition. This may not necessarily be the same as the module in which the element is actually defined.