`autodoc2.resolve_all`#

Handling of __all__ resolution.

Module Contents#

`AllResolveResult`
`AllResolver`

exception autodoc2.resolve_all.AllResolutionError[source]#

An error occurred while resolving the __all__.

Initialization

Initialize self. See help(type(self)) for accurate signature.

exception autodoc2.resolve_all.ObjectMissingError[source]#

An object in the __all__ is not available in the database.

Initialization

Initialize self. See help(type(self)) for accurate signature.

exception autodoc2.resolve_all.CircularImportError[source]#

A circular import was detected.

Initialization

Initialize self. See help(type(self)) for accurate signature.

exception autodoc2.resolve_all.NoAllError[source]#

The module does not have an __all__.

Initialization

Initialize self. See help(type(self)) for accurate signature.

class autodoc2.resolve_all.AllResolveResult[source]#

resolved: dict[str, str] = None#: Resolved is a dict of {full_name: {name}}

errors: list[tuple[str, str]] = None#: Errors are tuples of (full_name, error_message)

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

Initialization

Initialise the resolver.

Parameters:

get_resolved_all(full_name: str, _breadcrumbs: tuple[str, ...] = ()) → autodoc2.resolve_all.AllResolveResult[source]#

Yield all names that would be imported by star.

Parameters:

get_name(name: str) → str | None[source]#: Get the item, first by trying the fully qualified name, then by looking at __all__ in parent modules.