File: test_types.py

package info (click to toggle)
python-mashumaro 3.16-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,400 kB
  • sloc: python: 19,890; sh: 16; makefile: 5
file content (365 lines) | stat: -rw-r--r-- 10,614 bytes parent folder | download | duplicates (2)
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
from dataclasses import dataclass
from datetime import date
from typing import Any, Generic, Iterator, Mapping, Tuple, TypeVar

import pytest
from typing_extensions import Self

from mashumaro import DataClassDictMixin
from mashumaro.exceptions import UnserializableField
from mashumaro.types import Alias, SerializableType
from tests.entities import GenericSerializableList, GenericSerializableWrapper

XT = TypeVar("XT")
YT = TypeVar("YT")


class MySerializableType(SerializableType):
    def __init__(self, value):
        self.value = value

    def _serialize(self):
        return self.value.isoformat()

    @classmethod
    def _deserialize(cls, value):
        return cls(date.fromisoformat(value))


class MyAnnotatedSerializableType(SerializableType, use_annotations=True):
    def __init__(self, value: date):
        self.value = value

    def _serialize(self) -> date:
        return self.value

    @classmethod
    def _deserialize(cls, value: date):
        return cls(value)


class MyAnnotatedSerializableTypeWithoutAnnotationsInDeserialize(
    SerializableType, use_annotations=True
):
    def __init__(self, value):  # pragma: no cover
        self.value = value

    def _serialize(self) -> date:  # pragma: no cover
        return self.value

    @classmethod
    def _deserialize(cls, value):  # pragma: no cover
        return cls(value)


class MyAnnotatedSerializableTypeWithoutAnnotationsInSerialize(
    SerializableType, use_annotations=True
):
    def __init__(self, value):  # pragma: no cover
        self.value = value

    def _serialize(self):  # pragma: no cover
        return self.value

    @classmethod
    def _deserialize(cls, value: date):  # pragma: no cover
        return cls(value)


class MyAnnotatedGenericSerializableType(
    Generic[XT, YT], SerializableType, use_annotations=True
):
    def __init__(self, value: Tuple[XT, YT]):
        self.value = value

    def _serialize(self) -> Tuple[YT, XT]:
        return tuple(reversed(self.value))

    @classmethod
    def _deserialize(cls, value: Tuple[XT, YT]):
        return cls(value)


class MyAnnotatedGenericSerializableTypeWithMixedTypeVars(
    Generic[XT], SerializableType, use_annotations=True
):
    def __init__(self, value):
        self.value = value

    def _serialize(self) -> Tuple[int, XT, float]:
        return self.value

    @classmethod
    def _deserialize(cls, value: Tuple[int, XT, float]):
        return cls(value)


class MyAnnotatedGenericPEP585SerializableType(
    Generic[XT, YT], SerializableType, use_annotations=True
):
    def __init__(self, value: tuple[XT, YT]):
        self.value = value

    def _serialize(self) -> tuple[YT, XT]:
        return tuple(reversed(self.value))

    @classmethod
    def _deserialize(cls, value: tuple[XT, YT]):
        return cls(value)


class MyMapping(Mapping[XT, YT], SerializableType, use_annotations=True):
    def __init__(self, value: Mapping[Any, Any]):
        self.value = value

    def _serialize(self) -> Mapping[XT, YT]:
        return self.value

    @classmethod
    def _deserialize(cls, mapping: Mapping[XT, YT]):
        return cls(mapping)

    def __getitem__(self, __k: XT) -> YT:
        return self.value[__k]

    def __len__(self) -> int:  # pragma: no cover
        return len(self.value)

    def __iter__(self) -> Iterator[XT]:
        return iter(self.value)

    def __repr__(self):  # pragma: no cover
        return f"<MyMapping: {repr(self.value)}>"


class MyAnnotatedUserGenericSerializableType(
    Generic[XT, YT], SerializableType, use_annotations=True
):
    def __init__(self, value: MyMapping[XT, YT]):
        self.value = value

    def _serialize(self) -> MyMapping[XT, YT]:
        return self.value

    @classmethod
    def _deserialize(cls, value: MyMapping[XT, YT]):
        return cls(value)

    def __repr__(self):  # pragma: no cover
        return f"<MyAnnotatedUserGenericSerializableType: {repr(self.value)}>"


class MySelfSerializableType(SerializableType, use_annotations=True):
    def _serialize(self) -> Self:
        return self

    @classmethod
    def _deserialize(cls, value: Self) -> Self:
        return value


def test_generic_serializable_list_int():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: GenericSerializableList[int]

    obj = DataClass(x=GenericSerializableList([1, 2, 3]))
    assert DataClass.from_dict({"x": [3, 4, 5]}) == obj
    assert obj.to_dict() == {"x": [3, 4, 5]}


def test_generic_serializable_list_str():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: GenericSerializableList[str]

    obj = DataClass(x=GenericSerializableList(["a", "b", "c"]))
    assert DataClass.from_dict({"x": ["_a", "_b", "_c"]}) == obj
    assert obj.to_dict() == {"x": ["_a", "_b", "_c"]}


def test_generic_serializable_wrapper_with_type_from_another_module():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: GenericSerializableWrapper[date]

    obj = DataClass(x=GenericSerializableWrapper(date(2022, 12, 8)))
    assert DataClass.from_dict({"x": "2022-12-08"}) == obj
    assert obj.to_dict() == {"x": "2022-12-08"}


def test_simple_serializable_type():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MySerializableType

    obj = DataClass.from_dict({"x": "2022-12-07"})
    assert obj.x.value == date(2022, 12, 7)
    assert obj.to_dict() == {"x": "2022-12-07"}


def test_annotated_serializable_type():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedSerializableType

    obj = DataClass.from_dict({"x": "2022-12-07"})
    assert obj.x.value == date(2022, 12, 7)
    assert obj.to_dict() == {"x": "2022-12-07"}


def test_annotated_serializable_type_without_annotations_in_deserialize():
    with pytest.raises(UnserializableField) as e:

        @dataclass
        class _(DataClassDictMixin):
            x: MyAnnotatedSerializableTypeWithoutAnnotationsInDeserialize

    assert (
        e.value.msg
        == 'Method _deserialize must have annotated "value" argument'
    )


def test_annotated_serializable_type_without_annotations_in_serialize():
    with pytest.raises(UnserializableField) as e:

        @dataclass
        class _(DataClassDictMixin):
            x: MyAnnotatedSerializableTypeWithoutAnnotationsInSerialize

    assert e.value.msg == "Method _serialize must have return annotation"


def test_annotated_generic_serializable_type():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericSerializableType

    obj = DataClass.from_dict({"x": ["2022-12-07", "3.14"]})
    assert obj.x.value == ("2022-12-07", "3.14")
    assert obj.to_dict() == {"x": ["3.14", "2022-12-07"]}

    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericSerializableType[date, float]

    obj = DataClass.from_dict({"x": ["2022-12-07", "3.14"]})
    assert obj.x.value == (date(2022, 12, 7), 3.14)
    assert obj.to_dict() == {"x": [3.14, "2022-12-07"]}

    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericSerializableType[date, YT]

    obj = DataClass.from_dict({"x": ["2022-12-07", "3.14"]})
    assert obj.x.value == (date(2022, 12, 7), "3.14")
    assert obj.to_dict() == {"x": ["3.14", "2022-12-07"]}


def test_annotated_generic_pep585_serializable_type():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericPEP585SerializableType

    obj = DataClass.from_dict({"x": ["2022-12-07", "3.14"]})
    assert obj.x.value == ("2022-12-07", "3.14")
    assert obj.to_dict() == {"x": ["3.14", "2022-12-07"]}

    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericSerializableType[date, float]

    obj = DataClass.from_dict({"x": ["2022-12-07", "3.14"]})
    assert obj.x.value == (date(2022, 12, 7), 3.14)
    assert obj.to_dict() == {"x": [3.14, "2022-12-07"]}

    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericSerializableType[date, YT]

    obj = DataClass.from_dict({"x": ["2022-12-07", "3.14"]})
    assert obj.x.value == (date(2022, 12, 7), "3.14")
    assert obj.to_dict() == {"x": ["3.14", "2022-12-07"]}


def test_annotated_user_generic_serializable_type():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedUserGenericSerializableType

    obj = DataClass.from_dict({"x": {"2022-12-07": "3.14"}})
    assert type(obj.x.value) is MyMapping
    assert dict(obj.x.value) == {"2022-12-07": "3.14"}
    assert obj.to_dict() == {"x": {"2022-12-07": "3.14"}}

    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedUserGenericSerializableType[date, float]

    obj = DataClass.from_dict({"x": {"2022-12-07": "3.14"}})
    assert type(obj.x.value) is MyMapping
    assert dict(obj.x.value) == {date(2022, 12, 7): 3.14}
    assert obj.to_dict() == {"x": {"2022-12-07": 3.14}}

    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedUserGenericSerializableType[date, YT]

    obj = DataClass.from_dict({"x": {"2022-12-07": "3.14"}})
    assert type(obj.x.value) is MyMapping
    assert dict(obj.x.value) == {date(2022, 12, 7): "3.14"}
    assert obj.to_dict() == {"x": {"2022-12-07": "3.14"}}


def test_serializable_type_inheritance():
    class MySerializableType2(MySerializableType, use_annotations=True):
        pass

    assert MySerializableType2.__use_annotations__

    class MySerializableType3(MySerializableType2):
        pass

    assert MySerializableType3.__use_annotations__

    class MySerializableType4(MySerializableType3, use_annotations=False):
        pass

    assert not MySerializableType4.__use_annotations__


def test_serializable_type_with_self():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MySelfSerializableType

    obj = DataClass(MySelfSerializableType())
    assert obj.to_dict() == {"x": obj.x}
    assert DataClass.from_dict({"x": obj.x}) == obj


def test_annotated_generic_serializable_type_with_mixed_type_vars():
    @dataclass
    class DataClass(DataClassDictMixin):
        x: MyAnnotatedGenericSerializableTypeWithMixedTypeVars[date]

    obj = DataClass.from_dict({"x": ["1", "2022-05-29", "2.3"]})
    # assert obj.x.value == (1, date(2022, 5, 29), 2.3)
    assert obj.to_dict() == {"x": [1, "2022-05-29", 2.3]}


def test_alias():
    x1 = Alias("x")
    x2 = Alias("x")
    y = Alias("y")

    assert x1 == x2
    assert hash(x1) == hash(x2)

    assert x1 != y
    assert x1 != "x"
    assert hash(x1) != hash(y)

    assert str(y) == "Alias(name='y')"
    assert repr(y) == "Alias(name='y')"