autodoc2.resolve_all#

Module Contents#

Classes#

AllResolveResult

AllResolver

API#

exception autodoc2.resolve_all.AllResolutionError[source]#

Bases: Exception

Initialization

exception autodoc2.resolve_all.ObjectMissingError[source]#

Bases: autodoc2.resolve_all.AllResolutionError

Initialization

exception autodoc2.resolve_all.CircularImportError[source]#

Bases: autodoc2.resolve_all.AllResolutionError

Initialization

exception autodoc2.resolve_all.NoAllError[source]#

Bases: autodoc2.resolve_all.AllResolutionError

Initialization

class autodoc2.resolve_all.AllResolveResult[source]#

Bases: typing.TypedDict

resolved: dict[str, str] = None#
errors: list[tuple[str, str]] = None#
class autodoc2.resolve_all.AllResolver(db: autodoc2.db.Database, warn_func: Callable[[str], None] | None = None)[source]#

Initialization

clear_cache() → None[source]#
get_resolved_all(full_name: str, _breadcrumbs: tuple[str, ...] = ()) → autodoc2.resolve_all.AllResolveResult[source]#
get_name(name: str) → str | None[source]#