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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
import sys
from collections.abc import Callable, Iterable, Mapping, Sequence
from types import UnionType
from typing import Any, NamedTuple, TypeVar, Union, get_args, get_origin
if (3, 9) <= sys.version_info[:2] <= (3, 10):
# Backport this fix for python 3.9 and 3.10
# https://github.com/python/cpython/pull/30900
from types import GenericAlias
from typing import ForwardRef
from typing import _eval_type as __eval_type # type: ignore
def _eval_type(tp: Any, globalns: Any, localns: Any) -> Any:
if isinstance(tp, GenericAlias):
args = tuple(
ForwardRef(arg) if isinstance(arg, str) else arg for arg in tp.__args__
)
tp = tp.__origin__[args] # type: ignore
return __eval_type(tp, globalns, localns)
elif sys.version_info[:2] >= (3, 13):
# python 3.13+ requires type_params argument
from typing import _eval_type as __eval_type # type: ignore
def _eval_type(tp: Any, globalns: Any, localns: Any) -> Any:
return __eval_type(tp, globalns, localns, type_params=())
else:
from typing import _eval_type # type: ignore
NONE_TYPE = type(None)
UNION_TYPES = (Union, UnionType)
ITERABLE_TYPES = (list, tuple, Iterable, Sequence)
LIST_CONTAINERS = (Iterable, Sequence)
def evaluate(tp: Any, globalns: Any, localns: Any = None) -> Any:
"""Analyze/Validate the typing annotation."""
result = _eval_type(tp, globalns, localns)
# Ugly hack for the Type["str"]
# Let's switch to ForwardRef("str")
if get_origin(result) is type:
args = get_args(result)
if len(args) != 1:
raise TypeError
return args[0]
return result
class Result(NamedTuple):
"""Analyze Result Object."""
types: tuple[type[Any], ...]
factory: Callable | None = None
tokens_factory: Callable | None = None
optional: bool = False
def analyze_token_args(origin: Any, args: tuple[Any, ...]) -> tuple[Any]:
"""Analyze token arguments.
Ensure it only has one argument, filter out ellipsis.
Args:
origin: The annotation origin
args: The annotation arguments
Returns:
A tuple that contains only one arg
Raises:
TypeError: If the origin is not list or tuple,
and it has more than one argument
"""
if origin in ITERABLE_TYPES:
args = filter_ellipsis(args)
if len(args) == 1:
return args
raise TypeError
def analyze_optional_origin(
origin: Any, args: tuple[Any, ...], types: tuple[Any, ...]
) -> tuple[Any, ...]:
"""Analyze optional type annotations.
Remove the NoneType, adjust and return the origin, args and types.
Args:
origin: The annotation origin
args: The annotation arguments
types: The annotation types
Returns:
The old or new origin args and types.
"""
if origin in UNION_TYPES:
new_args = filter_none_type(args)
if len(new_args) == 1:
return get_origin(new_args[0]), get_args(new_args[0]), new_args
return origin, args, types
def filter_none_type(args: tuple[Any, ...]) -> tuple[Any, ...]:
"""Filter out none types from args."""
return tuple(arg for arg in args if arg is not NONE_TYPE)
def filter_ellipsis(args: tuple[Any, ...]) -> tuple[Any]:
"""Filter out ellipsis from args."""
return tuple(arg for arg in args if arg is not Ellipsis)
def evaluate_text(annotation: Any, tokens: bool = False) -> Result:
"""Run exactly the same validations with attribute."""
return evaluate_attribute(annotation, tokens)
def evaluate_attribute(annotation: Any, tokens: bool = False) -> Result:
"""Validate annotations for an XML attribute."""
types = (annotation,)
origin = get_origin(annotation)
args = get_args(annotation)
tokens_factory = None
if origin in UNION_TYPES:
optional = NONE_TYPE in args
else:
optional = False
if tokens:
origin, args, types = analyze_optional_origin(origin, args, types)
args = analyze_token_args(origin, args)
tokens_factory = origin
if tokens_factory in LIST_CONTAINERS:
tokens_factory = list
origin = get_origin(args[0])
if origin in UNION_TYPES:
args = get_args(args[0])
elif origin:
raise TypeError
if origin in UNION_TYPES:
types = filter_none_type(args)
elif origin is None:
types = args or (annotation,)
else:
raise TypeError
if any(get_origin(tp) for tp in types):
raise TypeError
return Result(types=types, tokens_factory=tokens_factory, optional=optional)
def evaluate_attributes(annotation: Any, **_: Any) -> Result:
"""Validate annotations for XML wildcard attributes."""
if annotation is dict:
args = ()
else:
origin = get_origin(annotation)
args = get_args(annotation)
if origin is not dict and origin is not Mapping:
raise TypeError
if args and not all(arg is str for arg in args):
raise TypeError
# Attributes always have optional=False (nothing else is supported)
return Result(types=(str,), factory=dict, optional=False)
def evaluate_element(annotation: Any, tokens: bool = False) -> Result:
"""Validate annotations for an XML element."""
# Only the derived element value field is allowed a typevar
if isinstance(annotation, TypeVar) and annotation.__bound__ is object:
annotation = object
types = (annotation,)
origin = get_origin(annotation)
args = get_args(annotation)
tokens_factory = factory = None
# Compute optional status from original annotation before any processing
if origin in UNION_TYPES:
optional = NONE_TYPE in args
else:
optional = False
origin, args, types = analyze_optional_origin(origin, args, types)
if tokens:
args = analyze_token_args(origin, args)
tokens_factory = origin
origin = get_origin(args[0])
types = args
args = get_args(args[0])
if origin in ITERABLE_TYPES:
args = tuple(arg for arg in args if arg is not Ellipsis)
if len(args) != 1:
raise TypeError
if tokens_factory:
factory = tokens_factory
tokens_factory = origin
else:
factory = origin
types = args
origin = get_origin(args[0])
args = get_args(args[0])
if origin in UNION_TYPES:
types = filter_none_type(args)
elif origin:
raise TypeError
if factory in LIST_CONTAINERS:
factory = list
if tokens_factory in LIST_CONTAINERS:
tokens_factory = list
return Result(
types=types,
factory=factory,
tokens_factory=tokens_factory,
optional=optional,
)
def evaluate_elements(annotation: Any, **_: Any) -> Result:
"""Validate annotations for an XML compound field."""
result = evaluate_element(annotation, tokens=False)
for tp in result.types:
evaluate_element(tp, tokens=False)
return Result(types=(object,), factory=result.factory, optional=result.optional)
def evaluate_wildcard(annotation: Any, **_: Any) -> Result:
"""Validate annotations for an XML wildcard."""
origin = get_origin(annotation)
factory = None
# Compute optional status from original annotation
if origin in UNION_TYPES:
args = get_args(annotation)
optional = NONE_TYPE in args
else:
optional = False
if origin in UNION_TYPES:
types = filter_none_type(args)
elif origin in ITERABLE_TYPES:
factory = list if origin in LIST_CONTAINERS else origin
types = filter_ellipsis(get_args(annotation))
elif origin is None:
types = (annotation,)
else:
raise TypeError
if len(types) != 1 or object not in types:
raise TypeError
return Result(types=types, factory=factory, optional=optional)
|
