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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
import sys
import typing as t
from dataclasses import InitVar
from textwrap import dedent
from typing import Any, Literal
import pytest
import typing_extensions as t_e
from typing_inspection.introspection import UNKNOWN, AnnotationSource, ForbiddenQualifier, inspect_annotation
def test_unknown_repr() -> None:
assert str(UNKNOWN) == 'UNKNOWN'
assert repr(UNKNOWN) == '<UNKNOWN>'
_all_qualifiers: list[Any] = [
t_e.ClassVar[int],
t_e.Final[int],
t_e.ReadOnly[int],
t_e.Required[int],
t_e.NotRequired[int],
InitVar[int],
]
@pytest.mark.parametrize(
['source', 'annotations'],
[
(AnnotationSource.ASSIGNMENT_OR_VARIABLE, [t_e.Final[int]]),
(AnnotationSource.CLASS, [t_e.ClassVar[int], t.Final[int]]),
(AnnotationSource.DATACLASS, [t_e.ClassVar[int], t.Final[int], InitVar[int]]),
(AnnotationSource.TYPED_DICT, [t_e.ReadOnly[int], t_e.Required[int], t_e.NotRequired[int]]),
(AnnotationSource.ANY, _all_qualifiers),
],
)
def test_annotation_source_valid_qualifiers(source: AnnotationSource, annotations: list[Any]) -> None:
for annotation in annotations:
assert inspect_annotation(annotation, annotation_source=source).type is int
@pytest.mark.parametrize(
['source', 'annotations'],
[
(
AnnotationSource.ASSIGNMENT_OR_VARIABLE,
[t_e.ClassVar[int], t_e.ReadOnly[int], t_e.Required[int], t_e.NotRequired[int], InitVar[int]],
),
(AnnotationSource.CLASS, [t_e.ReadOnly[int], t_e.Required[int], t_e.NotRequired[int], InitVar[int]]),
(AnnotationSource.DATACLASS, [t_e.ReadOnly[int], t_e.Required[int], t_e.NotRequired[int]]),
(AnnotationSource.TYPED_DICT, [t_e.ClassVar[int], t_e.Final[int], InitVar[int]]),
(AnnotationSource.NAMED_TUPLE, _all_qualifiers),
(AnnotationSource.FUNCTION, _all_qualifiers),
(AnnotationSource.BARE, _all_qualifiers),
],
)
def test_annotation_source_invalid_qualifiers(source: AnnotationSource, annotations: list[Any]) -> None:
for annotation in annotations:
with pytest.raises(ForbiddenQualifier):
inspect_annotation(annotation, annotation_source=source)
@pytest.mark.parametrize(
['qualifier_obj', 'qualifier_str'],
[
(t.Final, 'final'),
(t.ClassVar, 'class_var'),
(InitVar, 'init_var'),
],
)
def test_bare_qualifier(qualifier_obj: Any, qualifier_str: str) -> None:
result = inspect_annotation(
qualifier_obj,
annotation_source=AnnotationSource.ANY,
)
assert result.qualifiers == {qualifier_str}
assert result.type is UNKNOWN
with pytest.raises(ForbiddenQualifier):
inspect_annotation(qualifier_obj, annotation_source=AnnotationSource.BARE)
def test_nested_metadata_and_qualifiers() -> None:
result = inspect_annotation(
t_e.Final[t_e.Annotated[t_e.ClassVar[t_e.Annotated[int, 1]], 2]], # pyright: ignore[reportInvalidTypeForm]
annotation_source=AnnotationSource.ANY,
)
assert result.type is int
assert result.qualifiers == {'class_var', 'final'}
assert result.metadata == [1, 2]
Alias1 = t_e.TypeAliasType('Alias1', int)
Alias2 = t_e.TypeAliasType('Alias2', t_e.Annotated[t_e.ReadOnly[Alias1], 1]) # pyright: ignore[reportInvalidTypeForm]
Alias3 = t_e.TypeAliasType('Alias3', t_e.Annotated[t_e.Required[Alias2], 2]) # pyright: ignore[reportInvalidTypeForm]
@pytest.mark.parametrize(
'unpack_mode',
['eager', 'lenient'],
)
def test_unpack_type_aliases(unpack_mode: Literal['eager', 'lenient']) -> None:
result = inspect_annotation(
t_e.Final[t_e.Annotated[t_e.ClassVar[t_e.Annotated[Alias3, 3]], 4]], # pyright: ignore[reportInvalidTypeForm]
annotation_source=AnnotationSource.ANY,
unpack_type_aliases=unpack_mode,
)
assert result.type is Alias1
assert result.qualifiers == {'read_only', 'required', 'class_var', 'final'}
assert result.metadata == [1, 2, 3, 4]
T = t.TypeVar('T')
FlatList = t_e.TypeAliasType('FlatList', list[T], type_params=(T,))
InnerList = t_e.TypeAliasType('InnerList', t.Annotated[FlatList[T], 1], type_params=(T,))
MyList = t_e.TypeAliasType('MyList', t.Annotated[InnerList[T], 2], type_params=(T,))
MyIntList = t_e.TypeAliasType('MyIntList', MyList[int])
@pytest.mark.parametrize(
'unpack_mode',
['eager', 'lenient'],
)
def test_unpack_type_aliases_generic(unpack_mode: Literal['eager', 'lenient']) -> None:
result = inspect_annotation(
MyIntList,
annotation_source=AnnotationSource.ANY,
unpack_type_aliases=unpack_mode,
)
assert result.type == FlatList[int]
assert result.metadata == [1, 2]
@pytest.mark.skipif(sys.version_info < (3, 12), reason='Requires new `type` statement syntax.')
def test_unpack_type_aliases_undefined_eager_fails(create_module) -> None:
code = dedent("""
from typing import Annotated
type TestType0 = Annotated[Undefined, 1]
type TestType1 = Annotated[TestType0, 2]
type TestType2[T] = Undefined
type TestType3 = Annotated[TestType2[int], 2]
""")
module = create_module(code)
with pytest.raises(NameError) as exc_info:
inspect_annotation(
module.TestType1,
annotation_source=AnnotationSource.ANY,
unpack_type_aliases='eager',
)
assert exc_info.value.name == 'Undefined'
with pytest.raises(NameError) as exc_info:
inspect_annotation(
module.TestType3,
annotation_source=AnnotationSource.ANY,
unpack_type_aliases='eager',
)
assert exc_info.value.name == 'Undefined'
@pytest.mark.skipif(sys.version_info < (3, 12), reason='Requires new `type` statement syntax.')
def test_unpack_type_aliases_undefined_lenient(create_module) -> None:
code = dedent("""
from typing import Annotated
type TestType0 = Annotated[Undefined, 1]
type TestType1 = Annotated[TestType0, 2]
type TestType2[T] = Undefined
type TestType3 = Annotated[TestType2[int], 2]
""")
module = create_module(code)
result_1 = inspect_annotation(
t.Annotated[t.Final[module.TestType1], 3],
annotation_source=AnnotationSource.ANY,
unpack_type_aliases='lenient',
)
assert result_1.type is module.TestType0
assert result_1.qualifiers == {'final'}
assert result_1.metadata == [2, 3]
result_2 = inspect_annotation(
t.Annotated[t.Final[module.TestType3], 3],
annotation_source=AnnotationSource.ANY,
unpack_type_aliases='lenient',
)
assert t_e.get_origin(result_2.type) is module.TestType2
assert t_e.get_args(result_2.type)[0] is int
assert result_2.qualifiers == {'final'}
assert result_2.metadata == [2, 3]
|
