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
|
from dataclasses import dataclass, field
from datetime import date, datetime, time, timezone
from pathlib import Path
from typing import Any, Dict, Optional, Union
import ciso8601
import pytest
from mashumaro import DataClassDictMixin
from mashumaro.exceptions import (
UnserializableField,
UnsupportedDeserializationEngine,
UnsupportedSerializationEngine,
)
from mashumaro.types import SerializationStrategy
from .entities import (
MutableString,
MyList,
MyNamedTuple,
MyNamedTupleWithDefaults,
MyUntypedNamedTuple,
MyUntypedNamedTupleWithDefaults,
ThirdPartyType,
TIntStr,
TypedDictRequiredKeys,
)
def test_ciso8601_datetime_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": "ciso8601"})
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5, tzinfo=timezone.utc))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05Z"})
assert instance == should_be
def test_ciso8601_date_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: date = field(metadata={"deserialize": "ciso8601"})
should_be = DataClass(x=date(2021, 1, 2))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05Z"})
assert instance == should_be
def test_ciso8601_time_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: time = field(metadata={"deserialize": "ciso8601"})
should_be = DataClass(x=time(3, 4, 5))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05Z"})
assert instance == should_be
def test_pendulum_datetime_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": "pendulum"})
should_be = DataClass(x=datetime(2008, 12, 29, 7, tzinfo=timezone.utc))
instance = DataClass.from_dict({"x": "2009-W01 07:00"})
assert instance == should_be
def test_pendulum_date_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: date = field(metadata={"deserialize": "pendulum"})
should_be = DataClass(x=date(2008, 12, 29))
instance = DataClass.from_dict({"x": "2009-W01"})
assert instance == should_be
def test_pendulum_time_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: time = field(metadata={"deserialize": "pendulum"})
should_be = DataClass(x=time(3, 4, 5))
instance = DataClass.from_dict({"x": "2009-W01 03:04:05"})
assert instance == should_be
def test_unsupported_datetime_parser_engine():
with pytest.raises(UnsupportedDeserializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": "unsupported"})
def test_global_function_datetime_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(
metadata={"deserialize": ciso8601.parse_datetime_as_naive}
)
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05+03:00"})
assert instance == should_be
def test_local_function_datetime_parser():
def parse_dt(s):
return ciso8601.parse_datetime_as_naive(s)
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": parse_dt})
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05+03:00"})
assert instance == should_be
def test_class_method_datetime_parser():
class DateTimeParser:
@classmethod
def parse_dt(cls, s: str) -> datetime:
return datetime.fromisoformat(s)
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": DateTimeParser.parse_dt})
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05"})
assert instance == should_be
def test_class_instance_method_datetime_parser():
class DateTimeParser:
def __call__(self, s: str) -> datetime:
return datetime.fromisoformat(s)
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": DateTimeParser()})
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05"})
assert instance == should_be
def test_callable_class_instance_datetime_parser():
class CallableDateTimeParser:
def __call__(self, s):
return ciso8601.parse_datetime(s)
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(metadata={"deserialize": CallableDateTimeParser()})
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5, tzinfo=timezone.utc))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05Z"})
assert instance == should_be
def test_lambda_datetime_parser():
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(
metadata={"deserialize": lambda s: ciso8601.parse_datetime(s)}
)
should_be = DataClass(x=datetime(2021, 1, 2, 3, 4, 5, tzinfo=timezone.utc))
instance = DataClass.from_dict({"x": "2021-01-02T03:04:05Z"})
assert instance == should_be
def test_derived_dataclass_metadata_deserialize_option():
@dataclass
class A:
x: datetime = field(metadata={"deserialize": ciso8601.parse_datetime})
@dataclass
class B(A, DataClassDictMixin):
y: datetime = field(metadata={"deserialize": ciso8601.parse_datetime})
should_be = B(
x=datetime(2021, 1, 2, 3, 4, 5, tzinfo=timezone.utc),
y=datetime(2021, 1, 2, 3, 4, 5, tzinfo=timezone.utc),
)
instance = B.from_dict(
{"x": "2021-01-02T03:04:05Z", "y": "2021-01-02T03:04:05Z"}
)
assert instance == should_be
def test_derived_dataclass_metadata_deserialize_option_removed():
class MyClass:
pass
@dataclass
class A:
x: MyClass = field(
metadata={"deserialize": MyClass, "serialize": lambda obj: obj.i}
)
with pytest.raises(UnserializableField):
@dataclass
class _(A, DataClassDictMixin):
x: MyClass
def test_bytearray_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: bytearray = field(
metadata={"deserialize": lambda s: s.upper().encode()}
)
should_be = DataClass(x=bytearray(b"ABC"))
instance = DataClass.from_dict({"x": "abc"})
assert instance == should_be
def test_path_like_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: Path = field(
metadata={"deserialize": lambda s: Path(str(s).upper())}
)
should_be = DataClass(x=Path("/ABC"))
instance = DataClass.from_dict({"x": "/abc"})
assert instance == should_be
def test_datetime_serialize_option():
@dataclass
class DataClass(DataClassDictMixin):
x: datetime = field(
metadata={"serialize": lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
)
should_be = {"x": "2021-01-02 03:04:05"}
instance = DataClass(x=datetime(2021, 1, 2, 3, 4, 5, tzinfo=timezone.utc))
assert instance.to_dict() == should_be
def test_third_party_type_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: ThirdPartyType = field(
metadata={
"deserialize": lambda v: ThirdPartyType(v),
"serialize": lambda v: v.value,
}
)
should_be = DataClass(x=ThirdPartyType(123))
instance = DataClass.from_dict({"x": 123})
assert instance == should_be
assert instance.to_dict() == {"x": 123}
def test_serializable_type_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: MutableString = field(
metadata={
"deserialize": lambda s: MutableString(s.upper()),
"serialize": lambda v: str(v).lower(),
}
)
should_be = DataClass(x=MutableString("ABC"))
instance = DataClass.from_dict({"x": "abc"})
assert instance == should_be
assert instance.to_dict() == {"x": "abc"}
def test_optional_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: Optional[ThirdPartyType] = field(
metadata={
"deserialize": lambda v: ThirdPartyType(v),
"serialize": lambda v: v.value,
}
)
instance = DataClass.from_dict({"x": 123})
assert instance
assert instance.x.value == 123
dct = instance.to_dict()
assert dct["x"] == 123
def test_union_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: Union[float, int] = field(
metadata={
"deserialize": lambda v: int(v),
"serialize": lambda v: int(v),
}
)
instance = DataClass.from_dict({"x": 1.0})
assert instance == DataClass(x=1)
assert instance.to_dict() == {"x": 1}
for attr in dir(DataClass):
assert not attr.startswith("__unpack_union")
assert not attr.startswith("__unpack_union")
def test_type_var_overridden():
@dataclass
class DataClass(DataClassDictMixin):
x: TIntStr = field(
metadata={
"deserialize": lambda v: v * 2,
"serialize": lambda v: v * 2,
}
)
instance = DataClass.from_dict({"x": "a"})
assert instance == DataClass(x="aa")
assert instance.to_dict() == {"x": "aaaa"}
for attr in dir(DataClass):
assert not attr.startswith("__unpack_type_var")
assert not attr.startswith("__pack_type_var")
def test_serialization_strategy():
class TestSerializationStrategy(SerializationStrategy):
def serialize(self, value):
return [value]
def deserialize(self, value):
return value[0]
@dataclass
class DataClass(DataClassDictMixin):
x: int = field(
metadata={"serialization_strategy": TestSerializationStrategy()}
)
instance = DataClass(x=123)
assert DataClass.from_dict({"x": [123]}) == instance
assert instance.to_dict() == {"x": [123]}
def test_collection_derived_custom_class():
@dataclass
class DataClass(DataClassDictMixin):
x: MyList = field(
metadata={"serialize": lambda v: v, "deserialize": lambda v: v}
)
instance = DataClass(x=[1, 2, 3])
assert DataClass.from_dict({"x": [1, 2, 3]}) == instance
assert instance.to_dict() == {"x": [1, 2, 3]}
def test_dataclass_with_typed_dict_overridden():
def serialize_x(x: TypedDictRequiredKeys) -> Dict[str, Any]:
return {"int": int(x["int"]), "float": float(x["float"])}
def deserialize_x(x: Dict[str, Any]) -> TypedDictRequiredKeys:
return TypedDictRequiredKeys(int=x["int"], float=x["float"])
@dataclass
class DataClass(DataClassDictMixin):
x: TypedDictRequiredKeys = field(
metadata={"serialize": serialize_x, "deserialize": deserialize_x}
)
obj = DataClass(x=TypedDictRequiredKeys(int=1, float=2.0))
data = {"x": {"int": 1, "float": 2.0}}
assert DataClass.from_dict(data) == obj
assert obj.to_dict() == data
def test_named_tuple_as_dict_engine():
@dataclass
class DataClass(DataClassDictMixin):
x: MyNamedTuple = field(
metadata={"serialize": "as_dict", "deserialize": "as_dict"}
)
obj = DataClass(x=MyNamedTuple(i=1, f=2.0))
assert obj.to_dict() == {"x": {"i": 1, "f": 2.0}}
assert DataClass.from_dict({"x": {"i": 1, "f": 2.0}}) == obj
def test_named_tuple_with_defaults_as_dict_engine():
@dataclass
class DataClass(DataClassDictMixin):
x: MyNamedTupleWithDefaults = field(
metadata={"serialize": "as_dict", "deserialize": "as_dict"}
)
obj = DataClass(x=MyNamedTupleWithDefaults(i=1, f=2.0))
assert obj.to_dict() == {"x": {"i": 1, "f": 2.0}}
assert DataClass.from_dict({"x": {"i": 1, "f": 2.0}}) == obj
def test_untyped_named_tuple_as_dict_engine():
@dataclass
class DataClass(DataClassDictMixin):
x: MyUntypedNamedTuple = field(
metadata={"serialize": "as_dict", "deserialize": "as_dict"}
)
obj = DataClass(x=MyUntypedNamedTuple(i=1, f=2.0))
assert obj.to_dict() == {"x": {"i": 1, "f": 2.0}}
assert DataClass.from_dict({"x": {"i": 1, "f": 2.0}}) == obj
def test_untyped_named_tuple_with_defaults_as_dict_engine():
@dataclass
class DataClass(DataClassDictMixin):
x: MyUntypedNamedTupleWithDefaults = field(
metadata={"serialize": "as_dict", "deserialize": "as_dict"}
)
obj = DataClass(x=MyUntypedNamedTupleWithDefaults(i=1, f=2.0))
assert obj.to_dict() == {"x": {"i": 1, "f": 2.0}}
assert DataClass.from_dict({"x": {"i": 1, "f": 2.0}}) == obj
def test_unsupported_named_tuple_deserialization_engine():
with pytest.raises(UnsupportedDeserializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyNamedTuple = field(metadata={"deserialize": "unsupported"})
with pytest.raises(UnsupportedDeserializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyNamedTupleWithDefaults = field(
metadata={"deserialize": "unsupported"}
)
with pytest.raises(UnsupportedDeserializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyUntypedNamedTuple = field(
metadata={"deserialize": "unsupported"}
)
with pytest.raises(UnsupportedDeserializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyUntypedNamedTupleWithDefaults = field(
metadata={"deserialize": "unsupported"}
)
def test_unsupported_named_tuple_serialization_engine():
with pytest.raises(UnsupportedSerializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyNamedTuple = field(metadata={"serialize": "unsupported"})
with pytest.raises(UnsupportedSerializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyNamedTupleWithDefaults = field(
metadata={"serialize": "unsupported"}
)
with pytest.raises(UnsupportedSerializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyUntypedNamedTuple = field(
metadata={"serialize": "unsupported"}
)
with pytest.raises(UnsupportedSerializationEngine):
@dataclass
class DataClass(DataClassDictMixin):
x: MyUntypedNamedTupleWithDefaults = field(
metadata={"serialize": "unsupported"}
)
def test_field_metadata_omit_engine():
@dataclass
class DataClass(DataClassDictMixin):
x: int = field(metadata={"serialize": "omit"})
obj = DataClass(x=42)
assert obj.to_dict() == {}
assert DataClass.from_dict({"x": 42}) == obj
|