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
|
# stdlib
from typing import Any, Dict, List, NamedTuple, Sequence, Type, Union, no_type_check # noqa: F401
# 3rd party
from coincidence import PEP_563
from domdf_python_tools.secrets import Secret
from sphinx.ext.autodoc.directive import AutodocDirective
# this package
from sphinx_toolbox import __version__
from sphinx_toolbox.more_autodoc import variables
from sphinx_toolbox.more_autodoc.variables import get_variable_type
from sphinx_toolbox.testing import run_setup
class Foo:
a: str
b: int
c: float
d: "float"
e: "List"
class Bar:
a: str
b: int
c: float
d: "float"
e: "List"
f: "Set" # type: ignore[name-defined]
def __init__(self):
self.g: Secret = Secret('')
self.h: "Secret" = Secret('')
class Analyzer(NamedTuple):
annotations: Dict[Sequence[str], Any]
class Documenter(NamedTuple):
parent: Type
objpath: List[str]
analyzer: Analyzer
@no_type_check
def test_get_variable_type():
assert get_variable_type(Documenter(Foo, ["Foo", 'a'], Analyzer({}))) == ":py:class:`str`"
assert get_variable_type(Documenter(Foo, ["Foo", 'b'], Analyzer({}))) == ":py:class:`int`"
assert get_variable_type(Documenter(Foo, ["Foo", 'c'], Analyzer({}))) == ":py:class:`float`"
assert get_variable_type(Documenter(Foo, ["Foo", 'd'], Analyzer({}))) == ":py:class:`float`"
assert get_variable_type(Documenter(Foo, ["Foo", 'e'], Analyzer({}))) == ":py:class:`~typing.List`"
if PEP_563:
# On 3.10 with PEP 563 failed forward references break things earlier
assert get_variable_type(Documenter(Bar, ["Bar", 'a'], Analyzer({}))) == ":py:obj:`~.str`"
assert get_variable_type(Documenter(Bar, ["Bar", 'b'], Analyzer({}))) == ":py:obj:`~.int`"
assert get_variable_type(Documenter(Bar, ["Bar", 'c'], Analyzer({}))) == ":py:obj:`~.float`"
else:
assert get_variable_type(Documenter(Bar, ["Bar", 'a'], Analyzer({}))) == ":py:class:`str`"
assert get_variable_type(Documenter(Bar, ["Bar", 'b'], Analyzer({}))) == ":py:class:`int`"
assert get_variable_type(Documenter(Bar, ["Bar", 'c'], Analyzer({}))) == ":py:class:`float`"
# Failed forward reference throws everything else out of whack
assert get_variable_type(Documenter(Bar, ["Bar", 'd'], Analyzer({}))) == ":py:obj:`~.float`"
assert get_variable_type(Documenter(Bar, ["Bar", 'e'], Analyzer({}))) == ":py:obj:`~.List`"
assert get_variable_type(Documenter(Bar, ["Bar", 'f'], Analyzer({}))) == ":py:obj:`~.Set`"
assert get_variable_type(Documenter(Bar, ["Bar", 'g'], Analyzer({}))) == ''
# assert get_variable_type(Documenter(Bar, ["Bar", "g"], Analyzer({("Bar", "g"): "Secret"}))) == ":py:class:`~domdf_python_tools.secrets.Secret`"
assert get_variable_type(
Documenter(Bar, ["Bar", 'h'], Analyzer({("Bar", 'h'): "'Secret'"}))
) == ":py:class:`~domdf_python_tools.secrets.Secret`"
assert get_variable_type(
Documenter(Bar, ["Bar", 'h'], Analyzer({("Bar", 'h'): '"Secret"'}))
) == ":py:class:`~domdf_python_tools.secrets.Secret`"
assert get_variable_type(
Documenter(Bar, ["Bar", 'h'], Analyzer({("Bar", 'h'): "Union[str, float, int]"}))
) == ":py:data:`~typing.Union`\\[:py:class:`str`, :py:class:`float`, :py:class:`int`]"
assert get_variable_type(
Documenter(Bar, ["Bar", 'h'], Analyzer({("Bar", 'h'): "'Union[str, float, int]'"}))
) == ":py:data:`~typing.Union`\\[:py:class:`str`, :py:class:`float`, :py:class:`int`]"
assert get_variable_type(
Documenter(Bar, ["Bar", 'h'], Analyzer({("Bar", 'h'): '"Union[str, float, int]"'}))
) == ":py:data:`~typing.Union`\\[:py:class:`str`, :py:class:`float`, :py:class:`int`]"
assert get_variable_type(Documenter("Bar", ["Bar", 'f'], Analyzer({}))) == ''
def test_setup():
setup_ret, directives, roles, additional_nodes, app = run_setup(variables.setup)
assert setup_ret == {"parallel_read_safe": True, "version": __version__}
assert directives == {
"autovariable": AutodocDirective,
"autoattribute": AutodocDirective,
"autoinstanceattribute": AutodocDirective,
"autoslotsattribute": AutodocDirective,
"autoproperty": AutodocDirective,
}
assert roles == {}
assert additional_nodes == set()
assert app.registry.documenters["variable"] == variables.VariableDocumenter
assert app.registry.documenters["attribute"] == variables.TypedAttributeDocumenter
assert app.registry.documenters["instanceattribute"] == variables.InstanceAttributeDocumenter
assert app.registry.documenters["slotsattribute"] == variables.SlotsAttributeDocumenter
assert app.registry.documenters["property"] == variables.PropertyDocumenter
|
