-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
test_utils.py
501 lines (388 loc) · 14.2 KB
/
test_utils.py
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
import collections.abc
import os
import re
import string
import sys
from copy import copy, deepcopy
from distutils.version import StrictVersion
from enum import Enum
from typing import Callable, Dict, List, NewType, Tuple, TypeVar, Union
import pytest
from typing_extensions import Annotated, Literal
from pydantic import VERSION, BaseModel, ConstrainedList, conlist
from pydantic.color import Color
from pydantic.dataclasses import dataclass
from pydantic.fields import Undefined
from pydantic.typing import (
ForwardRef,
all_literal_values,
display_as_type,
get_args,
get_origin,
is_new_type,
new_type_supertype,
resolve_annotations,
)
from pydantic.utils import (
BUILTIN_COLLECTIONS,
ClassAttribute,
ValueItems,
all_identical,
deep_update,
get_model,
import_string,
lenient_issubclass,
path_type,
smart_deepcopy,
truncate,
unique_list,
)
from pydantic.version import version_info
try:
import devtools
except ImportError:
devtools = None
def test_import_module():
assert import_string('os.path') == os.path
def test_import_module_invalid():
with pytest.raises(ImportError) as exc_info:
import_string('xx')
assert exc_info.value.args[0] == '"xx" doesn\'t look like a module path'
def test_import_no_attr():
with pytest.raises(ImportError) as exc_info:
import_string('os.foobar')
assert exc_info.value.args[0] == 'Module "os" does not define a "foobar" attribute'
@pytest.mark.parametrize(
'value,expected', ((str, 'str'), ('string', 'str'), (Union[str, int], 'Union[str, int]'), (list, 'list'))
)
def test_display_as_type(value, expected):
assert display_as_type(value) == expected
@pytest.mark.skipif(sys.version_info < (3, 9), reason='generic aliases are not available in python < 3.9')
def test_display_as_type_generic_alias():
assert display_as_type(list[[Union[str, int]]]) == 'list[[Union[str, int]]]'
def test_display_as_type_enum():
class SubField(Enum):
a = 1
b = 'b'
displayed = display_as_type(SubField)
assert displayed == 'enum'
def test_display_as_type_enum_int():
class SubField(int, Enum):
a = 1
b = 2
displayed = display_as_type(SubField)
assert displayed == 'int'
def test_display_as_type_enum_str():
class SubField(str, Enum):
a = 'a'
b = 'b'
displayed = display_as_type(SubField)
assert displayed == 'str'
def test_lenient_issubclass():
class A(str):
pass
assert lenient_issubclass(A, str) is True
@pytest.mark.skipif(sys.version_info < (3, 9), reason='generic aliases are not available in python < 3.9')
def test_lenient_issubclass_with_generic_aliases():
from collections.abc import Mapping
# should not raise an error here:
assert lenient_issubclass(list[str], Mapping) is False
def test_lenient_issubclass_is_lenient():
assert lenient_issubclass('a', 'a') is False
@pytest.mark.parametrize(
'input_value,output',
[
(object, "<class 'object'>"),
(string.ascii_lowercase, "'abcdefghijklmnopq…'"),
(list(range(20)), '[0, 1, 2, 3, 4, 5, …'),
],
)
def test_truncate(input_value, output):
with pytest.warns(DeprecationWarning, match='`truncate` is no-longer used by pydantic and is deprecated'):
assert truncate(input_value, max_len=20) == output
@pytest.mark.parametrize(
'input_value,output',
[
([], []),
([1, 1, 1, 2, 1, 2, 3, 2, 3, 1, 4, 2, 3, 1], [1, 2, 3, 4]),
(['a', 'a', 'b', 'a', 'b', 'c', 'b', 'c', 'a'], ['a', 'b', 'c']),
],
)
def test_unique_list(input_value, output):
assert unique_list(input_value) == output
assert unique_list(unique_list(input_value)) == unique_list(input_value)
def test_value_items():
v = ['a', 'b', 'c']
vi = ValueItems(v, {0, -1})
assert vi.is_excluded(2)
assert [v_ for i, v_ in enumerate(v) if not vi.is_excluded(i)] == ['b']
assert vi.is_included(2)
assert [v_ for i, v_ in enumerate(v) if vi.is_included(i)] == ['a', 'c']
v2 = {'a': v, 'b': {'a': 1, 'b': (1, 2)}, 'c': 1}
vi = ValueItems(v2, {'a': {0, -1}, 'b': {'a': ..., 'b': -1}})
assert not vi.is_excluded('a')
assert vi.is_included('a')
assert not vi.is_excluded('c')
assert not vi.is_included('c')
assert str(vi) == "{'a': {0, -1}, 'b': {'a': Ellipsis, 'b': -1}}"
assert repr(vi) == "ValueItems({'a': {0, -1}, 'b': {'a': Ellipsis, 'b': -1}})"
excluded = {k_: v_ for k_, v_ in v2.items() if not vi.is_excluded(k_)}
assert excluded == {'a': v, 'b': {'a': 1, 'b': (1, 2)}, 'c': 1}
included = {k_: v_ for k_, v_ in v2.items() if vi.is_included(k_)}
assert included == {'a': v, 'b': {'a': 1, 'b': (1, 2)}}
sub_v = included['a']
sub_vi = ValueItems(sub_v, vi.for_element('a'))
assert repr(sub_vi) == 'ValueItems({0, 2})'
assert sub_vi.is_excluded(2)
assert [v_ for i, v_ in enumerate(sub_v) if not sub_vi.is_excluded(i)] == ['b']
assert sub_vi.is_included(2)
assert [v_ for i, v_ in enumerate(sub_v) if sub_vi.is_included(i)] == ['a', 'c']
def test_value_items_error():
with pytest.raises(TypeError) as e:
ValueItems(1, (1, 2, 3))
assert str(e.value) == "Unexpected type of exclude value <class 'tuple'>"
def test_is_new_type():
new_type = NewType('new_type', str)
new_new_type = NewType('new_new_type', new_type)
assert is_new_type(new_type)
assert is_new_type(new_new_type)
assert not is_new_type(str)
def test_new_type_supertype():
new_type = NewType('new_type', str)
new_new_type = NewType('new_new_type', new_type)
assert new_type_supertype(new_type) == str
assert new_type_supertype(new_new_type) == str
def test_pretty():
class MyTestModel(BaseModel):
a = 1
b = [1, 2, 3]
m = MyTestModel()
assert m.__repr_name__() == 'MyTestModel'
assert str(m) == 'a=1 b=[1, 2, 3]'
assert repr(m) == 'MyTestModel(a=1, b=[1, 2, 3])'
assert list(m.__pretty__(lambda x: f'fmt: {x!r}')) == [
'MyTestModel(',
1,
'a=',
'fmt: 1',
',',
0,
'b=',
'fmt: [1, 2, 3]',
',',
0,
-1,
')',
]
def test_pretty_color():
c = Color('red')
assert str(c) == 'red'
assert repr(c) == "Color('red', rgb=(255, 0, 0))"
assert list(c.__pretty__(lambda x: f'fmt: {x!r}')) == [
'Color(',
1,
"fmt: 'red'",
',',
0,
'rgb=',
'fmt: (255, 0, 0)',
',',
0,
-1,
')',
]
@pytest.mark.skipif(not devtools, reason='devtools not installed')
def test_devtools_output():
class MyTestModel(BaseModel):
a = 1
b = [1, 2, 3]
assert devtools.pformat(MyTestModel()) == 'MyTestModel(\n a=1,\n b=[1, 2, 3],\n)'
@pytest.mark.skipif(not devtools, reason='devtools not installed')
def test_devtools_output_validation_error():
class Model(BaseModel):
a: int
with pytest.raises(ValueError) as exc_info:
Model()
assert devtools.pformat(exc_info.value) == (
'ValidationError(\n'
" model='Model',\n"
' errors=[\n'
' {\n'
" 'loc': ('a',),\n"
" 'msg': 'field required',\n"
" 'type': 'value_error.missing',\n"
' },\n'
' ],\n'
')'
)
@pytest.mark.parametrize(
'mapping, updating_mapping, expected_mapping, msg',
[
(
{'key': {'inner_key': 0}},
{'other_key': 1},
{'key': {'inner_key': 0}, 'other_key': 1},
'extra keys are inserted',
),
(
{'key': {'inner_key': 0}, 'other_key': 1},
{'key': [1, 2, 3]},
{'key': [1, 2, 3], 'other_key': 1},
'values that can not be merged are updated',
),
(
{'key': {'inner_key': 0}},
{'key': {'other_key': 1}},
{'key': {'inner_key': 0, 'other_key': 1}},
'values that have corresponding keys are merged',
),
(
{'key': {'inner_key': {'deep_key': 0}}},
{'key': {'inner_key': {'other_deep_key': 1}}},
{'key': {'inner_key': {'deep_key': 0, 'other_deep_key': 1}}},
'deeply nested values that have corresponding keys are merged',
),
],
)
def test_deep_update(mapping, updating_mapping, expected_mapping, msg):
assert deep_update(mapping, updating_mapping) == expected_mapping, msg
def test_deep_update_is_not_mutating():
mapping = {'key': {'inner_key': {'deep_key': 1}}}
updated_mapping = deep_update(mapping, {'key': {'inner_key': {'other_deep_key': 1}}})
assert updated_mapping == {'key': {'inner_key': {'deep_key': 1, 'other_deep_key': 1}}}
assert mapping == {'key': {'inner_key': {'deep_key': 1}}}
def test_undefined_repr():
assert repr(Undefined) == 'PydanticUndefined'
def test_undefined_copy():
copy(Undefined) is Undefined
deepcopy(Undefined) is Undefined
def test_get_model():
class A(BaseModel):
a: str
assert get_model(A) == A
@dataclass
class B:
a: str
assert get_model(B) == B.__pydantic_model__
class C:
pass
with pytest.raises(TypeError):
get_model(C)
def test_version_info():
s = version_info()
assert re.match(' *pydantic version: ', s)
assert s.count('\n') == 5
def test_version_strict():
assert str(StrictVersion(VERSION)) == VERSION
def test_class_attribute():
class Foo:
attr = ClassAttribute('attr', 'foo')
assert Foo.attr == 'foo'
with pytest.raises(AttributeError, match="'attr' attribute of 'Foo' is class-only"):
Foo().attr
f = Foo()
f.attr = 'not foo'
assert f.attr == 'not foo'
def test_all_literal_values():
L1 = Literal['1']
assert all_literal_values(L1) == ('1',)
L2 = Literal['2']
L12 = Literal[L1, L2]
assert sorted(all_literal_values(L12)) == sorted(('1', '2'))
L312 = Literal['3', Literal[L1, L2]]
assert sorted(all_literal_values(L312)) == sorted(('1', '2', '3'))
def test_path_type(tmp_path):
assert path_type(tmp_path) == 'directory'
file = tmp_path / 'foobar.txt'
file.write_text('hello')
assert path_type(file) == 'file'
def test_path_type_unknown(tmp_path):
p = type(
'FakePath',
(),
{
'exists': lambda: True,
'is_dir': lambda: False,
'is_file': lambda: False,
'is_mount': lambda: False,
'is_symlink': lambda: False,
'is_block_device': lambda: False,
'is_char_device': lambda: False,
'is_fifo': lambda: False,
'is_socket': lambda: False,
},
)
assert path_type(p) == 'unknown'
@pytest.mark.parametrize(
'obj',
(1, 1.0, '1', b'1', int, None, test_all_literal_values, len, test_all_literal_values.__code__, lambda: ..., ...),
)
def test_smart_deepcopy_immutable_non_sequence(obj, mocker):
# make sure deepcopy is not used
# (other option will be to use obj.copy(), but this will produce error as none of given objects have this method)
mocker.patch('pydantic.utils.deepcopy', side_effect=RuntimeError)
assert smart_deepcopy(obj) is deepcopy(obj) is obj
@pytest.mark.parametrize('empty_collection', (collection() for collection in BUILTIN_COLLECTIONS))
def test_smart_deepcopy_empty_collection(empty_collection, mocker):
mocker.patch('pydantic.utils.deepcopy', side_effect=RuntimeError) # make sure deepcopy is not used
if not isinstance(empty_collection, (tuple, frozenset)): # empty tuple or frozenset are always the same object
assert smart_deepcopy(empty_collection) is not empty_collection
@pytest.mark.parametrize(
'collection', (c.fromkeys((1,)) if issubclass(c, dict) else c((1,)) for c in BUILTIN_COLLECTIONS)
)
def test_smart_deepcopy_collection(collection, mocker):
expected_value = object()
mocker.patch('pydantic.utils.deepcopy', return_value=expected_value)
assert smart_deepcopy(collection) is expected_value
T = TypeVar('T')
@pytest.mark.skipif(sys.version_info < (3, 7), reason='get_origin is only consistent for python >= 3.7')
@pytest.mark.parametrize(
'input_value,output_value',
[
(Annotated[int, 10] if Annotated else None, Annotated),
(Callable[[], T][int], collections.abc.Callable),
(Dict[str, int], dict),
(List[str], list),
(Union[int, str], Union),
(int, None),
],
)
def test_get_origin(input_value, output_value):
if input_value is None:
pytest.skip('Skipping undefined hint for this python version')
assert get_origin(input_value) is output_value
@pytest.mark.skipif(sys.version_info < (3, 8), reason='get_args is only consistent for python >= 3.8')
@pytest.mark.parametrize(
'input_value,output_value',
[
(conlist(str), (str,)),
(ConstrainedList, ()),
(List[str], (str,)),
(Dict[str, int], (str, int)),
(int, ()),
(Union[int, Union[T, int], str][int], (int, str)),
(Union[int, Tuple[T, int]][str], (int, Tuple[str, int])),
(Callable[[], T][int], ([], int)),
(Annotated[int, 10] if Annotated else None, (int, 10)),
],
)
def test_get_args(input_value, output_value):
if input_value is None:
pytest.skip('Skipping undefined hint for this python version')
assert get_args(input_value) == output_value
def test_resolve_annotations_no_module():
# TODO: is there a better test for this, can this case really happen?
fr = ForwardRef('Foo')
assert resolve_annotations({'Foo': ForwardRef('Foo')}, None) == {'Foo': fr}
def test_all_identical():
a, b = object(), object()
c = [b]
assert all_identical([a, b], [a, b]) is True
assert all_identical([a, b], [a, b]) is True
assert all_identical([a, b, b], [a, b, b]) is True
assert all_identical([a, c, b], [a, c, b]) is True
assert all_identical([], [a]) is False, 'Expected iterables with different lengths to evaluate to `False`'
assert all_identical([a], []) is False, 'Expected iterables with different lengths to evaluate to `False`'
assert (
all_identical([a, [b], b], [a, [b], b]) is False
), 'New list objects are different objects and should therefor not be identical.'