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 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
|
import platform
import sys
from dataclasses import dataclass
from datetime import date, time
from enum import Enum, IntEnum
from itertools import permutations
from typing import Any, Optional, Union
from uuid import UUID
import pytest
from dirty_equals import IsFloat, IsInt
from pydantic_core import CoreConfig, SchemaError, SchemaValidator, ValidationError, core_schema
from ..conftest import plain_repr
@pytest.mark.parametrize(
'input_value,expected_value',
[
(True, True),
(False, False),
('true', True),
('false', False),
(1, 1),
(0, 0),
(123, 123),
('123', 123),
('0', False), # this case is different depending on the order of the choices
('1', True), # this case is different depending on the order of the choices
],
)
def test_union_bool_int(input_value, expected_value):
v = SchemaValidator(core_schema.union_schema(choices=[core_schema.bool_schema(), core_schema.int_schema()]))
assert v.validate_python(input_value) == expected_value
@pytest.mark.parametrize(
'input_value,expected_value',
[
(True, True),
(False, False),
('true', True),
('false', False),
(1, 1),
(0, 0),
(123, 123),
('123', 123),
('0', 0), # this case is different depending on the order of the choices
('1', 1), # this case is different depending on the order of the choices
],
)
def test_union_int_bool(input_value, expected_value):
v = SchemaValidator(core_schema.union_schema(choices=[core_schema.int_schema(), core_schema.bool_schema()]))
assert v.validate_python(input_value) == expected_value
class TestModelClass:
class ModelA:
pass
class ModelB:
pass
@pytest.fixture(scope='class')
def schema_validator(self) -> SchemaValidator:
return SchemaValidator(
schema=core_schema.union_schema(
choices=[
core_schema.model_schema(
cls=self.ModelA,
schema=core_schema.model_fields_schema(
fields={
'a': core_schema.model_field(schema=core_schema.int_schema()),
'b': core_schema.model_field(schema=core_schema.str_schema()),
}
),
),
core_schema.model_schema(
cls=self.ModelB,
schema=core_schema.model_fields_schema(
fields={
'c': core_schema.model_field(schema=core_schema.int_schema()),
'd': core_schema.model_field(schema=core_schema.str_schema()),
}
),
),
]
)
)
def test_model_a(self, schema_validator: SchemaValidator):
m_a = schema_validator.validate_python({'a': 1, 'b': 'hello'})
assert isinstance(m_a, self.ModelA)
assert m_a.a == 1
assert m_a.b == 'hello'
def test_model_b(self, schema_validator: SchemaValidator):
m_b = schema_validator.validate_python({'c': 2, 'd': 'again'})
assert isinstance(m_b, self.ModelB)
assert m_b.c == 2
assert m_b.d == 'again'
def test_exact_check(self, schema_validator: SchemaValidator):
m_b = schema_validator.validate_python({'c': 2, 'd': 'again'})
assert isinstance(m_b, self.ModelB)
m_b2 = schema_validator.validate_python(m_b)
assert m_b2 is m_b
def test_error(self, schema_validator: SchemaValidator):
with pytest.raises(ValidationError) as exc_info:
schema_validator.validate_python({'a': 2})
assert exc_info.value.errors(include_url=False) == [
{'type': 'missing', 'loc': ('ModelA', 'b'), 'msg': 'Field required', 'input': {'a': 2}},
{'type': 'missing', 'loc': ('ModelB', 'c'), 'msg': 'Field required', 'input': {'a': 2}},
{'type': 'missing', 'loc': ('ModelB', 'd'), 'msg': 'Field required', 'input': {'a': 2}},
]
class TestModelClassSimilar:
class ModelA:
pass
class ModelB:
pass
@pytest.fixture(scope='class')
def schema_validator(self) -> SchemaValidator:
return SchemaValidator(
schema=core_schema.union_schema(
choices=[
core_schema.model_schema(
cls=self.ModelA,
schema=core_schema.model_fields_schema(
fields={
'a': core_schema.model_field(schema=core_schema.int_schema()),
'b': core_schema.model_field(schema=core_schema.str_schema()),
}
),
),
core_schema.model_schema(
cls=self.ModelB,
schema=core_schema.model_fields_schema(
fields={
'a': core_schema.model_field(schema=core_schema.int_schema()),
'b': core_schema.model_field(schema=core_schema.str_schema()),
'c': core_schema.model_field(
schema=core_schema.with_default_schema(
schema=core_schema.float_schema(), default=1.0
)
),
}
),
),
]
)
)
def test_model_a(self, schema_validator: SchemaValidator):
m = schema_validator.validate_python({'a': 1, 'b': 'hello'})
assert isinstance(m, self.ModelA)
assert m.a == 1
assert m.b == 'hello'
assert not hasattr(m, 'c')
def test_model_b_preferred(self, schema_validator: SchemaValidator):
# Note, this is a different behavior to previous smart union behavior,
# where the first match would be preferred. However, we believe is it better
# to prefer the match with the greatest number of valid fields set.
m = schema_validator.validate_python({'a': 1, 'b': 'hello', 'c': 2.0})
assert isinstance(m, self.ModelB)
assert m.a == 1
assert m.b == 'hello'
assert m.c == 2.0
def test_model_b_not_ignored(self, schema_validator: SchemaValidator):
m1 = self.ModelB()
m1.a = 1
m1.b = 'hello'
m1.c = 2.0
m2 = schema_validator.validate_python(m1)
assert isinstance(m2, self.ModelB)
assert m2.a == 1
assert m2.b == 'hello'
assert m2.c == 2.0
def test_nullable_via_union():
v = SchemaValidator(core_schema.union_schema(choices=[core_schema.none_schema(), core_schema.int_schema()]))
assert v.validate_python(None) is None
assert v.validate_python(1) == 1
with pytest.raises(ValidationError) as exc_info:
v.validate_python('hello')
assert exc_info.value.errors(include_url=False) == [
{'type': 'none_required', 'loc': ('none',), 'msg': 'Input should be None', 'input': 'hello'},
{
'type': 'int_parsing',
'loc': ('int',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'hello',
},
]
def test_union_list_bool_int():
v = SchemaValidator(
core_schema.union_schema(
choices=[
core_schema.list_schema(items_schema=core_schema.bool_schema()),
core_schema.list_schema(items_schema=core_schema.int_schema()),
]
)
)
assert v.validate_python(['true', True, 'no']) == [True, True, False]
assert v.validate_python([5, 6, '789']) == [5, 6, 789]
assert v.validate_python(['1', '0']) == [1, 0]
with pytest.raises(ValidationError) as exc_info:
v.validate_python([3, 'true'])
assert exc_info.value.errors(include_url=False) == [
{
'type': 'bool_parsing',
'loc': ('list[bool]', 0),
'msg': 'Input should be a valid boolean, unable to interpret input',
'input': 3,
},
{
'type': 'int_parsing',
'loc': ('list[int]', 1),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'true',
},
]
@pytest.mark.xfail(
platform.python_implementation() == 'PyPy' and sys.version_info[:2] == (3, 11), reason='pypy 3.11 type formatting'
)
def test_empty_choices():
msg = r'Error building "union" validator:\s+SchemaError: One or more union choices required'
with pytest.raises(SchemaError, match=msg):
SchemaValidator(core_schema.union_schema(choices=[]))
def test_one_choice():
v = SchemaValidator(core_schema.union_schema(choices=[core_schema.str_schema()]))
assert (
plain_repr(v)
== 'SchemaValidator(title="str",validator=Str(StrValidator{strict:false,coerce_numbers_to_str:false}),definitions=[],cache_strings=True)'
)
assert v.validate_python('hello') == 'hello'
def test_strict_union_flag() -> None:
v = SchemaValidator(core_schema.union_schema(choices=[core_schema.bool_schema(), core_schema.int_schema()]))
assert v.validate_python(1, strict=True) == 1
assert v.validate_python(123, strict=True) == 123
with pytest.raises(ValidationError) as exc_info:
v.validate_python('123', strict=True)
assert exc_info.value.errors(include_url=False) == [
{'type': 'bool_type', 'loc': ('bool',), 'msg': 'Input should be a valid boolean', 'input': '123'},
{'type': 'int_type', 'loc': ('int',), 'msg': 'Input should be a valid integer', 'input': '123'},
]
def test_strict_union_config_level() -> None:
v = SchemaValidator(
core_schema.union_schema(choices=[core_schema.bool_schema(), core_schema.int_schema()]),
config=CoreConfig(strict=True),
)
assert v.validate_python(1) == 1
assert v.validate_python(123) == 123
with pytest.raises(ValidationError) as exc_info:
v.validate_python('123')
assert exc_info.value.errors(include_url=False) == [
{'type': 'bool_type', 'loc': ('bool',), 'msg': 'Input should be a valid boolean', 'input': '123'},
{'type': 'int_type', 'loc': ('int',), 'msg': 'Input should be a valid integer', 'input': '123'},
]
def test_strict_union_member_level() -> None:
v = SchemaValidator(
core_schema.union_schema(choices=[core_schema.bool_schema(strict=True), core_schema.int_schema(strict=True)])
)
assert v.validate_python(1) == 1
assert v.validate_python(123) == 123
with pytest.raises(ValidationError) as exc_info:
v.validate_python('123')
assert exc_info.value.errors(include_url=False) == [
{'type': 'bool_type', 'loc': ('bool',), 'msg': 'Input should be a valid boolean', 'input': '123'},
{'type': 'int_type', 'loc': ('int',), 'msg': 'Input should be a valid integer', 'input': '123'},
]
def test_custom_error():
v = SchemaValidator(
core_schema.union_schema(
choices=[core_schema.str_schema(), core_schema.bytes_schema()],
custom_error_type='my_error',
custom_error_message='Input should be a string or bytes',
)
)
assert v.validate_python('hello') == 'hello'
assert v.validate_python(b'hello') == b'hello'
with pytest.raises(ValidationError) as exc_info:
v.validate_python(123)
# insert_assert(exc_info.value.errors(include_url=False))
assert exc_info.value.errors(include_url=False) == [
{'type': 'my_error', 'loc': (), 'msg': 'Input should be a string or bytes', 'input': 123}
]
def test_custom_error_type():
v = SchemaValidator(
core_schema.union_schema(
choices=[core_schema.str_schema(), core_schema.bytes_schema()], custom_error_type='string_type'
)
)
assert v.validate_python('hello') == 'hello'
assert v.validate_python(b'hello') == b'hello'
with pytest.raises(ValidationError) as exc_info:
v.validate_python(123)
# insert_assert(exc_info.value.errors(include_url=False))
assert exc_info.value.errors(include_url=False) == [
{'type': 'string_type', 'loc': (), 'msg': 'Input should be a valid string', 'input': 123}
]
def test_custom_error_type_context():
v = SchemaValidator(
core_schema.union_schema(
choices=[core_schema.str_schema(), core_schema.bytes_schema()],
custom_error_type='less_than',
custom_error_context={'lt': 42},
)
)
assert v.validate_python('hello') == 'hello'
assert v.validate_python(b'hello') == b'hello'
with pytest.raises(ValidationError) as exc_info:
v.validate_python(123)
# insert_assert(exc_info.value.errors(include_url=False))
assert exc_info.value.errors(include_url=False) == [
{'type': 'less_than', 'loc': (), 'msg': 'Input should be less than 42', 'input': 123, 'ctx': {'lt': 42.0}}
]
def test_dirty_behaviour():
"""
Check dirty-equals does what we expect.
"""
assert 1 == IsInt(approx=1, delta=0)
assert 1.0 != IsInt(approx=1, delta=0)
assert 1 != IsFloat(approx=1, delta=0)
assert 1.0 == IsFloat(approx=1, delta=0)
def test_int_float():
v = SchemaValidator(core_schema.union_schema([core_schema.int_schema(), core_schema.float_schema()]))
assert v.validate_python(1) == IsInt(approx=1, delta=0)
assert v.validate_json('1') == IsInt(approx=1, delta=0)
assert v.validate_python(1.0) == IsFloat(approx=1, delta=0)
assert v.validate_json('1.0') == IsFloat(approx=1, delta=0)
v = SchemaValidator(core_schema.union_schema([core_schema.float_schema(), core_schema.int_schema()]))
assert v.validate_python(1) == IsInt(approx=1, delta=0)
assert v.validate_json('1') == IsInt(approx=1, delta=0)
assert v.validate_python(1.0) == IsFloat(approx=1, delta=0)
assert v.validate_json('1.0') == IsFloat(approx=1, delta=0)
def test_str_float():
v = SchemaValidator(core_schema.union_schema([core_schema.str_schema(), core_schema.float_schema()]))
assert v.validate_python(1) == IsFloat(approx=1, delta=0)
assert v.validate_json('1') == IsFloat(approx=1, delta=0)
assert v.validate_python(1.0) == IsFloat(approx=1, delta=0)
assert v.validate_json('1.0') == IsFloat(approx=1, delta=0)
assert v.validate_python('1.0') == '1.0'
assert v.validate_python('1') == '1'
assert v.validate_json('"1.0"') == '1.0'
assert v.validate_json('"1"') == '1'
v = SchemaValidator(core_schema.union_schema([core_schema.float_schema(), core_schema.str_schema()]))
assert v.validate_python(1) == IsFloat(approx=1, delta=0)
assert v.validate_json('1') == IsFloat(approx=1, delta=0)
assert v.validate_python(1.0) == IsFloat(approx=1, delta=0)
assert v.validate_json('1.0') == IsFloat(approx=1, delta=0)
assert v.validate_python('1.0') == '1.0'
assert v.validate_python('1') == '1'
assert v.validate_json('"1.0"') == '1.0'
assert v.validate_json('"1"') == '1'
def test_no_strict_check():
v = SchemaValidator(core_schema.union_schema([core_schema.is_instance_schema(int), core_schema.json_schema()]))
assert v.validate_python(123) == 123
assert v.validate_python('[1, 2, 3]') == [1, 2, 3]
def test_strict_reference():
v = SchemaValidator(
core_schema.definitions_schema(
core_schema.definition_reference_schema(schema_ref='tuple-ref'),
[
core_schema.tuple_positional_schema(
[
core_schema.float_schema(),
core_schema.union_schema(
[core_schema.int_schema(), core_schema.definition_reference_schema('tuple-ref')]
),
],
ref='tuple-ref',
)
],
)
)
assert repr(v.validate_python((1, 2))) == '(1.0, 2)'
assert repr(v.validate_python((1.0, (2.0, 3)))) == '(1.0, (2.0, 3))'
def test_case_labels():
v = SchemaValidator(
core_schema.union_schema(
choices=[core_schema.none_schema(), ({'type': 'int'}, 'my_label'), core_schema.str_schema()]
)
)
assert v.validate_python(None) is None
assert v.validate_python(1) == 1
with pytest.raises(ValidationError, match=r'3 validation errors for union\[none,my_label,str]') as exc_info:
v.validate_python(1.5)
assert exc_info.value.errors(include_url=False) == [
{'input': 1.5, 'loc': ('none',), 'msg': 'Input should be None', 'type': 'none_required'},
{
'input': 1.5,
'loc': ('my_label',),
'msg': 'Input should be a valid integer, got a number with a fractional part',
'type': 'int_from_float',
},
{'input': 1.5, 'loc': ('str',), 'msg': 'Input should be a valid string', 'type': 'string_type'},
]
def test_left_to_right_doesnt_care_about_strict_check():
v = SchemaValidator(
core_schema.union_schema([core_schema.int_schema(), core_schema.json_schema()], mode='left_to_right')
)
assert 'strict_required' not in plain_repr(v)
assert 'ultra_strict_required' not in plain_repr(v)
def test_left_to_right_union():
choices = [core_schema.int_schema(), core_schema.float_schema()]
# smart union prefers float
v = SchemaValidator(core_schema.union_schema(choices, mode='smart'))
out = v.validate_python(1.0)
assert out == 1.0
assert isinstance(out, float)
# left_to_right union will select int
v = SchemaValidator(core_schema.union_schema(choices, mode='left_to_right'))
out = v.validate_python(1)
assert out == 1
assert isinstance(out, int)
out = v.validate_python(1.0)
assert out == 1
assert isinstance(out, int)
# reversing them will select float
v = SchemaValidator(core_schema.union_schema(list(reversed(choices)), mode='left_to_right'))
out = v.validate_python(1.0)
assert out == 1.0
assert isinstance(out, float)
out = v.validate_python(1)
assert out == 1.0
assert isinstance(out, float)
def test_left_to_right_union_strict():
choices = [core_schema.int_schema(strict=True), core_schema.float_schema(strict=True)]
# left_to_right union will select not cast if int first (strict int will not accept float)
v = SchemaValidator(core_schema.union_schema(choices, mode='left_to_right'))
out = v.validate_python(1)
assert out == 1
assert isinstance(out, int)
out = v.validate_python(1.0)
assert out == 1.0
assert isinstance(out, float)
# reversing union will select float always (as strict float will accept int)
v = SchemaValidator(
core_schema.union_schema(
list(reversed(choices)),
mode='left_to_right',
)
)
out = v.validate_python(1.0)
assert out == 1.0
assert isinstance(out, float)
out = v.validate_python(1)
assert out == 1.0
assert isinstance(out, float)
def test_union_function_before_called_once():
# See https://github.com/pydantic/pydantic/issues/6830 - in particular the
# smart union validator used to call `remove_prefix` twice, which is not
# ideal from a user perspective.
class SpecialValues(str, Enum):
DEFAULT = 'default'
OTHER = 'other'
special_values_schema = core_schema.no_info_after_validator_function(SpecialValues, core_schema.str_schema())
validator_called_count = 0
def remove_prefix(v: str):
nonlocal validator_called_count
validator_called_count += 1
if v.startswith('uuid::'):
return v[6:]
return v
prefixed_uuid_schema = core_schema.no_info_before_validator_function(remove_prefix, core_schema.uuid_schema())
v = SchemaValidator(core_schema.union_schema([special_values_schema, prefixed_uuid_schema]))
assert v.validate_python('uuid::12345678-1234-5678-1234-567812345678') == UUID(
'12345678-1234-5678-1234-567812345678'
)
assert validator_called_count == 1
@pytest.mark.parametrize(
('schema', 'input_value', 'expected_value'),
(
(
core_schema.uuid_schema(),
'12345678-1234-5678-1234-567812345678',
UUID('12345678-1234-5678-1234-567812345678'),
),
(core_schema.date_schema(), '2020-01-01', date(2020, 1, 1)),
(core_schema.time_schema(), '00:00:00', time(0, 0, 0)),
# In V2.4 these already returned strings, so we keep this behaviour in V2
(core_schema.datetime_schema(), '2020-01-01:00:00:00', '2020-01-01:00:00:00'),
(core_schema.url_schema(), 'https://foo.com', 'https://foo.com'),
(core_schema.multi_host_url_schema(), 'https://bar.com,foo.com', 'https://bar.com,foo.com'),
),
)
def test_smart_union_json_string_types(schema: core_schema.CoreSchema, input_value: str, expected_value: Any):
# Many types have to be represented in strings as JSON, we make sure that
# when parsing in JSON mode these types are preferred
# TODO: in V3 we will make str win in all these cases.
validator = SchemaValidator(core_schema.union_schema([schema, core_schema.str_schema()]))
assert validator.validate_json(f'"{input_value}"') == expected_value
# in Python mode the string will be preferred
assert validator.validate_python(input_value) == input_value
@pytest.mark.parametrize(
('schema', 'input_value'),
(
pytest.param(
core_schema.uuid_schema(),
'12345678-1234-5678-1234-567812345678',
marks=pytest.mark.xfail(reason='TODO: V3'),
),
(core_schema.date_schema(), '2020-01-01'),
(core_schema.time_schema(), '00:00:00'),
(core_schema.datetime_schema(), '2020-01-01:00:00:00'),
(core_schema.url_schema(), 'https://foo.com'),
(core_schema.multi_host_url_schema(), 'https://bar.com,foo.com'),
),
)
def test_smart_union_json_string_types_str_first(schema: core_schema.CoreSchema, input_value: str):
# As above, but reversed order; str should always win
validator = SchemaValidator(core_schema.union_schema([core_schema.str_schema(), schema]))
assert validator.validate_json(f'"{input_value}"') == input_value
assert validator.validate_python(input_value) == input_value
def test_smart_union_default_fallback():
"""Using a default value does not affect the exactness of the smart union match."""
class ModelA:
x: int
y: int = 1
class ModelB:
x: int
schema = core_schema.union_schema(
[
core_schema.model_schema(
ModelA,
core_schema.model_fields_schema(
{
'x': core_schema.model_field(core_schema.int_schema()),
'y': core_schema.model_field(
core_schema.with_default_schema(core_schema.int_schema(), default=1)
),
}
),
),
core_schema.model_schema(
ModelB, core_schema.model_fields_schema({'x': core_schema.model_field(core_schema.int_schema())})
),
]
)
validator = SchemaValidator(schema)
result = validator.validate_python({'x': 1})
assert isinstance(result, ModelA)
assert result.x == 1
assert result.y == 1
# passing a ModelB explicitly will not match the default value
b = ModelB()
assert validator.validate_python(b) is b
def test_smart_union_model_field():
class ModelA:
x: int
class ModelB:
x: str
schema = core_schema.union_schema(
[
core_schema.model_schema(
ModelA, core_schema.model_fields_schema({'x': core_schema.model_field(core_schema.int_schema())})
),
core_schema.model_schema(
ModelB, core_schema.model_fields_schema({'x': core_schema.model_field(core_schema.str_schema())})
),
]
)
validator = SchemaValidator(schema)
result = validator.validate_python({'x': 1})
assert isinstance(result, ModelA)
assert result.x == 1
result = validator.validate_python({'x': '1'})
assert isinstance(result, ModelB)
assert result.x == '1'
def test_smart_union_dataclass_field():
@dataclass
class ModelA:
x: int
@dataclass
class ModelB:
x: str
schema = core_schema.union_schema(
[
core_schema.dataclass_schema(
ModelA,
core_schema.dataclass_args_schema(
'ModelA', [core_schema.dataclass_field('x', core_schema.int_schema())]
),
['x'],
),
core_schema.dataclass_schema(
ModelB,
core_schema.dataclass_args_schema(
'ModelB', [core_schema.dataclass_field('x', core_schema.str_schema())]
),
['x'],
),
]
)
validator = SchemaValidator(schema)
result = validator.validate_python({'x': 1})
assert isinstance(result, ModelA)
assert result.x == 1
result = validator.validate_python({'x': '1'})
assert isinstance(result, ModelB)
assert result.x == '1'
def test_smart_union_with_any():
"""any is preferred over lax validations"""
# str not coerced to int
schema = core_schema.union_schema([core_schema.int_schema(), core_schema.any_schema()])
validator = SchemaValidator(schema)
assert validator.validate_python('1') == '1'
# int *is* coerced to float, this is a strict validation
schema = core_schema.union_schema([core_schema.float_schema(), core_schema.any_schema()])
validator = SchemaValidator(schema)
assert repr(validator.validate_python(1)) == '1.0'
def test_smart_union_validator_function():
"""adding a validator function should not change smart union behaviour"""
inner_schema = core_schema.union_schema([core_schema.int_schema(), core_schema.float_schema()])
validator = SchemaValidator(inner_schema)
assert repr(validator.validate_python(1)) == '1'
assert repr(validator.validate_python(1.0)) == '1.0'
schema = core_schema.union_schema(
[core_schema.no_info_after_validator_function(lambda v: v * 2, inner_schema), core_schema.str_schema()]
)
validator = SchemaValidator(schema)
assert repr(validator.validate_python(1)) == '2'
assert repr(validator.validate_python(1.0)) == '2.0'
assert validator.validate_python('1') == '1'
schema = core_schema.union_schema(
[
core_schema.no_info_wrap_validator_function(lambda v, handler: handler(v) * 2, inner_schema),
core_schema.str_schema(),
]
)
validator = SchemaValidator(schema)
assert repr(validator.validate_python(1)) == '2'
assert repr(validator.validate_python(1.0)) == '2.0'
assert validator.validate_python('1') == '1'
def test_smart_union_validator_function_one_arm():
"""adding a validator function should not change smart union behaviour"""
schema = core_schema.union_schema(
[
core_schema.float_schema(),
core_schema.no_info_after_validator_function(lambda v: v * 2, core_schema.int_schema()),
]
)
validator = SchemaValidator(schema)
assert repr(validator.validate_python(1)) == '2'
assert repr(validator.validate_python(1.0)) == '1.0'
schema = core_schema.union_schema(
[
core_schema.float_schema(),
core_schema.no_info_wrap_validator_function(lambda v, handler: handler(v) * 2, core_schema.int_schema()),
]
)
validator = SchemaValidator(schema)
assert repr(validator.validate_python(1)) == '2'
assert repr(validator.validate_python(1.0)) == '1.0'
def test_int_not_coerced_to_enum():
class BinaryEnum(IntEnum):
ZERO = 0
ONE = 1
enum_schema = core_schema.lax_or_strict_schema(
core_schema.no_info_after_validator_function(BinaryEnum, core_schema.int_schema()),
core_schema.is_instance_schema(BinaryEnum),
)
schema = core_schema.union_schema([enum_schema, core_schema.int_schema()])
validator = SchemaValidator(schema)
assert validator.validate_python(0) is not BinaryEnum.ZERO
assert validator.validate_python(1) is not BinaryEnum.ONE
assert validator.validate_python(BinaryEnum.ZERO) is BinaryEnum.ZERO
assert validator.validate_python(BinaryEnum.ONE) is BinaryEnum.ONE
def test_model_and_literal_union() -> None:
# see https://github.com/pydantic/pydantic/issues/8183
class ModelA:
pass
validator = SchemaValidator(
core_schema.union_schema(
choices=[
core_schema.model_schema(
cls=ModelA,
schema=core_schema.model_fields_schema(
fields={'a': core_schema.model_field(schema=core_schema.int_schema())}
),
),
core_schema.literal_schema(expected=[True]),
]
)
)
# validation against Literal[True] fails bc of the unhashable dict
# A ValidationError is raised, not a ValueError, which allows the validation against the union to continue
m = validator.validate_python({'a': 42})
assert isinstance(m, ModelA)
assert m.a == 42
assert validator.validate_python(True) is True
def permute_choices(choices: list[core_schema.CoreSchema]) -> list[list[core_schema.CoreSchema]]:
return [list(p) for p in permutations(choices)]
class TestSmartUnionWithSubclass:
class ModelA:
a: int
class ModelB(ModelA):
b: int
model_a_schema = core_schema.model_schema(
ModelA, core_schema.model_fields_schema(fields={'a': core_schema.model_field(core_schema.int_schema())})
)
model_b_schema = core_schema.model_schema(
ModelB,
core_schema.model_fields_schema(
fields={
'a': core_schema.model_field(core_schema.int_schema()),
'b': core_schema.model_field(core_schema.int_schema()),
}
),
)
@pytest.mark.parametrize('choices', permute_choices([model_a_schema, model_b_schema]))
def test_more_specific_data_matches_subclass(self, choices) -> None:
validator = SchemaValidator(core_schema.union_schema(choices))
assert isinstance(validator.validate_python({'a': 1}), self.ModelA)
assert isinstance(validator.validate_python({'a': 1, 'b': 2}), self.ModelB)
assert isinstance(validator.validate_python({'a': 1, 'b': 2}), self.ModelB)
# confirm that a model that matches in lax mode with 2 fields
# is preferred over a model that matches in strict mode with 1 field
assert isinstance(validator.validate_python({'a': '1', 'b': '2'}), self.ModelB)
assert isinstance(validator.validate_python({'a': '1', 'b': 2}), self.ModelB)
assert isinstance(validator.validate_python({'a': 1, 'b': '2'}), self.ModelB)
class TestSmartUnionWithDefaults:
class ModelA:
a: int = 0
class ModelB:
b: int = 0
model_a_schema = core_schema.model_schema(
ModelA,
core_schema.model_fields_schema(
fields={'a': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0))}
),
)
model_b_schema = core_schema.model_schema(
ModelB,
core_schema.model_fields_schema(
fields={'b': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0))}
),
)
@pytest.mark.parametrize('choices', permute_choices([model_a_schema, model_b_schema]))
def test_fields_set_ensures_best_match(self, choices) -> None:
validator = SchemaValidator(core_schema.union_schema(choices))
assert isinstance(validator.validate_python({'a': 1}), self.ModelA)
assert isinstance(validator.validate_python({'b': 1}), self.ModelB)
# defaults to leftmost choice if there's a tie
assert isinstance(validator.validate_python({}), choices[0]['cls'])
@pytest.mark.parametrize('choices', permute_choices([model_a_schema, model_b_schema]))
def test_optional_union_with_members_having_defaults(self, choices) -> None:
class WrapModel:
val: Optional[Union[self.ModelA, self.ModelB]] = None
val = SchemaValidator(
schema=core_schema.model_schema(
WrapModel,
core_schema.model_fields_schema(
fields={
'val': core_schema.model_field(
core_schema.with_default_schema(
core_schema.union_schema(choices),
default=None,
)
)
}
),
)
)
assert isinstance(val.validate_python({'val': {'a': 1}}).val, self.ModelA)
assert isinstance(val.validate_python({'val': {'b': 1}}).val, self.ModelB)
assert val.validate_python({}).val is None
def test_dc_smart_union_by_fields_set() -> None:
@dataclass
class ModelA:
x: int
@dataclass
class ModelB(ModelA):
y: int
dc_a_schema = core_schema.dataclass_schema(
ModelA,
core_schema.dataclass_args_schema('ModelA', [core_schema.dataclass_field('x', core_schema.int_schema())]),
['x'],
)
dc_b_schema = core_schema.dataclass_schema(
ModelB,
core_schema.dataclass_args_schema(
'ModelB',
[
core_schema.dataclass_field('x', core_schema.int_schema()),
core_schema.dataclass_field('y', core_schema.int_schema()),
],
),
['x', 'y'],
)
for choices in permute_choices([dc_a_schema, dc_b_schema]):
validator = SchemaValidator(core_schema.union_schema(choices=choices))
assert isinstance(validator.validate_python({'x': 1}), ModelA)
assert isinstance(validator.validate_python({'x': '1'}), ModelA)
assert isinstance(validator.validate_python({'x': 1, 'y': 2}), ModelB)
assert isinstance(validator.validate_python({'x': 1, 'y': '2'}), ModelB)
assert isinstance(validator.validate_python({'x': '1', 'y': 2}), ModelB)
assert isinstance(validator.validate_python({'x': '1', 'y': '2'}), ModelB)
def test_dc_smart_union_with_defaults() -> None:
@dataclass
class ModelA:
a: int = 0
@dataclass
class ModelB:
b: int = 0
dc_a_schema = core_schema.dataclass_schema(
ModelA,
core_schema.dataclass_args_schema(
'ModelA',
[
core_schema.dataclass_field(
'a', core_schema.with_default_schema(schema=core_schema.int_schema(), default=0)
)
],
),
['a'],
)
dc_b_schema = core_schema.dataclass_schema(
ModelB,
core_schema.dataclass_args_schema(
'ModelB',
[
core_schema.dataclass_field(
'b', core_schema.with_default_schema(schema=core_schema.int_schema(), default=0)
)
],
),
['b'],
)
for choices in permute_choices([dc_a_schema, dc_b_schema]):
validator = SchemaValidator(core_schema.union_schema(choices=choices))
assert isinstance(validator.validate_python({'a': 1}), ModelA)
assert isinstance(validator.validate_python({'b': 1}), ModelB)
def test_td_smart_union_by_fields_set() -> None:
td_a_schema = core_schema.typed_dict_schema(
fields={'x': core_schema.typed_dict_field(core_schema.int_schema())},
)
td_b_schema = core_schema.typed_dict_schema(
fields={
'x': core_schema.typed_dict_field(core_schema.int_schema()),
'y': core_schema.typed_dict_field(core_schema.int_schema()),
},
)
for choices in permute_choices([td_a_schema, td_b_schema]):
validator = SchemaValidator(core_schema.union_schema(choices=choices))
assert set(validator.validate_python({'x': 1}).keys()) == {'x'}
assert set(validator.validate_python({'x': '1'}).keys()) == {'x'}
assert set(validator.validate_python({'x': 1, 'y': 2}).keys()) == {'x', 'y'}
assert set(validator.validate_python({'x': 1, 'y': '2'}).keys()) == {'x', 'y'}
assert set(validator.validate_python({'x': '1', 'y': 2}).keys()) == {'x', 'y'}
assert set(validator.validate_python({'x': '1', 'y': '2'}).keys()) == {'x', 'y'}
def test_smart_union_does_nested_model_field_counting() -> None:
class SubModelA:
x: int = 1
class SubModelB:
y: int = 2
class ModelA:
sub: SubModelA
class ModelB:
sub: SubModelB
model_a_schema = core_schema.model_schema(
ModelA,
core_schema.model_fields_schema(
fields={
'sub': core_schema.model_field(
core_schema.model_schema(
SubModelA,
core_schema.model_fields_schema(
fields={
'x': core_schema.model_field(
core_schema.with_default_schema(core_schema.int_schema(), default=1)
)
}
),
)
)
}
),
)
model_b_schema = core_schema.model_schema(
ModelB,
core_schema.model_fields_schema(
fields={
'sub': core_schema.model_field(
core_schema.model_schema(
SubModelB,
core_schema.model_fields_schema(
fields={
'y': core_schema.model_field(
core_schema.with_default_schema(core_schema.int_schema(), default=2)
)
}
),
)
)
}
),
)
for choices in permute_choices([model_a_schema, model_b_schema]):
validator = SchemaValidator(core_schema.union_schema(choices=choices))
assert isinstance(validator.validate_python({'sub': {'x': 1}}), ModelA)
assert isinstance(validator.validate_python({'sub': {'y': 3}}), ModelB)
# defaults to leftmost choice if there's a tie
assert isinstance(validator.validate_python({'sub': {}}), choices[0]['cls'])
def test_smart_union_does_nested_dataclass_field_counting() -> None:
@dataclass
class SubModelA:
x: int = 1
@dataclass
class SubModelB:
y: int = 2
@dataclass
class ModelA:
sub: SubModelA
@dataclass
class ModelB:
sub: SubModelB
dc_a_schema = core_schema.dataclass_schema(
ModelA,
core_schema.dataclass_args_schema(
'ModelA',
[
core_schema.dataclass_field(
'sub',
core_schema.with_default_schema(
core_schema.dataclass_schema(
SubModelA,
core_schema.dataclass_args_schema(
'SubModelA',
[
core_schema.dataclass_field(
'x', core_schema.with_default_schema(core_schema.int_schema(), default=1)
)
],
),
['x'],
),
default=SubModelA(),
),
)
],
),
['sub'],
)
dc_b_schema = core_schema.dataclass_schema(
ModelB,
core_schema.dataclass_args_schema(
'ModelB',
[
core_schema.dataclass_field(
'sub',
core_schema.with_default_schema(
core_schema.dataclass_schema(
SubModelB,
core_schema.dataclass_args_schema(
'SubModelB',
[
core_schema.dataclass_field(
'y', core_schema.with_default_schema(core_schema.int_schema(), default=2)
)
],
),
['y'],
),
default=SubModelB(),
),
)
],
),
['sub'],
)
for choices in permute_choices([dc_a_schema, dc_b_schema]):
validator = SchemaValidator(core_schema.union_schema(choices=choices))
assert isinstance(validator.validate_python({'sub': {'x': 1}}), ModelA)
assert isinstance(validator.validate_python({'sub': {'y': 3}}), ModelB)
# defaults to leftmost choice if there's a tie
assert isinstance(validator.validate_python({'sub': {}}), choices[0]['cls'])
def test_smart_union_does_nested_typed_dict_field_counting() -> None:
td_a_schema = core_schema.typed_dict_schema(
fields={
'sub': core_schema.typed_dict_field(
core_schema.typed_dict_schema(fields={'x': core_schema.typed_dict_field(core_schema.int_schema())})
)
}
)
td_b_schema = core_schema.typed_dict_schema(
fields={
'sub': core_schema.typed_dict_field(
core_schema.typed_dict_schema(fields={'y': core_schema.typed_dict_field(core_schema.int_schema())})
)
}
)
for choices in permute_choices([td_a_schema, td_b_schema]):
validator = SchemaValidator(core_schema.union_schema(choices=choices))
assert set(validator.validate_python({'sub': {'x': 1}})['sub'].keys()) == {'x'}
assert set(validator.validate_python({'sub': {'y': 2}})['sub'].keys()) == {'y'}
def test_nested_unions_bubble_up_field_count() -> None:
class SubModelX:
x1: int = 0
x2: int = 0
x3: int = 0
class SubModelY:
x1: int = 0
x2: int = 0
x3: int = 0
class SubModelZ:
z1: int = 0
z2: int = 0
z3: int = 0
class SubModelW:
w1: int = 0
w2: int = 0
w3: int = 0
class ModelA:
a: Union[SubModelX, SubModelY]
class ModelB:
b: Union[SubModelZ, SubModelW]
model_x_schema = core_schema.model_schema(
SubModelX,
core_schema.model_fields_schema(
fields={
'x1': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'x2': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'x3': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
}
),
)
model_y_schema = core_schema.model_schema(
SubModelY,
core_schema.model_fields_schema(
fields={
'x1': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'x2': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'x3': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
}
),
)
model_z_schema = core_schema.model_schema(
SubModelZ,
core_schema.model_fields_schema(
fields={
'z1': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'z2': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'z3': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
}
),
)
model_w_schema = core_schema.model_schema(
SubModelW,
core_schema.model_fields_schema(
fields={
'w1': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'w2': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
'w3': core_schema.model_field(core_schema.with_default_schema(core_schema.int_schema(), default=0)),
}
),
)
model_a_schema_options = [
core_schema.union_schema([model_x_schema, model_y_schema]),
core_schema.union_schema([model_y_schema, model_x_schema]),
]
model_b_schema_options = [
core_schema.union_schema([model_z_schema, model_w_schema]),
core_schema.union_schema([model_w_schema, model_z_schema]),
]
for model_a_schema in model_a_schema_options:
for model_b_schema in model_b_schema_options:
validator = SchemaValidator(
schema=core_schema.union_schema(
[
core_schema.model_schema(
ModelA,
core_schema.model_fields_schema(fields={'a': core_schema.model_field(model_a_schema)}),
),
core_schema.model_schema(
ModelB,
core_schema.model_fields_schema(fields={'b': core_schema.model_field(model_b_schema)}),
),
]
)
)
result = validator.validate_python(
{'a': {'x1': 1, 'x2': 2, 'y1': 1, 'y2': 2}, 'b': {'w1': 1, 'w2': 2, 'w3': 3}}
)
assert isinstance(result, ModelB)
assert isinstance(result.b, SubModelW)
@pytest.mark.parametrize('extra_behavior', ['forbid', 'ignore', 'allow'])
def test_smart_union_extra_behavior(extra_behavior) -> None:
class Foo:
foo: str = 'foo'
class Bar:
bar: str = 'bar'
class Model:
x: Union[Foo, Bar]
validator = SchemaValidator(
core_schema.model_schema(
Model,
core_schema.model_fields_schema(
fields={
'x': core_schema.model_field(
core_schema.union_schema(
[
core_schema.model_schema(
Foo,
core_schema.model_fields_schema(
fields={
'foo': core_schema.model_field(
core_schema.with_default_schema(core_schema.str_schema(), default='foo')
)
}
),
extra_behavior=extra_behavior,
),
core_schema.model_schema(
Bar,
core_schema.model_fields_schema(
fields={
'bar': core_schema.model_field(
core_schema.with_default_schema(core_schema.str_schema(), default='bar')
)
}
),
extra_behavior=extra_behavior,
),
]
)
)
}
),
)
)
assert isinstance(validator.validate_python({'x': {'foo': 'foo'}}).x, Foo)
assert isinstance(validator.validate_python({'x': {'bar': 'bar'}}).x, Bar)
def test_smart_union_wrap_validator_should_not_change_nested_model_field_counts() -> None:
"""Adding a wrap validator on a union member should not affect smart union behavior"""
class SubModel:
x: str = 'x'
class ModelA:
type: str = 'A'
sub: SubModel
class ModelB:
type: str = 'B'
sub: SubModel
submodel_schema = core_schema.model_schema(
SubModel,
core_schema.model_fields_schema(fields={'x': core_schema.model_field(core_schema.str_schema())}),
)
wrapped_submodel_schema = core_schema.no_info_wrap_validator_function(
lambda v, handler: handler(v), submodel_schema
)
model_a_schema = core_schema.model_schema(
ModelA,
core_schema.model_fields_schema(
fields={
'type': core_schema.model_field(
core_schema.with_default_schema(core_schema.literal_schema(['A']), default='A'),
),
'sub': core_schema.model_field(wrapped_submodel_schema),
},
),
)
model_b_schema = core_schema.model_schema(
ModelB,
core_schema.model_fields_schema(
fields={
'type': core_schema.model_field(
core_schema.with_default_schema(core_schema.literal_schema(['B']), default='B'),
),
'sub': core_schema.model_field(submodel_schema),
},
),
)
for choices in permute_choices([model_a_schema, model_b_schema]):
schema = core_schema.union_schema(choices)
validator = SchemaValidator(schema)
assert isinstance(validator.validate_python({'type': 'A', 'sub': {'x': 'x'}}), ModelA)
assert isinstance(validator.validate_python({'type': 'B', 'sub': {'x': 'x'}}), ModelB)
# defaults to leftmost choice if there's a tie
assert isinstance(validator.validate_python({'sub': {'x': 'x'}}), choices[0]['cls'])
# test validate_assignment
class RootModel:
ab: Union[ModelA, ModelB]
root_model = core_schema.model_schema(
RootModel,
core_schema.model_fields_schema(
fields={'ab': core_schema.model_field(core_schema.union_schema([model_a_schema, model_b_schema]))}
),
)
validator = SchemaValidator(root_model)
m = validator.validate_python({'ab': {'type': 'B', 'sub': {'x': 'x'}}})
assert isinstance(m, RootModel)
assert isinstance(m.ab, ModelB)
assert m.ab.sub.x == 'x'
m = validator.validate_assignment(m, 'ab', {'sub': {'x': 'y'}})
assert isinstance(m, RootModel)
assert isinstance(m.ab, ModelA)
assert m.ab.sub.x == 'y'
|