File: test_class_schema.py

package info (click to toggle)
python-marshmallow-dataclass 8.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 332 kB
  • sloc: python: 2,351; makefile: 11; sh: 6
file content (462 lines) | stat: -rw-r--r-- 16,389 bytes parent folder | download
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
import inspect
import typing
import unittest
from typing import Any, cast, TYPE_CHECKING
from uuid import UUID

try:
    from typing import Final, Literal  # type: ignore[attr-defined]
except ImportError:
    from typing_extensions import Final, Literal  # type: ignore[assignment]

import dataclasses
from marshmallow import Schema, ValidationError
from marshmallow.fields import Field, UUID as UUIDField, List as ListField, Integer
from marshmallow.validate import Validator

from marshmallow_dataclass import class_schema, NewType


class TestClassSchema(unittest.TestCase):
    def test_simple_unique_schemas(self):
        @dataclasses.dataclass
        class Simple:
            one: str = dataclasses.field()
            two: str = dataclasses.field()

        @dataclasses.dataclass
        class ComplexNested:
            three: int = dataclasses.field()
            four: Simple = dataclasses.field()

        self.assertIs(class_schema(ComplexNested), class_schema(ComplexNested))
        self.assertIs(class_schema(Simple), class_schema(Simple))
        self.assertIs(
            class_schema(Simple),
            class_schema(ComplexNested)._declared_fields["four"].nested,
        )

        complex_set = {
            class_schema(ComplexNested),
            class_schema(ComplexNested, base_schema=None),
            class_schema(ComplexNested, clazz_frame=None),
            class_schema(ComplexNested, None),
            class_schema(ComplexNested, None, None),
        }
        simple_set = {
            class_schema(Simple),
            class_schema(Simple, base_schema=None),
            class_schema(Simple, clazz_frame=None),
            class_schema(Simple, None),
            class_schema(Simple, None, None),
        }
        self.assertEqual(len(complex_set), 1)
        self.assertEqual(len(simple_set), 1)

    def test_nested_schema_with_passed_frame(self):
        @dataclasses.dataclass
        class Simple:
            one: str = dataclasses.field()
            two: str = dataclasses.field()

        @dataclasses.dataclass
        class ComplexNested:
            three: int = dataclasses.field()
            four: Simple = dataclasses.field()

        frame = inspect.stack()[0][0]

        self.assertIs(
            class_schema(ComplexNested, clazz_frame=frame),
            class_schema(ComplexNested, clazz_frame=frame),
        )
        self.assertIs(
            class_schema(Simple, clazz_frame=frame),
            class_schema(Simple, clazz_frame=frame),
        )
        self.assertIs(
            class_schema(Simple, clazz_frame=frame),
            class_schema(ComplexNested, clazz_frame=frame)
            ._declared_fields["four"]
            .nested,
        )

        complex_set = {
            class_schema(ComplexNested, clazz_frame=frame),
            class_schema(ComplexNested, base_schema=None, clazz_frame=frame),
            class_schema(ComplexNested, None, clazz_frame=frame),
            class_schema(ComplexNested, None, frame),
        }
        simple_set = {
            class_schema(Simple, clazz_frame=frame),
            class_schema(Simple, base_schema=None, clazz_frame=frame),
            class_schema(Simple, None, clazz_frame=frame),
            class_schema(Simple, clazz_frame=frame),
            class_schema(Simple, None, frame),
        }
        self.assertEqual(len(complex_set), 1)
        self.assertEqual(len(simple_set), 1)

    def test_use_type_mapping_from_base_schema(self):
        class CustomType:
            pass

        class CustomField(Field):
            pass

        class CustomListField(ListField):
            pass

        class BaseSchema(Schema):
            TYPE_MAPPING = {CustomType: CustomField, typing.List: CustomListField}

        @dataclasses.dataclass
        class WithCustomField:
            custom: CustomType
            custom_list: typing.List[float]
            uuid: UUID
            n: int

        schema = class_schema(WithCustomField, base_schema=BaseSchema)()
        self.assertIsInstance(schema.fields["custom"], CustomField)
        self.assertIsInstance(schema.fields["custom_list"], CustomListField)
        self.assertIsInstance(schema.fields["uuid"], UUIDField)
        self.assertIsInstance(schema.fields["n"], Integer)

    def test_filtering_list_schema(self):
        class FilteringListField(ListField):
            def __init__(
                self,
                cls_or_instance: typing.Union[Field, type],
                min: typing.Any,
                max: typing.Any,
                **kwargs,
            ):
                super().__init__(cls_or_instance, **kwargs)
                self.min = min
                self.max = max

            def _deserialize(
                self, value, attr, data, **kwargs
            ) -> typing.List[typing.Any]:
                loaded = super()._deserialize(value, attr, data, **kwargs)
                return [x for x in loaded if self.min <= x <= self.max]

        class BaseSchema(Schema):
            TYPE_MAPPING = {typing.List: FilteringListField}

        @dataclasses.dataclass
        class WithCustomField:
            constrained_floats: typing.List[float] = dataclasses.field(
                metadata={"max": 2.5, "min": 1}
            )
            constrained_strings: typing.List[str] = dataclasses.field(
                metadata={"max": "x", "min": "a"}
            )

        schema = class_schema(WithCustomField, base_schema=BaseSchema)()
        actual = schema.load(
            {
                "constrained_floats": [0, 1, 2, 3],
                "constrained_strings": ["z", "a", "b", "c", ""],
            }
        )
        self.assertEqual(
            actual,
            WithCustomField(
                constrained_floats=[1.0, 2.0], constrained_strings=["a", "b", "c"]
            ),
        )

    def test_any_none(self):
        # See: https://github.com/lovasoa/marshmallow_dataclass/issues/80
        @dataclasses.dataclass
        class A:
            data: Any

        schema = class_schema(A)()
        self.assertEqual(A(data=None), schema.load({"data": None}))
        self.assertEqual(schema.dump(A(data=None)), {"data": None})

    def test_any_none_disallowed(self):
        @dataclasses.dataclass
        class A:
            data: Any = dataclasses.field(metadata={"allow_none": False})

        schema = class_schema(A)()
        self.assertRaises(ValidationError, lambda: schema.load({"data": None}))

    def test_literal(self):
        @dataclasses.dataclass
        class A:
            data: Literal["a"]

        schema = class_schema(A)()
        self.assertEqual(A(data="a"), schema.load({"data": "a"}))
        self.assertEqual(schema.dump(A(data="a")), {"data": "a"})
        for data in ["b", 2, 2.34, False]:
            with self.assertRaises(ValidationError):
                schema.load({"data": data})

    def test_literal_multiple_types(self):
        @dataclasses.dataclass
        class A:
            data: Literal["a", 1, 1.23, True]

        schema = class_schema(A)()
        for data in ["a", 1, 1.23, True]:
            self.assertEqual(A(data=data), schema.load({"data": data}))
            self.assertEqual(schema.dump(A(data=data)), {"data": data})
        for data in ["b", 2, 2.34, False]:
            with self.assertRaises(ValidationError):
                schema.load({"data": data})

    def test_final(self):
        @dataclasses.dataclass
        class A:
            # Mypy currently considers read-only dataclass attributes without a
            # default value an error.
            # See: https://github.com/python/mypy/issues/10688.
            data: Final[str]  # type: ignore[misc]

        schema = class_schema(A)()
        self.assertEqual(A(data="a"), schema.load({"data": "a"}))
        self.assertEqual(schema.dump(A(data="a")), {"data": "a"})
        for data in [2, 2.34, False]:
            with self.assertRaises(ValidationError):
                schema.load({"data": data})

    def test_final_infers_type_from_default(self):
        # @dataclasses.dataclass(frozen=True)
        class A:
            data: Final = "a"

        # @dataclasses.dataclass
        class B:
            data: Final = A()

        # NOTE: This workaround is needed to avoid a Mypy crash.
        # See: https://github.com/python/mypy/issues/10090#issuecomment-865971891
        if not TYPE_CHECKING:
            frozen_dataclass = dataclasses.dataclass(frozen=True)
            A = frozen_dataclass(A)
            B = dataclasses.dataclass(B)

        with self.assertWarns(Warning):
            schema_a = class_schema(A)()
        self.assertEqual(A(data="a"), schema_a.load({}))
        self.assertEqual(A(data="a"), schema_a.load({"data": "a"}))
        self.assertEqual(A(data="b"), schema_a.load({"data": "b"}))
        self.assertEqual(schema_a.dump(A()), {"data": "a"})
        self.assertEqual(schema_a.dump(A(data="a")), {"data": "a"})
        self.assertEqual(schema_a.dump(A(data="b")), {"data": "b"})
        for data in [2, 2.34, False]:
            with self.assertRaises(ValidationError):
                schema_a.load({"data": data})

        with self.assertWarns(Warning):
            schema_b = class_schema(B)()
        self.assertEqual(B(data=A()), schema_b.load({}))
        self.assertEqual(B(data=A()), schema_b.load({"data": {}}))
        self.assertEqual(B(data=A()), schema_b.load({"data": {"data": "a"}}))
        self.assertEqual(B(data=A(data="b")), schema_b.load({"data": {"data": "b"}}))
        self.assertEqual(schema_b.dump(B()), {"data": {"data": "a"}})
        self.assertEqual(schema_b.dump(B(data=A())), {"data": {"data": "a"}})
        self.assertEqual(schema_b.dump(B(data=A(data="a"))), {"data": {"data": "a"}})
        self.assertEqual(schema_b.dump(B(data=A(data="b"))), {"data": {"data": "b"}})
        for data in [2, 2.34, False]:
            with self.assertRaises(ValidationError):
                schema_b.load({"data": data})

    def test_final_infers_type_any_from_field_default_factory(self):
        # @dataclasses.dataclass
        class A:
            data: Final = dataclasses.field(default_factory=lambda: [])

        # NOTE: This workaround is needed to avoid a Mypy crash.
        # See: https://github.com/python/mypy/issues/10090#issuecomment-866686096
        if not TYPE_CHECKING:
            A = dataclasses.dataclass(A)

        with self.assertWarns(Warning):
            schema = class_schema(A)()

        self.assertEqual(A(data=[]), schema.load({}))
        self.assertEqual(A(data=[]), schema.load({"data": []}))
        self.assertEqual(A(data=["a"]), schema.load({"data": ["a"]}))
        self.assertEqual(schema.dump(A()), {"data": []})
        self.assertEqual(schema.dump(A(data=[])), {"data": []})
        self.assertEqual(schema.dump(A(data=["a"])), {"data": ["a"]})

        # The following test cases pass because the field type cannot be
        # inferred from a factory.
        self.assertEqual(A(data=cast(Any, True)), schema.load({"data": True}))
        self.assertEqual(A(data=cast(Any, "a")), schema.load({"data": "a"}))

    def test_validator_stacking(self):
        # See: https://github.com/lovasoa/marshmallow_dataclass/issues/91
        class SimpleValidator(Validator):
            # Marshmallow checks for valid validators at construction time only using `callable`
            def __call__(self):
                pass

        validator_a = SimpleValidator()
        validator_b = SimpleValidator()
        validator_c = SimpleValidator()
        validator_d = SimpleValidator()

        CustomTypeOneValidator = NewType(
            "CustomTypeOneValidator", str, validate=validator_a
        )
        CustomTypeNoneValidator = NewType("CustomTypeNoneValidator", str, validate=None)
        CustomTypeMultiValidator = NewType(
            "CustomTypeNoneValidator", str, validate=[validator_a, validator_b]
        )

        @dataclasses.dataclass
        class A:
            data: CustomTypeNoneValidator = dataclasses.field()

        schema_a = class_schema(A)()
        self.assertListEqual(schema_a.fields["data"].validators, [])

        @dataclasses.dataclass
        class B:
            data: CustomTypeNoneValidator = dataclasses.field(
                metadata={"validate": validator_a}
            )

        schema_b = class_schema(B)()
        self.assertListEqual(schema_b.fields["data"].validators, [validator_a])

        @dataclasses.dataclass
        class C:
            data: CustomTypeNoneValidator = dataclasses.field(
                metadata={"validate": [validator_a, validator_b]}
            )

        schema_c = class_schema(C)()
        self.assertListEqual(
            schema_c.fields["data"].validators, [validator_a, validator_b]
        )

        @dataclasses.dataclass
        class D:
            data: CustomTypeOneValidator = dataclasses.field()

        schema_d = class_schema(D)()
        self.assertListEqual(schema_d.fields["data"].validators, [validator_a])

        @dataclasses.dataclass
        class E:
            data: CustomTypeOneValidator = dataclasses.field(
                metadata={"validate": validator_b}
            )

        schema_e = class_schema(E)()
        self.assertListEqual(
            schema_e.fields["data"].validators, [validator_a, validator_b]
        )

        @dataclasses.dataclass
        class F:
            data: CustomTypeOneValidator = dataclasses.field(
                metadata={"validate": [validator_b, validator_c]}
            )

        schema_f = class_schema(F)()
        self.assertListEqual(
            schema_f.fields["data"].validators, [validator_a, validator_b, validator_c]
        )

        @dataclasses.dataclass
        class G:
            data: CustomTypeMultiValidator = dataclasses.field()

        schema_g = class_schema(G)()
        self.assertListEqual(
            schema_g.fields["data"].validators, [validator_a, validator_b]
        )

        @dataclasses.dataclass
        class H:
            data: CustomTypeMultiValidator = dataclasses.field(
                metadata={"validate": validator_c}
            )

        schema_h = class_schema(H)()
        self.assertListEqual(
            schema_h.fields["data"].validators, [validator_a, validator_b, validator_c]
        )

        @dataclasses.dataclass
        class J:
            data: CustomTypeMultiValidator = dataclasses.field(
                metadata={"validate": [validator_c, validator_d]}
            )

        schema_j = class_schema(J)()
        self.assertListEqual(
            schema_j.fields["data"].validators,
            [validator_a, validator_b, validator_c, validator_d],
        )

    def test_recursive_reference(self):
        @dataclasses.dataclass
        class Tree:
            children: typing.List["Tree"]  # noqa: F821

        schema = class_schema(Tree)()

        self.assertEqual(
            schema.load({"children": [{"children": []}]}),
            Tree(children=[Tree(children=[])]),
        )

    def test_cyclic_reference(self):
        @dataclasses.dataclass
        class First:
            second: typing.Optional["Second"]  # noqa: F821

        @dataclasses.dataclass
        class Second:
            first: typing.Optional["First"]

        first_schema = class_schema(First)()
        second_schema = class_schema(Second)()

        self.assertEqual(
            first_schema.load({"second": {"first": None}}),
            First(second=Second(first=None)),
        )
        self.assertEqual(
            second_schema.dump(Second(first=First(second=Second(first=None)))),
            {"first": {"second": {"first": None}}},
        )

    def test_init_fields(self):
        @dataclasses.dataclass
        class NoMeta:
            no_init: str = dataclasses.field(init=False)

        @dataclasses.dataclass
        class NoInit:
            class Meta:
                pass

            no_init: str = dataclasses.field(init=False)

        @dataclasses.dataclass
        class Init:
            class Meta:
                include_non_init = True

            no_init: str = dataclasses.field(init=False)

        self.assertNotIn("no_init", class_schema(NoMeta)().fields)
        self.assertNotIn("no_init", class_schema(NoInit)().fields)
        self.assertIn("no_init", class_schema(Init)().fields)


if __name__ == "__main__":
    unittest.main()