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 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
|
import collections.abc
import os
import pickle
import sys
import time
from copy import copy, deepcopy
from typing import Annotated, Callable, Generic, TypeVar, Union
import pytest
from pydantic_core import PydanticCustomError, PydanticUndefined
from pydantic import BaseModel
from pydantic._internal import _repr
from pydantic._internal._typing_extra import get_origin
from pydantic._internal._utils import (
BUILTIN_COLLECTIONS,
LazyClassAttribute,
ValueItems,
all_identical,
deep_update,
lenient_issubclass,
smart_deepcopy,
unique_list,
)
from pydantic._internal._validators import import_string
from pydantic.alias_generators import to_camel, to_pascal, to_snake
from pydantic.color import Color
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(PydanticCustomError, match="Invalid python path: No module named 'xx'"):
import_string('xx')
def test_import_no_attr():
with pytest.raises(PydanticCustomError, match="cannot import name 'foobar' from 'os'"):
import_string('os:foobar')
def foobar(a, b, c=4):
pass
T = TypeVar('T')
class LoggedVar(Generic[T]):
def get(self) -> T: ...
@pytest.mark.parametrize(
'value,expected',
[
(str, 'str'),
('foobar', 'str'),
('SomeForwardRefString', 'str'), # included to document current behavior; could be changed
(Union[str, int], 'Union[str, int]'),
(list, 'list'),
([1, 2, 3], 'list'),
(list[dict[str, int]], 'list[dict[str, int]]'),
(tuple[str, int, float], 'tuple[str, int, float]'),
(tuple[str, ...], 'tuple[str, ...]'),
(Union[int, list[str], tuple[str, int]], 'Union[int, list[str], tuple[str, int]]'),
(foobar, 'foobar'),
(time.time_ns, 'time_ns'),
(LoggedVar, 'LoggedVar'),
(LoggedVar(), 'LoggedVar'),
],
)
def test_display_as_type(value, expected):
assert _repr.display_as_type(value) == expected
@pytest.mark.skipif(sys.version_info < (3, 10), reason='requires python 3.10 or higher')
@pytest.mark.parametrize(
'value_gen,expected',
[
(lambda: str, 'str'),
(lambda: 'SomeForwardRefString', 'str'), # included to document current behavior; could be changed
(lambda: str | int, 'Union[str, int]'),
(lambda: list, 'list'),
(lambda: list[int], 'list[int]'),
(lambda: list[int], 'list[int]'),
(lambda: list[dict[str, int]], 'list[dict[str, int]]'),
(lambda: list[Union[str, int]], 'list[Union[str, int]]'),
(lambda: list[str | int], 'list[Union[str, int]]'),
(lambda: LoggedVar[int], 'LoggedVar[int]'),
(lambda: LoggedVar[dict[int, str]], 'LoggedVar[dict[int, str]]'),
],
)
def test_display_as_type_310(value_gen, expected):
value = value_gen()
assert _repr.display_as_type(value) == expected
def test_lenient_issubclass():
class A(str):
pass
assert lenient_issubclass(A, str) is True
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',
[
([], []),
([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: Ellipsis, 2: Ellipsis})'
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']
vi = ValueItems([], {'__all__': {}})
assert vi._items == {}
with pytest.raises(TypeError, match='Unexpected type of exclude value for index "a" <class \'NoneType\'>'):
ValueItems(['a', 'b'], {'a': None})
m = (
'Excluding fields from a sequence of sub-models or dicts must be performed index-wise: '
'expected integer keys or keyword "__all__"'
)
with pytest.raises(TypeError, match=m):
ValueItems(['a', 'b'], {'a': {}})
vi = ValueItems([1, 2, 3, 4], {'__all__': True})
assert repr(vi) == 'ValueItems({0: Ellipsis, 1: Ellipsis, 2: Ellipsis, 3: Ellipsis})'
vi = ValueItems([1, 2], {'__all__': {1, 2}})
assert repr(vi) == 'ValueItems({0: {1: Ellipsis, 2: Ellipsis}, 1: {1: Ellipsis, 2: Ellipsis}})'
@pytest.mark.parametrize(
'base,override,intersect,expected',
[
# Check in default (union) mode
(..., ..., False, ...),
(None, None, False, None),
({}, {}, False, {}),
(..., None, False, ...),
(None, ..., False, ...),
(None, {}, False, {}),
({}, None, False, {}),
(..., {}, False, {}),
({}, ..., False, ...),
({'a': None}, {'a': None}, False, {}),
({'a'}, ..., False, ...),
({'a'}, {}, False, {'a': ...}),
({'a'}, {'b'}, False, {'a': ..., 'b': ...}),
({'a': ...}, {'b': {'c'}}, False, {'a': ..., 'b': {'c': ...}}),
({'a': ...}, {'a': {'c'}}, False, {'a': {'c': ...}}),
({'a': {'c': ...}, 'b': {'d'}}, {'a': ...}, False, {'a': ..., 'b': {'d': ...}}),
# Check in intersection mode
(..., ..., True, ...),
(None, None, True, None),
({}, {}, True, {}),
(..., None, True, ...),
(None, ..., True, ...),
(None, {}, True, {}),
({}, None, True, {}),
(..., {}, True, {}),
({}, ..., True, {}),
({'a': None}, {'a': None}, True, {}),
({'a'}, ..., True, {'a': ...}),
({'a'}, {}, True, {}),
({'a'}, {'b'}, True, {}),
({'a': ...}, {'b': {'c'}}, True, {}),
({'a': ...}, {'a': {'c'}}, True, {'a': {'c': ...}}),
({'a': {'c': ...}, 'b': {'d'}}, {'a': ...}, True, {'a': {'c': ...}}),
# Check usage of `True` instead of `...`
(..., True, False, True),
(True, ..., False, ...),
(True, None, False, True),
({'a': {'c': True}, 'b': {'d'}}, {'a': True}, False, {'a': True, 'b': {'d': ...}}),
],
)
def test_value_items_merge(base, override, intersect, expected):
actual = ValueItems.merge(base, override, intersect=intersect)
assert actual == expected
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_pretty():
class MyTestModel(BaseModel):
a: int = 1
b: list[int] = [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,
')',
]
@pytest.mark.filterwarnings('ignore::DeprecationWarning')
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: int = 1
b: list[int] = [1, 2, 3]
assert devtools.pformat(MyTestModel()) == 'MyTestModel(\n a=1,\n b=[1, 2, 3],\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(PydanticUndefined) == 'PydanticUndefined'
def test_undefined_copy():
assert copy(PydanticUndefined) is PydanticUndefined
assert deepcopy(PydanticUndefined) is PydanticUndefined
def test_class_attribute():
class Foo:
attr = LazyClassAttribute('attr', lambda: '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'
@pytest.mark.parametrize(
'obj',
(1, 1.0, '1', b'1', int, None, test_class_attribute, len, test_class_attribute.__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._internal._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._internal._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.thread_unsafe(reason='Monkeypatching')
@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._internal._utils.deepcopy', return_value=expected_value)
assert smart_deepcopy(collection) is expected_value
@pytest.mark.parametrize('error', [TypeError, ValueError, RuntimeError])
def test_smart_deepcopy_error(error, mocker):
class RaiseOnBooleanOperation(str):
def __bool__(self):
raise error('raised error')
obj = RaiseOnBooleanOperation()
expected_value = deepcopy(obj)
assert smart_deepcopy(obj) == expected_value
T = TypeVar('T')
@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
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 therefore not be identical.'
)
def test_undefined_pickle():
undefined2 = pickle.loads(pickle.dumps(PydanticUndefined))
assert undefined2 is PydanticUndefined
def test_on_lower_camel_zero_length():
assert to_camel('') == ''
def test_on_lower_camel_one_length():
assert to_camel('a') == 'a'
def test_on_lower_camel_many_length():
assert to_camel('i_like_turtles') == 'iLikeTurtles'
@pytest.mark.parametrize(
'value,result',
[
('snake_to_camel', 'snakeToCamel'),
('snake_2_camel', 'snake2Camel'),
('snake2camel', 'snake2Camel'),
('_snake_to_camel', '_snakeToCamel'),
('snake_to_camel_', 'snakeToCamel_'),
('__snake_to_camel__', '__snakeToCamel__'),
('snake_2', 'snake2'),
('_snake_2', '_snake2'),
('snake_2_', 'snake2_'),
],
)
def test_snake2camel_start_lower(value: str, result: str) -> None:
assert to_camel(value) == result
@pytest.mark.parametrize(
'value,result',
[
('snake_to_camel', 'SnakeToCamel'),
('snake_2_camel', 'Snake2Camel'),
('snake2camel', 'Snake2Camel'),
('_snake_to_camel', '_SnakeToCamel'),
('snake_to_camel_', 'SnakeToCamel_'),
('__snake_to_camel__', '__SnakeToCamel__'),
('snake_2', 'Snake2'),
('_snake_2', '_Snake2'),
('snake_2_', 'Snake2_'),
],
)
def test_snake2pascal(value: str, result: str) -> None:
assert to_pascal(value) == result
@pytest.mark.parametrize(
'value,result',
[
('camel_to_snake', 'camel_to_snake'),
('camelToSnake', 'camel_to_snake'),
('camel2Snake', 'camel_2_snake'),
('_camelToSnake', '_camel_to_snake'),
('camelToSnake_', 'camel_to_snake_'),
('__camelToSnake__', '__camel_to_snake__'),
('CamelToSnake', 'camel_to_snake'),
('Camel2Snake', 'camel_2_snake'),
('_CamelToSnake', '_camel_to_snake'),
('CamelToSnake_', 'camel_to_snake_'),
('CAMELToSnake', 'camel_to_snake'),
('__CamelToSnake__', '__camel_to_snake__'),
('Camel2', 'camel_2'),
('Camel2_', 'camel_2_'),
('_Camel2', '_camel_2'),
('camel2', 'camel_2'),
('camel2_', 'camel_2_'),
('_camel2', '_camel_2'),
('kebab-to-snake', 'kebab_to_snake'),
('kebab-Snake', 'kebab_snake'),
('Kebab-Snake', 'kebab_snake'),
('PascalToSnake', 'pascal_to_snake'),
('snake_to_snake', 'snake_to_snake'),
('snakeV2', 'snake_v2'),
],
)
def test_to_snake(value: str, result: str) -> None:
assert to_snake(value) == result
def test_to_camel_from_camel() -> None:
assert to_camel('alreadyCamel') == 'alreadyCamel'
|