1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
:py:mod:`autodoc2.resolve_all`
==============================
.. py:module:: autodoc2.resolve_all
.. autodoc2-docstring:: autodoc2.resolve_all
:allowtitles:
Module Contents
---------------
Classes
~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`AllResolveResult <autodoc2.resolve_all.AllResolveResult>`
-
* - :py:obj:`AllResolver <autodoc2.resolve_all.AllResolver>`
- .. autodoc2-docstring:: autodoc2.resolve_all.AllResolver
:summary:
API
~~~
.. py:exception:: AllResolutionError()
:canonical: autodoc2.resolve_all.AllResolutionError
Bases: :py:obj:`Exception`
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolutionError
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolutionError.__init__
.. py:exception:: ObjectMissingError()
:canonical: autodoc2.resolve_all.ObjectMissingError
Bases: :py:obj:`autodoc2.resolve_all.AllResolutionError`
.. autodoc2-docstring:: autodoc2.resolve_all.ObjectMissingError
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.resolve_all.ObjectMissingError.__init__
.. py:exception:: CircularImportError()
:canonical: autodoc2.resolve_all.CircularImportError
Bases: :py:obj:`autodoc2.resolve_all.AllResolutionError`
.. autodoc2-docstring:: autodoc2.resolve_all.CircularImportError
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.resolve_all.CircularImportError.__init__
.. py:exception:: NoAllError()
:canonical: autodoc2.resolve_all.NoAllError
Bases: :py:obj:`autodoc2.resolve_all.AllResolutionError`
.. autodoc2-docstring:: autodoc2.resolve_all.NoAllError
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.resolve_all.NoAllError.__init__
.. py:class:: AllResolveResult()
:canonical: autodoc2.resolve_all.AllResolveResult
Bases: :py:obj:`typing.TypedDict`
.. py:attribute:: resolved
:canonical: autodoc2.resolve_all.AllResolveResult.resolved
:type: dict[str, str]
:value: None
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolveResult.resolved
.. py:attribute:: errors
:canonical: autodoc2.resolve_all.AllResolveResult.errors
:type: list[tuple[str, str]]
:value: None
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolveResult.errors
.. py:class:: AllResolver(db: autodoc2.db.Database, warn_func: typing.Callable[[str], None] | None = None)
:canonical: autodoc2.resolve_all.AllResolver
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolver
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolver.__init__
.. py:method:: clear_cache() -> None
:canonical: autodoc2.resolve_all.AllResolver.clear_cache
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolver.clear_cache
.. py:method:: get_resolved_all(full_name: str, _breadcrumbs: tuple[str, ...] = ()) -> autodoc2.resolve_all.AllResolveResult
:canonical: autodoc2.resolve_all.AllResolver.get_resolved_all
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolver.get_resolved_all
.. py:method:: get_name(name: str) -> str | None
:canonical: autodoc2.resolve_all.AllResolver.get_name
.. autodoc2-docstring:: autodoc2.resolve_all.AllResolver.get_name
|
