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 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import base64
from datetime import date, datetime, time, timedelta, tzinfo
from enum import Enum
import json
import sys
import traceback
from typing import Any, Dict, List, Optional, Union, Type
from io import BytesIO
from azure.core.serialization import AzureJSONEncoder, NULL, as_attribute_dict, is_generated_model, attribute_list
from azure.core.exceptions import DeserializationError
import pytest
from modeltypes._utils.model_base import (
Model as HybridModel,
SdkJSONEncoder,
rest_field,
TYPE_HANDLER_REGISTRY,
_deserialize,
)
from modeltypes._utils.serialization import Model as MsrestModel
from modeltypes import models
def _expand_value(obj):
try:
try:
return obj.to_dict()
except AttributeError:
if isinstance(obj, Enum):
return obj.value
elif isinstance(obj, list):
return [_expand_value(item) for item in obj]
elif isinstance(obj, dict):
return _expand_dict(obj)
else:
return _expand_dict(vars(obj))
except TypeError:
return obj
def _expand_dict(d):
return dict((key, _expand_value(value)) for key, value in d.items())
class DatetimeSubclass(datetime):
"""datetime.datetime subclass that tests datetimes without a type() of datetime.datetime"""
class SerializerMixin(object):
"""Mixin that provides methods for representing a model as a dictionary"""
def to_dict(self):
return _expand_value(vars(self))
class NegativeUtcOffset(tzinfo):
"""tzinfo class with UTC offset of -12 hours"""
_offset = timedelta(seconds=-43200)
_dst = timedelta(0)
_name = "-1200"
def utcoffset(self, dt):
return self.__class__._offset
def dst(self, dt):
return self.__class__._dst
def tzname(self, dt):
return self.__class__._name
class PositiveUtcOffset(tzinfo):
"""tzinfo class with UTC offset of +12 hours"""
_offset = timedelta(seconds=43200)
_dst = timedelta(0)
_name = "+1200"
def utcoffset(self, dt):
return self.__class__._offset
def dst(self, dt):
return self.__class__._dst
def tzname(self, dt):
return self.__class__._name
def test_NULL_is_falsy():
assert NULL is not False
assert bool(NULL) is False
assert NULL is NULL
@pytest.fixture
def json_dumps_with_encoder():
def func(obj):
return json.dumps(obj, cls=AzureJSONEncoder)
return func
def test_bytes(json_dumps_with_encoder):
test_bytes = b"mybytes"
result = json.loads(json_dumps_with_encoder(test_bytes))
assert base64.b64decode(result) == test_bytes
def test_byte_array_ascii(json_dumps_with_encoder):
test_byte_array = bytearray("mybytes", "ascii")
result = json.loads(json_dumps_with_encoder(test_byte_array))
assert base64.b64decode(result) == test_byte_array
def test_byte_array_utf8(json_dumps_with_encoder):
test_byte_array = bytearray("mybytes", "utf-8")
result = json.loads(json_dumps_with_encoder(test_byte_array))
assert base64.b64decode(result) == test_byte_array
def test_byte_array_utf16(json_dumps_with_encoder):
test_byte_array = bytearray("mybytes", "utf-16")
result = json.loads(json_dumps_with_encoder(test_byte_array))
assert base64.b64decode(result) == test_byte_array
def test_dictionary_basic(json_dumps_with_encoder):
test_obj = {
"string": "myid",
"number": 42,
"boolean": True,
"list_of_string": [1, 2, 3],
"dictionary_of_number": {"pi": 3.14},
}
complex_serialized = json_dumps_with_encoder(test_obj)
assert json.dumps(test_obj) == complex_serialized
assert json.loads(complex_serialized) == test_obj
def test_model_basic(json_dumps_with_encoder):
class BasicModel(SerializerMixin):
def __init__(self):
self.string = "myid"
self.number = 42
self.boolean = True
self.list_of_ints = [1, 2, 3]
self.dictionary_of_number = {"pi": 3.14}
self.bytes_data = b"data as bytes"
expected = BasicModel()
expected_bytes = "data as bytes" if sys.version_info.major == 2 else "ZGF0YSBhcyBieXRlcw==" # cspell:disable-line
expected_dict = {
"string": "myid",
"number": 42,
"boolean": True,
"list_of_ints": [1, 2, 3],
"dictionary_of_number": {"pi": 3.14},
"bytes_data": expected_bytes,
}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_dictionary_datetime(json_dumps_with_encoder):
test_obj = {
"timedelta": timedelta(1),
"date": date(2021, 5, 12),
"datetime": datetime.strptime("2012-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ"),
"time": time(11, 12, 13),
}
expected = {
"timedelta": "P1DT00H00M00S",
"date": "2021-05-12",
"datetime": "2012-02-24T00:53:52.780000Z",
"time": "11:12:13",
}
assert json.loads(json_dumps_with_encoder(test_obj)) == expected
def test_model_datetime(json_dumps_with_encoder):
class DatetimeModel(SerializerMixin):
def __init__(self):
self.timedelta = timedelta(1)
self.date = date(2021, 5, 12)
self.datetime = datetime.strptime("2012-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
self.time = time(11, 12, 13)
expected = DatetimeModel()
expected_dict = {
"timedelta": "P1DT00H00M00S",
"date": "2021-05-12",
"datetime": "2012-02-24T00:53:52.780000Z",
"time": "11:12:13",
}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_model_key_vault(json_dumps_with_encoder):
class Attributes(SerializerMixin):
def __init__(self):
self.enabled = True
self.not_before = datetime.strptime("2012-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
self.expires = datetime.strptime("2032-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
self.created = datetime.strptime("2020-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
self.updated = datetime.strptime("2021-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
class ResourceId(SerializerMixin):
def __init__(self):
self.source_id = "source-id"
self.vault_url = "vault-url"
self.name = "name"
self.version = None
class Identifier(SerializerMixin):
def __init__(self):
self._resource_id = ResourceId()
class Properties(SerializerMixin):
def __init__(self):
self._attributes = Attributes()
self._id = "id"
self._vault_id = Identifier()
self._thumbprint = b"thumbprint bytes"
self._tags = None
expected = Properties()
expected_bytes = (
"thumbprint bytes" if sys.version_info.major == 2 else "dGh1bWJwcmludCBieXRlcw=="
) # cspell:disable-line
expected_dict = {
"_attributes": {
"enabled": True,
"not_before": "2012-02-24T00:53:52.780000Z",
"expires": "2032-02-24T00:53:52.780000Z",
"created": "2020-02-24T00:53:52.780000Z",
"updated": "2021-02-24T00:53:52.780000Z",
},
"_id": "id",
"_vault_id": {
"_resource_id": {
"source_id": "source-id",
"vault_url": "vault-url",
"name": "name",
"version": None,
},
},
"_thumbprint": expected_bytes,
"_tags": None,
}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_serialize_datetime(json_dumps_with_encoder):
date_obj = datetime.strptime("2015-01-01T00:00:00", "%Y-%m-%dT%H:%M:%S")
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"2015-01-01T00:00:00Z"'
date_obj = datetime.strptime("1999-12-31T23:59:59", "%Y-%m-%dT%H:%M:%S").replace(tzinfo=NegativeUtcOffset())
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"2000-01-01T11:59:59Z"'
date_obj = datetime.strptime("2015-06-01T16:10:08.0121", "%Y-%m-%dT%H:%M:%S.%f").replace(tzinfo=PositiveUtcOffset())
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"2015-06-01T04:10:08.012100Z"'
date_obj = datetime.min
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"0001-01-01T00:00:00Z"'
date_obj = datetime.max
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"9999-12-31T23:59:59.999999Z"'
date_obj = datetime.strptime("2012-02-24T00:53:52.000001Z", "%Y-%m-%dT%H:%M:%S.%fZ")
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"2012-02-24T00:53:52.000001Z"'
date_obj = datetime.strptime("2012-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"2012-02-24T00:53:52.780000Z"'
def test_serialize_datetime_subclass(json_dumps_with_encoder):
date_obj = DatetimeSubclass.strptime("2012-02-24T00:53:52.780Z", "%Y-%m-%dT%H:%M:%S.%fZ")
date_str = json_dumps_with_encoder(date_obj)
assert date_str == '"2012-02-24T00:53:52.780000Z"'
def test_serialize_time(json_dumps_with_encoder):
time_str = json_dumps_with_encoder(time(11, 22, 33))
assert time_str == '"11:22:33"'
time_str = json_dumps_with_encoder(time(11, 22, 33, 444444))
assert time_str == '"11:22:33.444444"'
class BasicEnum(Enum):
val = "Basic"
class StringEnum(str, Enum):
val = "string"
class IntEnum(int, Enum):
val = 1
class FloatEnum(float, Enum):
val = 1.5
def test_dictionary_enum(json_dumps_with_encoder):
test_obj = {"basic": BasicEnum.val}
with pytest.raises(TypeError):
json_dumps_with_encoder(test_obj)
test_obj = {
"basic": BasicEnum.val.value,
"string": StringEnum.val.value,
"int": IntEnum.val.value,
"float": FloatEnum.val.value,
}
expected = {"basic": "Basic", "string": "string", "int": 1, "float": 1.5}
serialized = json_dumps_with_encoder(test_obj)
assert json.dumps(test_obj) == serialized
assert json.loads(serialized) == expected
def test_model_enum(json_dumps_with_encoder):
class BasicEnumModel:
def __init__(self):
self.basic = BasicEnum.val
with pytest.raises(TypeError):
json_dumps_with_encoder(BasicEnumModel())
class EnumModel(SerializerMixin):
def __init__(self):
self.basic = BasicEnum.val.value
self.string = StringEnum.val
self.int = IntEnum.val
self.float = FloatEnum.val
expected = EnumModel()
expected_dict = {"basic": "Basic", "string": "string", "int": 1, "float": 1.5}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_dictionary_none(json_dumps_with_encoder):
assert json_dumps_with_encoder(None) == json.dumps(None)
test_obj = {"entry": None}
assert json.loads(json_dumps_with_encoder(test_obj)) == test_obj
def test_model_none(json_dumps_with_encoder):
class NoneModel(SerializerMixin):
def __init__(self):
self.entry = None
expected = NoneModel()
expected_dict = {"entry": None}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_dictionary_empty_collections(json_dumps_with_encoder):
test_obj = {
"dictionary": {},
"list": [],
}
assert json.dumps(test_obj) == json_dumps_with_encoder(test_obj)
assert json.loads(json_dumps_with_encoder(test_obj)) == test_obj
def test_model_empty_collections(json_dumps_with_encoder):
class EmptyCollectionsModel(SerializerMixin):
def __init__(self):
self.dictionary = {}
self.list = []
expected = EmptyCollectionsModel()
expected_dict = {
"dictionary": {},
"list": [],
}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_model_inheritance(json_dumps_with_encoder):
class ParentModel(SerializerMixin):
def __init__(self):
self.parent = "parent"
class ChildModel(ParentModel):
def __init__(self):
super(ChildModel, self).__init__()
self.child = "child"
expected = ChildModel()
expected_dict = {
"parent": "parent",
"child": "child",
}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_model_recursion(json_dumps_with_encoder):
class RecursiveModel(SerializerMixin):
def __init__(self):
self.name = "it's me!"
self.list_of_me = None
self.dict_of_me = None
self.dict_of_list_of_me = None
self.list_of_dict_of_me = None
expected = RecursiveModel()
expected.list_of_me = [RecursiveModel()]
expected.dict_of_me = {"me": RecursiveModel()}
expected.dict_of_list_of_me = {"many mes": [RecursiveModel()]}
expected.list_of_dict_of_me = [{"me": RecursiveModel()}]
expected_dict = {
"name": "it's me!",
"list_of_me": [
{
"name": "it's me!",
"list_of_me": None,
"dict_of_me": None,
"dict_of_list_of_me": None,
"list_of_dict_of_me": None,
}
],
"dict_of_me": {
"me": {
"name": "it's me!",
"list_of_me": None,
"dict_of_me": None,
"dict_of_list_of_me": None,
"list_of_dict_of_me": None,
}
},
"dict_of_list_of_me": {
"many mes": [
{
"name": "it's me!",
"list_of_me": None,
"dict_of_me": None,
"dict_of_list_of_me": None,
"list_of_dict_of_me": None,
}
]
},
"list_of_dict_of_me": [
{
"me": {
"name": "it's me!",
"list_of_me": None,
"dict_of_me": None,
"dict_of_list_of_me": None,
"list_of_dict_of_me": None,
}
}
],
}
assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
def test_json_roundtrip():
dict_response = {
"name": "wall-e",
"species": "dog",
}
model = models.HybridPet(
name="wall-e",
species="dog",
)
with pytest.raises(TypeError):
json.dumps(model)
assert json.dumps(dict(model)) == '{"name": "wall-e", "species": "dog"}'
assert json.loads(json.dumps(dict(model))) == model == dict_response
def test_flattened_model():
def _test(result):
assert result["name"] == "wall-e"
assert result["description"] == "a dog"
assert result["age"] == 2
assert "properties" not in result
assert "modelDescription" not in result
assert "model_description" not in result
model = models.FlattenModel(name="wall-e", description="a dog", age=2)
_test(as_attribute_dict(model))
model = models.FlattenModel({"name": "wall-e", "properties": {"modelDescription": "a dog", "age": 2}})
_test(as_attribute_dict(model))
def test_client_name_model():
model = models.ClientNameAndJsonEncodedNameModel(client_name="wall-e")
assert model.client_name == "wall-e"
assert model["wireName"] == "wall-e"
model = models.ClientNameAndJsonEncodedNameModel({"wireName": "wall-e"})
assert model.client_name == "wall-e"
assert model["wireName"] == "wall-e"
def test_readonly():
model = models.ReadonlyModel({"id": 1})
assert model.id == 1
assert model.as_dict() == {"id": 1}
assert model.as_dict(exclude_readonly=True) == {}
def test_as_attribute_dict_scratch():
model = models.Scratch(prop="test")
assert as_attribute_dict(model) == {"prop": "test"}
def test_is_generated_model_with_hybrid_model():
assert is_generated_model(HybridModel())
assert is_generated_model(models.FlattenModel({"name": "wall-e", "properties": {"description": "a dog", "age": 2}}))
assert is_generated_model(models.ClientNameAndJsonEncodedNameModel(client_name="wall-e"))
assert is_generated_model(models.ReadonlyModel())
def test_is_generated_model_with_msrest_model():
assert is_generated_model(models.MsrestPet(name="wall-e", species="dog"))
def test_is_generated_model_with_non_models():
assert not is_generated_model({})
assert not is_generated_model([])
assert not is_generated_model("string")
assert not is_generated_model(42)
assert not is_generated_model(None)
assert not is_generated_model(object)
class Model:
def __init__(self):
self.attr = "value"
assert not is_generated_model(Model())
def test_attribute_list_non_model():
with pytest.raises(TypeError):
attribute_list({})
with pytest.raises(TypeError):
attribute_list([])
with pytest.raises(TypeError):
attribute_list("string")
with pytest.raises(TypeError):
attribute_list(42)
with pytest.raises(TypeError):
attribute_list(None)
with pytest.raises(TypeError):
attribute_list(object)
class RandomModel:
def __init__(self):
self.attr = "value"
with pytest.raises(TypeError):
attribute_list(RandomModel())
def test_attribute_list_scratch_model():
model = models.HybridPet(name="wall-e", species="dog")
assert attribute_list(model) == ["name", "species"]
msrest_model = models.MsrestPet(name="wall-e", species="dog")
assert attribute_list(msrest_model) == ["name", "species"]
def test_attribute_list_client_named_property_model():
model = models.ClientNameAndJsonEncodedNameModel(client_name="wall-e")
assert attribute_list(model) == ["client_name"]
msrest_model = models.MsrestClientNameAndJsonEncodedNameModel(client_name="wall-e")
assert attribute_list(msrest_model) == ["client_name"]
def test_attribute_list_flattened_model():
model = models.FlattenModel(name="wall-e", description="a dog", age=2)
assert attribute_list(model) == ["name", "description", "age"]
msrest_model = models.MsrestFlattenModel(name="wall-e", description="a dog", age=2)
assert attribute_list(msrest_model) == ["name", "description", "age"]
def test_attribute_list_readonly_model():
model = models.ReadonlyModel({"id": 1})
assert attribute_list(model) == ["id"]
msrest_model = models.MsrestReadonlyModel(id=1)
assert attribute_list(msrest_model) == ["id"]
def test_attribute_list_additional_properties_hybrid():
hybrid_model = models.HybridPetAPTrue(
{"birthdate": "2017-12-13T02:29:51Z", "complexProperty": {"color": "Red"}, "name": "Buddy"}
)
assert attribute_list(hybrid_model) == ["name"]
def test_attribute_list_additional_properties_msrest():
msrest_model = models.MsrestPetAPTrue(
additional_properties={"birthdate": "2017-12-13T02:29:51Z", "complexProperty": {"color": "Red"}}, name="Buddy"
)
assert attribute_list(msrest_model) == ["additional_properties", "name"]
def test_as_attribute_dict_client_name():
model = models.ClientNameAndJsonEncodedNameModel(client_name="wall-e")
assert model.as_dict() == {"wireName": "wall-e"}
assert as_attribute_dict(model) == {"client_name": "wall-e"}
def test_as_attribute_dict_nested_models():
def _test(result):
assert result["name"] == "Jane Doe"
assert result["home_address"]["street"] == "123 Home St"
assert result["home_address"]["city"] == "Hometown"
assert result["home_address"]["zip_code"] == "12345"
assert result["work_address"]["street"] == "456 Work Ave"
assert result["work_address"]["city"] == "Workville"
assert result["work_address"]["zip_code"] == "67890"
hybrid_home = models.HybridAddress(street="123 Home St", city="Hometown", zip_code="12345")
hybrid_work = models.HybridAddress(street="456 Work Ave", city="Workville", zip_code="67890")
hybrid_person = models.HybridPerson(name="Jane Doe", home_address=hybrid_home, work_address=hybrid_work)
_test(as_attribute_dict(hybrid_person))
msrest_home = models.MsrestAddress(street="123 Home St", city="Hometown", zip_code="12345")
msrest_work = models.MsrestAddress(street="456 Work Ave", city="Workville", zip_code="67890")
msrest_person = models.MsrestPerson(name="Jane Doe", home_address=msrest_home, work_address=msrest_work)
_test(as_attribute_dict(msrest_person))
def test_as_attribute_dict_wire_name_differences():
def _test(result):
assert result["product_id"] == "p123"
assert result["product_name"] == "Widget"
assert result["unit_price"] == 19.99
assert result["stock_count"] == 42
hybrid_product = models.HybridProduct(product_id="p123", product_name="Widget", unit_price=19.99, stock_count=42)
assert hybrid_product["productId"] == "p123"
assert hybrid_product["ProductName"] == "Widget"
assert hybrid_product["unit-price"] == 19.99
assert hybrid_product["stock_count"] == 42
_test(as_attribute_dict(hybrid_product))
msrest_product = models.MsrestProduct(product_id="p123", product_name="Widget", unit_price=19.99, stock_count=42)
_test(as_attribute_dict(msrest_product))
def test_as_attribute_dict_datetime_serialization():
def _test(result):
assert result["event_id"] == "e789"
assert isinstance(result["start_time"], str)
# TODO: chase why there are serialization diffs
assert result["start_time"] in ["2023-05-15T09:00:00Z", "2023-05-15T09:00:00.000Z"]
assert result["end_time"] in ["2023-05-15T10:30:00Z", "2023-05-15T10:30:00.000Z"]
assert result["created_date"] == "2023-05-01"
assert result["reminder_time"] == "08:45:00"
assert result["duration"] in ["PT1H30M", "PT01H30M00S"] # Duration can be represented in different ways
hybrid_event = models.HybridEvent(
event_id="e789",
start_time=datetime(2023, 5, 15, 9, 0, 0),
end_time=datetime(2023, 5, 15, 10, 30, 0),
created_date=date(2023, 5, 1),
reminder_time=time(8, 45, 0),
duration=timedelta(hours=1, minutes=30),
)
_test(as_attribute_dict(hybrid_event))
msrest_event = models.MsrestEvent(
event_id="e789",
start_time=datetime(2023, 5, 15, 9, 0, 0),
end_time=datetime(2023, 5, 15, 10, 30, 0),
created_date=date(2023, 5, 1),
reminder_time=time(8, 45, 0),
duration=timedelta(hours=1, minutes=30),
)
_test(as_attribute_dict(msrest_event))
def test_as_attribute_dict_readonly():
def _test_all(result):
assert result["id"] == "r456"
assert result["name"] == "My Resource"
assert result["description"] == "A test resource"
def _test_exclude_readonly(result):
assert "id" not in result
assert result["name"] == "My Resource"
assert result["description"] == "A test resource"
hybrid_resource = models.HybridResource(id="r456", name="My Resource", description="A test resource")
# Should include all properties
_test_all(as_attribute_dict(hybrid_resource))
# Should exclude readonly properties
_test_exclude_readonly(as_attribute_dict(hybrid_resource, exclude_readonly=True))
msrest_resource = models.MsrestResource(name="My Resource", description="A test resource")
msrest_resource.id = "r456" # Manually set the readonly property for testing
# Should include all properties
_test_all(as_attribute_dict(msrest_resource))
# Should exclude readonly properties
_test_exclude_readonly(as_attribute_dict(msrest_resource, exclude_readonly=True))
def test_as_attribute_dict_collections():
def _test(result):
assert result["name"] == "Tagged Resource"
assert len(result["tags"]) == 2
assert result["tags"][0]["key"] == "env"
assert result["tags"][0]["value"] == "prod"
assert result["tags"][1]["key"] == "dept"
assert result["tags"][1]["value"] == "finance"
assert result["metadata"]["created_by"] == "admin"
assert result["metadata"]["priority"] == "high"
assert result["string_list"] == ["a", "b", "c"]
assert result["int_list"] == [1, 2, 3]
hybrid_tags = [models.HybridTag(key="env", value="prod"), models.HybridTag(key="dept", value="finance")]
hybrid_resource = models.HybridTaggedResource(
name="Tagged Resource",
tags=hybrid_tags,
metadata={"created_by": "admin", "priority": "high"},
string_list=["a", "b", "c"],
int_list=[1, 2, 3],
)
_test(as_attribute_dict(hybrid_resource))
msrest_tags = [models.MsrestTag(key="env", value="prod"), models.MsrestTag(key="dept", value="finance")]
msrest_resource = models.MsrestTaggedResource(
name="Tagged Resource",
tags=msrest_tags,
metadata={"created_by": "admin", "priority": "high"},
string_list=["a", "b", "c"],
int_list=[1, 2, 3],
)
_test(as_attribute_dict(msrest_resource))
def test_as_attribute_dict_inheritance():
def _test(result):
assert result["name"] == "Wall-E"
assert result["species"] == "dog"
assert result["breed"] == "Pitbull"
assert result["is_best_boy"] is True
hybrid_dog = models.HybridDog(name="Wall-E", species="dog", breed="Pitbull", is_best_boy=True)
_test(as_attribute_dict(hybrid_dog))
msrest_dog = models.MsrestDog(name="Wall-E", species="dog", breed="Pitbull", is_best_boy=True)
_test(as_attribute_dict(msrest_dog))
def test_as_attribute_dict_multipart_file():
file_data = BytesIO(b"This is test file content")
upload = models.FileUpload(name="test.txt", content=file_data, content_type="text/plain")
attr_dict = as_attribute_dict(upload)
assert attr_dict["name"] == "test.txt"
assert attr_dict["content"] is file_data # Should be preserved as-is for multipart files
assert attr_dict["content_type"] == "text/plain"
def test_as_attribute_dict_with_null_object():
def _test_non_nested(result):
assert result["required_prop"] == "always here"
assert "optional_prop" not in result
assert "optional_model" not in result
def _test_nested(result):
assert result["required_prop"] == "outer"
assert "optional_prop" not in result
assert result["optional_model"]["required_prop"] == "nested"
assert result["optional_model"]["optional_prop"] == "present"
assert "optional_model" not in result["optional_model"]
hybrid_model = models.HybridOptionalProps(required_prop="always here", optional_prop=None, optional_model=None)
_test_non_nested(as_attribute_dict(hybrid_model))
msrest_model = models.MsrestOptionalProps(required_prop="always here", optional_prop=None, optional_model=None)
_test_non_nested(as_attribute_dict(msrest_model))
# Test with a nested model that has a null property
hybrid_nested = models.HybridOptionalProps(required_prop="nested", optional_prop="present", optional_model=None)
hybrid_model = models.HybridOptionalProps(required_prop="outer", optional_prop=None, optional_model=hybrid_nested)
_test_nested(as_attribute_dict(hybrid_model))
msrest_nested = models.MsrestOptionalProps(required_prop="nested", optional_prop="present", optional_model=None)
msrest_model = models.MsrestOptionalProps(required_prop="outer", optional_prop=None, optional_model=msrest_nested)
_test_nested(as_attribute_dict(msrest_model))
def test_as_attribute_dict_nested_discriminators():
salmon = models.Salmon(
{
"age": 1,
"kind": "salmon",
"lifePartner": {"age": 2, "kind": "shark", "sharkType": "saw"},
"friends": [
{
"age": 2,
"kind": "salmon",
"lifePartner": {"age": 3, "kind": "salmon"},
"hate": {
"key1": {"age": 4, "kind": "salmon"},
"key2": {"age": 2, "kind": "shark", "sharkType": "goblin"},
},
},
{"age": 3, "kind": "shark", "sharkType": "goblin"},
],
"hate": {
"key3": {"age": 3, "kind": "shark", "sharkType": "saw"},
"key4": {
"age": 2,
"kind": "salmon",
"friends": [
{"age": 1, "kind": "salmon"},
{"age": 4, "kind": "shark", "sharkType": "goblin"},
],
},
},
}
)
attr_dict = as_attribute_dict(salmon)
assert attr_dict["age"] == 1
assert attr_dict["kind"] == "salmon"
assert attr_dict["life_partner"]["age"] == 2
assert attr_dict["life_partner"]["kind"] == "shark"
assert attr_dict["life_partner"]["shark_type"] == "saw"
assert len(attr_dict["friends"]) == 2
assert attr_dict["friends"][0]["age"] == 2
assert attr_dict["friends"][0]["kind"] == "salmon"
assert attr_dict["friends"][0]["life_partner"]["age"] == 3
assert attr_dict["friends"][0]["life_partner"]["kind"] == "salmon"
assert len(attr_dict["friends"][0]["hate"]) == 2
assert attr_dict["friends"][0]["hate"]["key1"]["age"] == 4
assert attr_dict["friends"][0]["hate"]["key1"]["kind"] == "salmon"
assert attr_dict["friends"][0]["hate"]["key2"]["age"] == 2
assert attr_dict["friends"][0]["hate"]["key2"]["kind"] == "shark"
assert attr_dict["friends"][0]["hate"]["key2"]["shark_type"] == "goblin"
def test_as_attribute_dict_complex_scenario():
def _test(result):
# Verify top-level properties
assert result["employee_id"] == "E12345"
assert result["first_name"] == "Jane"
assert result["last_name"] == "Doe"
assert result["hire_date"] == "2020-03-15"
# Verify nested contact info
assert result["contact"]["email"] == "jane.doe@example.com"
assert result["contact"]["phone"] == "555-123-4567"
# Verify list of address objects
assert len(result["contact"]["addresses"]) == 2
assert result["contact"]["addresses"][0]["street"] == "123 Home St"
assert result["contact"]["addresses"][0]["city"] == "Hometown"
assert result["contact"]["addresses"][0]["zip_code"] == "12345"
# Verify department
assert result["department"]["name"] == "Engineering"
assert result["department"]["cost_center"] == "CC-ENG-123"
# Verify collections
assert result["skills"] == ["Python", "TypeScript", "Azure"]
assert result["performance_ratings"] == {"2020": 4.5, "2021": 4.7, "2022": 4.8}
# Create a complex employee object
hybrid_employee = models.HybridEmployee(
employee_id="E12345",
first_name="Jane",
last_name="Doe",
hire_date=date(2020, 3, 15),
contact=models.HybridContactInfo(
email="jane.doe@example.com",
phone="555-123-4567",
addresses=[
models.HybridAddress(street="123 Home St", city="Hometown", zip_code="12345"),
models.HybridAddress(street="456 Work Ave", city="Workville", zip_code="67890"),
],
),
department=models.HybridDepartment(name="Engineering", cost_center="CC-ENG-123"),
skills=["Python", "TypeScript", "Azure"],
performance_ratings={"2020": 4.5, "2021": 4.7, "2022": 4.8},
)
# Get full attribute dictionary
_test(as_attribute_dict(hybrid_employee))
# Now check with exclude_readonly=True
attr_dict = as_attribute_dict(hybrid_employee, exclude_readonly=True)
assert "employee_id" not in attr_dict
assert attr_dict["first_name"] == "Jane"
msrest_employee = models.MsrestEmployee(
employee_id="E12345",
first_name="Jane",
last_name="Doe",
hire_date=date(2020, 3, 15),
contact=models.MsrestContactInfo(
email="jane.doe@example.com",
phone="555-123-4567",
addresses=[
models.MsrestAddress(street="123 Home St", city="Hometown", zip_code="12345"),
models.MsrestAddress(street="456 Work Ave", city="Workville", zip_code="67890"),
],
),
department=models.MsrestDepartment(name="Engineering", cost_center="CC-ENG-123"),
skills=["Python", "TypeScript", "Azure"],
performance_ratings={"2020": 4.5, "2021": 4.7, "2022": 4.8},
)
_test(as_attribute_dict(msrest_employee))
# Now check with exclude_readonly=True
attr_dict = as_attribute_dict(msrest_employee, exclude_readonly=True)
assert "employee_id" not in attr_dict
assert attr_dict["first_name"] == "Jane"
def test_as_attribute_dict_flatten():
def _test(result):
assert result["name"] == "wall-e"
assert result["description"] == "a dog"
assert result["age"] == 2
assert "properties" not in result
assert "modelDescription" not in result
assert "model_description" not in result
hybrid_model = models.FlattenModel(name="wall-e", description="a dog", age=2)
msrest_model = models.MsrestFlattenModel(name="wall-e", description="a dog", age=2)
_test(as_attribute_dict(hybrid_model))
_test(as_attribute_dict(msrest_model))
def test_as_attribute_dict_additional_properties():
def _tests(model):
attr_dict = as_attribute_dict(model)
assert attr_dict["name"] == "Buddy"
assert "additional_properties" not in attr_dict
assert attr_dict["birthdate"] == "2017-12-13T02:29:51Z"
assert attr_dict["complexProperty"] == {"color": "Red"}
assert getattr(model, "birthdate", None) is None
assert getattr(model, "complexProperty", None) is None
hybrid_model = models.HybridPetAPTrue(
{"birthdate": "2017-12-13T02:29:51Z", "complexProperty": {"color": "Red"}, "name": "Buddy"}
)
assert getattr(hybrid_model, "additional_properties", None) is None
_tests(hybrid_model)
msrest_model = models.MsrestPetAPTrue(
additional_properties={"birthdate": "2017-12-13T02:29:51Z", "complexProperty": {"color": "Red"}}, name="Buddy"
)
_tests(msrest_model)
assert msrest_model.additional_properties == {
"birthdate": "2017-12-13T02:29:51Z",
"complexProperty": {"color": "Red"},
}
class TestTypeHandlerRegistry:
"""Test usage of the TypeHandlerRegistry with the model_base.py serialization/deserialization mechanisms."""
class FooModel:
foo: str
bar: int
baz: float
def __init__(self, foo: str, bar: int, baz: float):
self.foo = foo
self.bar = bar
self.baz = baz
def test_serialization_fails_no_registry(self):
model = TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14)
with pytest.raises(TypeError):
json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
def test_deserialize_no_registry(self):
json_dict = {"foo": "foo", "bar": 42, "baz": 3.14}
deserialized = _deserialize(TestTypeHandlerRegistry.FooModel, json_dict)
# If no deserializer is registered, the input should be returned as-is
assert deserialized == json_dict
assert type(deserialized) is dict
def test_serialize_external_model(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
model = TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14)
serializer = TYPE_HANDLER_REGISTRY.get_serializer(model)
assert serializer is foo_serializer
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == {"foo": "foo", "bar": 42, "baz": 3.14}
def test_serialize_external_model_manual_decorator(self):
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)(foo_serializer)
model = TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14)
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == {"foo": "foo", "bar": 42, "baz": 3.14}
def test_deserialize_external_model(self):
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
deserializer = TYPE_HANDLER_REGISTRY.get_deserializer(TestTypeHandlerRegistry.FooModel)
assert type(deserializer).__name__ == "partial"
assert getattr(deserializer, "func", None) is foo_deserializer
assert getattr(deserializer, "args", ()) == (TestTypeHandlerRegistry.FooModel,)
json_dict = {"foo": "foo", "bar": 42, "baz": 3.14}
deserialized = _deserialize(TestTypeHandlerRegistry.FooModel, json_dict)
assert isinstance(deserialized, TestTypeHandlerRegistry.FooModel)
assert deserialized.foo == "foo"
assert deserialized.bar == 42
assert deserialized.baz == 3.14
def test_deserialize_external_model_manual_decorator(self):
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)(foo_deserializer)
json_dict = {"foo": "foo", "bar": 42, "baz": 3.14}
deserialized = _deserialize(TestTypeHandlerRegistry.FooModel, json_dict)
assert isinstance(deserialized, TestTypeHandlerRegistry.FooModel)
assert deserialized.foo == "foo"
assert deserialized.bar == 42
assert deserialized.baz == 3.14
def test_serialize_external_model_in_nested_model(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
class GeneratedModel(HybridModel):
dog: models.HybridDog = rest_field(visibility=["read", "create", "update", "delete", "query"])
external: TestTypeHandlerRegistry.FooModel = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
model = GeneratedModel(
dog=models.HybridDog(name="doggy", species="dog", breed="samoyed", is_best_boy=True),
external=TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14),
)
expected_dict = {
"dog": {
"name": "doggy",
"species": "dog",
"breed": "samoyed",
"isBestBoy": True,
},
"external": {
"foo": "foo",
"bar": 42,
"baz": 3.14,
},
}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
def test_deserialize_external_model_in_nested_model(self):
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
class GeneratedModel(HybridModel):
dog: models.HybridDog = rest_field(visibility=["read", "create", "update", "delete", "query"])
external: TestTypeHandlerRegistry.FooModel = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
json_dict = {
"dog": {
"name": "doggy",
"species": "dog",
"breed": "samoyed",
"isBestBoy": True,
},
"external": {
"foo": "foo",
"bar": 42,
"baz": 3.14,
},
}
deserialized = _deserialize(GeneratedModel, json_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.dog, models.HybridDog)
assert isinstance(deserialized.external, TestTypeHandlerRegistry.FooModel)
assert deserialized.dog.name == "doggy"
assert deserialized.dog.species == "dog"
assert deserialized.dog.breed == "samoyed"
assert deserialized.dog.is_best_boy is True
assert deserialized.external.foo == "foo"
assert deserialized.external.bar == 42
assert deserialized.external.baz == 3.14
def test_serialize_deserialize_list_of_external_models(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
class GeneratedModel(HybridModel):
externals: List[TestTypeHandlerRegistry.FooModel] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
model = GeneratedModel(
externals=[
TestTypeHandlerRegistry.FooModel(foo="foo1", bar=1, baz=1.1),
TestTypeHandlerRegistry.FooModel(foo="foo2", bar=2, baz=2.2),
]
)
expected_dict = {
"externals": [
{"foo": "foo1", "bar": 1, "baz": 1.1},
{"foo": "foo2", "bar": 2, "baz": 2.2},
]
}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.externals, list)
assert len(deserialized.externals) == 2
assert all(isinstance(item, TestTypeHandlerRegistry.FooModel) for item in deserialized.externals)
assert deserialized.externals[0].foo == "foo1"
assert deserialized.externals[0].bar == 1
assert deserialized.externals[0].baz == 1.1
assert deserialized.externals[1].foo == "foo2"
assert deserialized.externals[1].bar == 2
assert deserialized.externals[1].baz == 2.2
def test_serialize_deserialize_dict_of_external_models(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
class GeneratedModel(HybridModel):
externals: Dict[str, TestTypeHandlerRegistry.FooModel] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
model = GeneratedModel(
externals={
"first": TestTypeHandlerRegistry.FooModel(foo="foo1", bar=1, baz=1.1),
"second": TestTypeHandlerRegistry.FooModel(foo="foo2", bar=2, baz=2.2),
}
)
expected_dict = {
"externals": {
"first": {"foo": "foo1", "bar": 1, "baz": 1.1},
"second": {"foo": "foo2", "bar": 2, "baz": 2.2},
}
}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.externals, dict)
assert len(deserialized.externals) == 2
assert all(isinstance(item, TestTypeHandlerRegistry.FooModel) for item in deserialized.externals.values())
assert deserialized.externals["first"].foo == "foo1"
assert deserialized.externals["first"].bar == 1
assert deserialized.externals["first"].baz == 1.1
assert deserialized.externals["second"].foo == "foo2"
assert deserialized.externals["second"].bar == 2
assert deserialized.externals["second"].baz == 2.2
def test_serialize_deserialize_optional_external_model(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
class GeneratedModel(HybridModel):
external: Optional[TestTypeHandlerRegistry.FooModel] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
# Test with the optional model present
model = GeneratedModel(external=TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14))
expected_dict = {"external": {"foo": "foo", "bar": 42, "baz": 3.14}}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.external, TestTypeHandlerRegistry.FooModel)
assert deserialized.external.foo == "foo"
assert deserialized.external.bar == 42
assert deserialized.external.baz == 3.14
# Test with the optional model as None
model = GeneratedModel(external=None)
expected_dict = {}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert deserialized.external is None
def test_serialize_deserialize_union_external_model(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
class GeneratedModel(HybridModel):
external: Union[str, TestTypeHandlerRegistry.FooModel] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
# Test with the union as the external model
model = GeneratedModel(external=TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14))
expected_dict = {"external": {"foo": "foo", "bar": 42, "baz": 3.14}}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.external, TestTypeHandlerRegistry.FooModel)
assert deserialized.external.foo == "foo"
assert deserialized.external.bar == 42
assert deserialized.external.baz == 3.14
# Test with the union as a string
model = GeneratedModel(external="just a string")
expected_dict = {"external": "just a string"}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.external, str)
assert deserialized.external == "just a string"
def test_deserialize_union_with_generated_model(self):
class GeneratedModel(HybridModel):
name: str = rest_field(visibility=["read", "create", "update", "delete", "query"])
value: int = rest_field(visibility=["read", "create", "update", "delete", "query"])
class ContainerModel(HybridModel):
item: Union[TestTypeHandlerRegistry.FooModel, GeneratedModel] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
if "foo" not in data:
raise ValueError("Missing 'foo' key for FooModel deserialization")
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
input_dict = {"item": {"foo": "foo", "bar": 42, "baz": 3.14}}
deserialized = _deserialize(ContainerModel, input_dict)
assert isinstance(deserialized, ContainerModel)
assert isinstance(deserialized.item, TestTypeHandlerRegistry.FooModel)
assert deserialized.item.foo == "foo"
assert deserialized.item.bar == 42
assert deserialized.item.baz == 3.14
input_dict = {"item": {"name": "generated", "value": 100}}
deserialized = _deserialize(ContainerModel, input_dict)
assert isinstance(deserialized, ContainerModel)
assert isinstance(deserialized.item, GeneratedModel)
assert deserialized.item.name == "generated"
assert deserialized.item.value == 100
def test_multiple_external_type_deserialization_scenario(self):
# Here we test a scenario where we have a generated model containing a union of multiple external types.
# We register a deserializer predicate that will match all of the external types, and the handler function
# will inspect the input data to determine which type to instantiate.
class ExternalModelA:
def __init__(self, foo: str, bar: Optional[int] = None):
self.foo = foo
self.bar = bar
class ExternalModelB:
def __init__(self, biz: int, baz: Optional[str] = None):
self.biz = biz
self.baz = baz
class ContainerModel(HybridModel):
item: Union[ExternalModelA, ExternalModelB] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
def ext_deserializer(cls: Type, data: Dict[str, Any]) -> Union[ExternalModelA, ExternalModelB]:
if "foo" in data:
return ExternalModelA(foo=data["foo"], bar=data.get("bar"))
elif "biz" in data:
return ExternalModelB(biz=data["biz"], baz=data.get("baz"))
else:
raise ValueError("Invalid data for deserialization")
TYPE_HANDLER_REGISTRY.register_deserializer(lambda t: t in (ExternalModelA, ExternalModelB))(ext_deserializer)
input_dict = {"item": {"foo": "foo_value", "bar": 123}}
deserialized = _deserialize(ContainerModel, input_dict)
assert isinstance(deserialized, ContainerModel)
assert isinstance(deserialized.item, ExternalModelA)
assert deserialized.item.foo == "foo_value"
assert deserialized.item.bar == 123
input_dict = {"item": {"biz": 456, "baz": "baz_value"}}
deserialized = _deserialize(ContainerModel, input_dict)
assert isinstance(deserialized, ContainerModel)
assert isinstance(deserialized.item, ExternalModelB)
assert deserialized.item.biz == 456
assert deserialized.item.baz == "baz_value"
def test_multiple_external_type_deserialization_polymorphic_scenario(self):
# Similar to the previous test, but here we have one external type inheriting from another.
# The deserializer function will need to handle this inheritance relationship and instantiation priority.
class ExternalModelA:
def __init__(self, foo: str, bar: Optional[int] = None):
self.foo = foo
self.bar = bar
class ExternalModelB(ExternalModelA):
def __init__(self, foo: str, bar: Optional[int] = None, baz: Optional[float] = None):
super().__init__(foo, bar)
self.baz = baz
class ContainerModel(HybridModel):
item: Union[ExternalModelA, ExternalModelB] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
def ext_deserializer(cls: Type, data: Dict[str, Any]) -> Union[ExternalModelA, ExternalModelB]:
if "baz" in data:
return ExternalModelB(foo=data["foo"], bar=data.get("bar"), baz=data.get("baz"))
elif "foo" in data:
return ExternalModelA(foo=data["foo"], bar=data.get("bar"))
else:
raise ValueError("Invalid data for deserialization")
TYPE_HANDLER_REGISTRY.register_deserializer(lambda t: t in (ExternalModelA, ExternalModelB))(ext_deserializer)
input_dict = {"item": {"foo": "foo_value", "bar": 123}}
deserialized = _deserialize(ContainerModel, input_dict)
assert isinstance(deserialized, ContainerModel)
assert isinstance(deserialized.item, ExternalModelA)
assert not isinstance(deserialized.item, ExternalModelB)
assert deserialized.item.foo == "foo_value"
assert deserialized.item.bar == 123
input_dict = {"item": {"foo": "foo_value", "bar": 123, "baz": 3.14}}
deserialized = _deserialize(ContainerModel, input_dict)
assert isinstance(deserialized, ContainerModel)
assert isinstance(deserialized.item, ExternalModelB)
assert deserialized.item.foo == "foo_value"
assert deserialized.item.bar == 123
assert deserialized.item.baz == 3.14
def test_serialize_deserialize_deep_nested_external_model_in_generated_model(self):
@TYPE_HANDLER_REGISTRY.register_serializer(TestTypeHandlerRegistry.FooModel)
def foo_serializer(obj: TestTypeHandlerRegistry.FooModel) -> Dict[str, Any]:
return {"foo": obj.foo, "bar": obj.bar, "baz": obj.baz}
@TYPE_HANDLER_REGISTRY.register_deserializer(TestTypeHandlerRegistry.FooModel)
def foo_deserializer(cls, data: Dict[str, Any]) -> TestTypeHandlerRegistry.FooModel:
return TestTypeHandlerRegistry.FooModel(foo=data["foo"], bar=data["bar"], baz=data["baz"])
class NestedModel(HybridModel):
foo: TestTypeHandlerRegistry.FooModel = rest_field(
visibility=["read", "create", "update", "delete", "query"]
)
class ChildModel(HybridModel):
nested: NestedModel = rest_field(visibility=["read", "create", "update", "delete", "query"])
class BaseModel(HybridModel):
child: ChildModel = rest_field(visibility=["read", "create", "update", "delete", "query"])
model = BaseModel(
child=ChildModel(nested=NestedModel(foo=TestTypeHandlerRegistry.FooModel(foo="foo", bar=42, baz=3.14)))
)
expected_dict = {"child": {"nested": {"foo": {"foo": "foo", "bar": 42, "baz": 3.14}}}}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(BaseModel, expected_dict)
assert isinstance(deserialized, BaseModel)
assert isinstance(deserialized.child, ChildModel)
assert isinstance(deserialized.child.nested, NestedModel)
assert deserialized.child.nested.foo.foo == "foo"
assert deserialized.child.nested.foo.bar == 42
assert deserialized.child.nested.foo.baz == 3.14
def test_serialize_deserialize_external_model_with_predicates(self):
import dataclasses
@dataclasses.dataclass
class SampleModel:
foo: str
bar: int
@dataclasses.dataclass
class SampleModel2:
biz: str
baz: int
class GeneratedModel(HybridModel):
foo: SampleModel = rest_field(visibility=["read", "create", "update", "delete", "query"])
bar: SampleModel2 = rest_field(visibility=["read", "create", "update", "delete", "query"])
@TYPE_HANDLER_REGISTRY.register_serializer(lambda obj: dataclasses.is_dataclass(obj))
def foo_serializer(obj) -> Dict[str, Any]:
return dataclasses.asdict(obj)
@TYPE_HANDLER_REGISTRY.register_deserializer(lambda t: dataclasses.is_dataclass(t))
def foo_deserializer(cls: Type, data: Dict[str, Any]) -> Any:
return cls(**data)
model = SampleModel(foo="foo", bar=42)
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == {"foo": "foo", "bar": 42}
model = GeneratedModel(
foo=SampleModel(foo="foo", bar=42),
bar=SampleModel2(biz="biz", baz=3),
)
expected_dict = {
"foo": {"foo": "foo", "bar": 42},
"bar": {"biz": "biz", "baz": 3},
}
assert model.as_dict() == expected_dict
json_str = json.dumps(model, cls=SdkJSONEncoder, exclude_readonly=True)
assert json.loads(json_str) == expected_dict
# Deserialization
deserialized = _deserialize(GeneratedModel, expected_dict)
assert isinstance(deserialized, GeneratedModel)
assert isinstance(deserialized.foo, SampleModel)
assert isinstance(deserialized.bar, SampleModel2)
assert deserialized.foo.foo == "foo"
assert deserialized.foo.bar == 42
assert deserialized.bar.biz == "biz"
assert deserialized.bar.baz == 3
def test_serialize_types_caching(self):
class ModelA:
pass
class ModelB:
pass
def serializer_a(obj: ModelA) -> Dict[str, Any]:
return {"type": "A"}
def serialize_a2(obj: ModelA) -> Dict[str, Any]:
return {"type": "A2"}
def serializer_b(obj: ModelB) -> Dict[str, Any]:
return {"type": "B"}
TYPE_HANDLER_REGISTRY.register_serializer(ModelA)(serializer_a)
TYPE_HANDLER_REGISTRY.register_serializer(ModelB)(serializer_b)
model_a = ModelA()
model_b = ModelB()
# First retrieval should populate the cache
serializer = TYPE_HANDLER_REGISTRY.get_serializer(model_a)
assert serializer is serializer_a
assert TYPE_HANDLER_REGISTRY._serializer_cache[ModelA] is serializer_a
# Second retrieval should hit the cache
serializer = TYPE_HANDLER_REGISTRY.get_serializer(model_a)
assert serializer is serializer_a
# Retrieval for a different type
serializer = TYPE_HANDLER_REGISTRY.get_serializer(model_b)
assert serializer is serializer_b
assert TYPE_HANDLER_REGISTRY._serializer_cache[ModelB] is serializer_b
# Again, should hit the cache
serializer = TYPE_HANDLER_REGISTRY.get_serializer(model_b)
assert serializer is serializer_b
# Now, re-register a different serializer for ModelA
TYPE_HANDLER_REGISTRY.register_serializer(ModelA)(serialize_a2)
serializer = TYPE_HANDLER_REGISTRY.get_serializer(model_a)
assert serializer is serialize_a2
assert TYPE_HANDLER_REGISTRY._serializer_cache[ModelA] is serialize_a2
def test_deserialize_types_caching(self):
class ModelA:
def __init__(self):
self.type = None
class ModelB:
def __init__(self):
self.type = None
def deserializer_a(cls, data: Dict[str, Any]) -> ModelA:
obj = ModelA()
obj.type = data["type"]
return obj
def deserialize_a2(cls, data: Dict[str, Any]) -> ModelA:
obj = ModelA()
obj.type = data["type"] + "2"
return obj
def deserializer_b(cls, data: Dict[str, Any]) -> ModelB:
obj = ModelB()
obj.type = data["type"]
return obj
TYPE_HANDLER_REGISTRY.register_deserializer(ModelA)(deserializer_a)
TYPE_HANDLER_REGISTRY.register_deserializer(ModelB)(deserializer_b)
json_dict_a = {"type": "A"}
json_dict_b = {"type": "B"}
# First retrieval should populate the cache
deserializer = TYPE_HANDLER_REGISTRY.get_deserializer(ModelA)
assert getattr(deserializer, "func", None) is deserializer_a
assert TYPE_HANDLER_REGISTRY._deserializer_cache[ModelA] is deserializer
# Second retrieval should hit the cache
deserializer = TYPE_HANDLER_REGISTRY.get_deserializer(ModelA)
assert getattr(deserializer, "func", None) is deserializer_a
# Retrieval for a different type
deserializer = TYPE_HANDLER_REGISTRY.get_deserializer(ModelB)
assert getattr(deserializer, "func", None) is deserializer_b
assert TYPE_HANDLER_REGISTRY._deserializer_cache[ModelB] is deserializer
# Again, should hit the cache
deserializer = TYPE_HANDLER_REGISTRY.get_deserializer(ModelB)
assert getattr(deserializer, "func", None) is deserializer_b
# Now, re-register a different deserializer for ModelA
TYPE_HANDLER_REGISTRY.register_deserializer(ModelA)(deserialize_a2)
deserializer = TYPE_HANDLER_REGISTRY.get_deserializer(ModelA)
assert getattr(deserializer, "func", None) is deserialize_a2
assert TYPE_HANDLER_REGISTRY._deserializer_cache[ModelA] is deserializer
# Test that deserialization works as expected
deserialized_a = _deserialize(ModelA, json_dict_a)
assert isinstance(deserialized_a, ModelA)
assert deserialized_a.type == "A2"
|