autodoc2.analysis#

Module Contents#

Classes#

State

Functions#

analyse_module

_get_full_name

_get_parent_name

fix_docstring_indent

walk_node

yield_module

yield_annotation_assign

yield_assign

_yield_assign

yield_function_def

yield_class_def

Data#

__all__

_dc_kwargs

_FUNC_MAPPER

API#

autodoc2.analysis.__all__ = ['analyse_module']#
autodoc2.analysis.analyse_module(file_path: pathlib.Path, name: str, exclude_external_imports: Pattern[str] | None = None) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis._dc_kwargs: dict[str, bool] = None#
class autodoc2.analysis.State[source]#
package_name: str = None#
name_stack: list[str] = None#
exclude_external_imports: Pattern[str] | None = None#
copy(**kwargs: Any) → autodoc2.analysis.State[source]#
autodoc2.analysis._get_full_name(name: str, name_stack: list[str]) → str[source]#
autodoc2.analysis._get_parent_name(name: str) → str[source]#
autodoc2.analysis.fix_docstring_indent(s: None | str, tabsize: int = 8) → str[source]#
autodoc2.analysis.walk_node(node: astroid.nodes.NodeNG, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis.yield_module(node: astroid.nodes.Module, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis.yield_annotation_assign(node: astroid.nodes.AnnAssign, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis.yield_assign(node: astroid.nodes.Assign, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis._yield_assign(node: astroid.nodes.Assign | astroid.nodes.AnnAssign, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis.yield_function_def(node: astroid.nodes.FunctionDef | astroid.nodes.AsyncFunctionDef, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis.yield_class_def(node: astroid.nodes.ClassDef, state: autodoc2.analysis.State) → Iterable[autodoc2.utils.ItemData][source]#
autodoc2.analysis._FUNC_MAPPER: dict[astroid.nodes.NodeNG, Callable[[astroid.nodes.NodeNG, autodoc2.analysis.State], Iterable[autodoc2.utils.ItemData]]] = None#