autodoc2.db

Module Contents

Classes

Data

API

exception autodoc2.db.UniqueError[source]

Bases: KeyError

Initialization

class autodoc2.db.Database[source]

Bases: typing.Protocol

add(item: autodoc2.utils.ItemData) None[source]
remove(full_name: str, descendants: bool) None[source]
__contains__(full_name: str) bool[source]
get_item(full_name: str) autodoc2.utils.ItemData | None[source]
get_items_like(full_name: str) Iterable[autodoc2.utils.ItemData][source]
get_type(full_name: str) None | str[source]
get_by_type(type_: str) Iterable[autodoc2.utils.ItemData][source]
get_overloads(full_name: str) Iterable[autodoc2.utils.ItemData][source]
get_children(full_name: str, types: None | set[str] = None, *, sort_name: bool = False) Iterable[autodoc2.utils.ItemData][source]
get_children_names(full_name: str, types: None | set[str] = None, *, sort_name: bool = False) Iterable[str][source]
get_ancestors(full_name: str, include_self: bool) Iterable[autodoc2.utils.ItemData | None][source]
autodoc2.db._LIKE_REGEX

None

class autodoc2.db.InMemoryDb[source]

Bases: autodoc2.db.Database

Initialization

add(item: autodoc2.utils.ItemData) None[source]
remove(full_name: str, descendants: bool) None[source]
__contains__(full_name: str) bool[source]
get_item(full_name: str) autodoc2.utils.ItemData | None[source]
get_items_like(full_name: str) Iterable[autodoc2.utils.ItemData][source]
get_type(full_name: str) None | str[source]
get_by_type(type_: str) Iterable[autodoc2.utils.ItemData][source]
get_overloads(full_name: str) Iterable[autodoc2.utils.ItemData][source]
get_children(full_name: str, types: None | set[str] = None, *, sort_name: bool = False) Iterable[autodoc2.utils.ItemData][source]
get_children_names(full_name: str, types: None | set[str] = None, *, sort_name: bool = False) Iterable[str][source]
get_ancestors(full_name: str, include_self: bool) Iterable[autodoc2.utils.ItemData | None][source]
write(stream: TextIO) None[source]
classmethod read(stream: TextIO) autodoc2.db.InMemoryDb[source]