forked from marshmallow-code/marshmallow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_fields.py
667 lines (548 loc) · 24 KB
/
test_fields.py
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
import pytest
from marshmallow import (
fields,
Schema,
ValidationError,
EXCLUDE,
INCLUDE,
RAISE,
missing,
)
from marshmallow.exceptions import StringNotCollectionError
from tests.base import ALL_FIELDS
@pytest.mark.parametrize(
("alias", "field"),
[
(fields.Int, fields.Integer),
(fields.Str, fields.String),
(fields.Bool, fields.Boolean),
(fields.URL, fields.Url),
],
)
def test_field_aliases(alias, field):
assert alias is field
class TestField:
def test_repr(self):
default = "œ∑´"
field = fields.Field(dump_default=default, attribute=None)
assert repr(field) == (
"<fields.Field(dump_default={0!r}, attribute=None, "
"validate=None, required=False, "
"load_only=False, dump_only=False, "
"load_default={missing}, allow_none=False, "
"error_messages={error_messages})>".format(
default, missing=missing, error_messages=field.error_messages
)
)
int_field = fields.Integer(validate=lambda x: True)
assert "<fields.Integer" in repr(int_field)
def test_error_raised_if_uncallable_validator_passed(self):
with pytest.raises(ValueError, match="must be a callable"):
fields.Field(validate="notcallable")
def test_error_raised_if_missing_is_set_on_required_field(self):
with pytest.raises(
ValueError, match="'load_default' must not be set for required fields"
):
fields.Field(required=True, load_default=42)
def test_custom_field_receives_attr_and_obj(self):
class MyField(fields.Field):
def _deserialize(self, val, attr, data, **kwargs):
assert attr == "name"
assert data["foo"] == 42
return val
class MySchema(Schema):
name = MyField()
result = MySchema(unknown=EXCLUDE).load({"name": "Monty", "foo": 42})
assert result == {"name": "Monty"}
def test_custom_field_receives_data_key_if_set(self):
class MyField(fields.Field):
def _deserialize(self, val, attr, data, **kwargs):
assert attr == "name"
assert data["foo"] == 42
return val
class MySchema(Schema):
Name = MyField(data_key="name")
result = MySchema(unknown=EXCLUDE).load({"name": "Monty", "foo": 42})
assert result == {"Name": "Monty"}
def test_custom_field_follows_data_key_if_set(self):
class MyField(fields.Field):
def _serialize(self, val, attr, data):
assert attr == "name"
assert data["foo"] == 42
return val
class MySchema(Schema):
name = MyField(data_key="_NaMe")
result = MySchema().dump({"name": "Monty", "foo": 42})
assert result == {"_NaMe": "Monty"}
class TestParentAndName:
class MySchema(Schema):
foo = fields.Field()
bar = fields.List(fields.Str())
baz = fields.Tuple([fields.Str(), fields.Int()])
bax = fields.Mapping(fields.Str(), fields.Int())
@pytest.fixture()
def schema(self):
return self.MySchema()
def test_simple_field_parent_and_name(self, schema):
assert schema.fields["foo"].parent == schema
assert schema.fields["foo"].name == "foo"
assert schema.fields["bar"].parent == schema
assert schema.fields["bar"].name == "bar"
# https://github.com/marshmallow-code/marshmallow/pull/572#issuecomment-275800288
def test_unbound_field_root_returns_none(self):
field = fields.Str()
assert field.root is None
inner_field = fields.Nested(self.MySchema())
outer_field = fields.List(inner_field)
assert outer_field.root is None
assert inner_field.root is None
def test_list_field_inner_parent_and_name(self, schema):
assert schema.fields["bar"].inner.parent == schema.fields["bar"]
assert schema.fields["bar"].inner.name == "bar"
def test_tuple_field_inner_parent_and_name(self, schema):
for field in schema.fields["baz"].tuple_fields:
assert field.parent == schema.fields["baz"]
assert field.name == "baz"
def test_mapping_field_inner_parent_and_name(self, schema):
assert schema.fields["bax"].value_field.parent == schema.fields["bax"]
assert schema.fields["bax"].value_field.name == "bax"
assert schema.fields["bax"].key_field.parent == schema.fields["bax"]
assert schema.fields["bax"].key_field.name == "bax"
def test_simple_field_root(self, schema):
assert schema.fields["foo"].root == schema
assert schema.fields["bar"].root == schema
def test_list_field_inner_root(self, schema):
assert schema.fields["bar"].inner.root == schema
def test_tuple_field_inner_root(self, schema):
for field in schema.fields["baz"].tuple_fields:
assert field.root == schema
def test_list_root_inheritance(self, schema):
class OtherSchema(TestParentAndName.MySchema):
pass
schema2 = OtherSchema()
assert schema.fields["bar"].inner.root == schema
assert schema2.fields["bar"].inner.root == schema2
def test_dict_root_inheritance(self):
class MySchema(Schema):
foo = fields.Dict(keys=fields.Str(), values=fields.Int())
class OtherSchema(MySchema):
pass
schema = MySchema()
schema2 = OtherSchema()
assert schema.fields["foo"].key_field.root == schema
assert schema.fields["foo"].value_field.root == schema
assert schema2.fields["foo"].key_field.root == schema2
assert schema2.fields["foo"].value_field.root == schema2
# Regression test for https://github.com/marshmallow-code/marshmallow/issues/1357
def test_datetime_list_inner_format(self, schema):
class MySchema(Schema):
foo = fields.List(fields.DateTime())
bar = fields.Tuple((fields.DateTime(),))
baz = fields.List(fields.Date())
qux = fields.Tuple((fields.Date(),))
class Meta:
datetimeformat = "iso8601"
dateformat = "iso8601"
schema = MySchema()
for field_name in ("foo", "baz"):
assert schema.fields[field_name].inner.format == "iso8601"
for field_name in ("bar", "qux"):
assert schema.fields[field_name].tuple_fields[0].format == "iso8601"
# Regression test for https://github.com/marshmallow-code/marshmallow/issues/1808
def test_field_named_parent_has_root(self, schema):
class MySchema(Schema):
parent = fields.Field()
schema = MySchema()
assert schema.fields["parent"].root == schema
class TestMetadata:
@pytest.mark.parametrize("FieldClass", ALL_FIELDS)
def test_extra_metadata_may_be_added_to_field(self, FieldClass): # noqa
with pytest.warns(DeprecationWarning):
field = FieldClass(description="Just a normal field.")
assert field.metadata["description"] == "Just a normal field."
field = FieldClass(
required=True,
dump_default=None,
validate=lambda v: True,
metadata={"description": "foo", "widget": "select"},
)
assert field.metadata == {"description": "foo", "widget": "select"}
@pytest.mark.parametrize("FieldClass", ALL_FIELDS)
def test_field_metadata_added_in_deprecated_style_warns(self, FieldClass): # noqa
# just the old style
with pytest.warns(DeprecationWarning):
field = FieldClass(description="Just a normal field.")
assert field.metadata["description"] == "Just a normal field."
# mixed styles
with pytest.warns(DeprecationWarning):
field = FieldClass(
required=True,
dump_default=None,
validate=lambda v: True,
description="foo",
metadata={"widget": "select"},
)
assert field.metadata == {"description": "foo", "widget": "select"}
class TestDeprecatedDefaultAndMissing:
@pytest.mark.parametrize("FieldClass", ALL_FIELDS)
def test_load_default_in_deprecated_style_warns(self, FieldClass):
# in constructor
with pytest.warns(
DeprecationWarning,
match="The 'missing' argument to fields is deprecated. "
"Use 'load_default' instead.",
):
FieldClass(missing=None)
# via attribute
myfield = FieldClass(load_default=1)
with pytest.warns(
DeprecationWarning,
match="The 'missing' attribute of fields is deprecated. "
"Use 'load_default' instead.",
):
assert myfield.missing == 1
with pytest.warns(
DeprecationWarning,
match="The 'missing' attribute of fields is deprecated. "
"Use 'load_default' instead.",
):
myfield.missing = 0
# but setting it worked
assert myfield.load_default == 0
@pytest.mark.parametrize("FieldClass", ALL_FIELDS)
def test_dump_default_in_deprecated_style_warns(self, FieldClass):
# in constructor
with pytest.warns(
DeprecationWarning,
match="The 'default' argument to fields is deprecated. "
"Use 'dump_default' instead.",
):
FieldClass(default=None)
# via attribute
myfield = FieldClass(dump_default=1)
with pytest.warns(
DeprecationWarning,
match="The 'default' attribute of fields is deprecated. "
"Use 'dump_default' instead.",
):
assert myfield.default == 1
with pytest.warns(
DeprecationWarning,
match="The 'default' attribute of fields is deprecated. "
"Use 'dump_default' instead.",
):
myfield.default = 0
# but setting it worked
assert myfield.dump_default == 0
class TestErrorMessages:
class MyField(fields.Field):
default_error_messages = {"custom": "Custom error message."}
error_messages = [
("required", "Missing data for required field."),
("null", "Field may not be null."),
("custom", "Custom error message."),
("validator_failed", "Invalid value."),
]
def test_default_error_messages_get_merged_with_parent_error_messages_cstm_msg(
self,
):
field = self.MyField()
assert field.error_messages["custom"] == "Custom error message."
assert "required" in field.error_messages
def test_default_error_messages_get_merged_with_parent_error_messages(self):
field = self.MyField(error_messages={"passed": "Passed error message"})
assert field.error_messages["passed"] == "Passed error message"
@pytest.mark.parametrize(("key", "message"), error_messages)
def test_make_error(self, key, message):
field = self.MyField()
error = field.make_error(key)
assert error.args[0] == message
@pytest.mark.parametrize(("key", "message"), error_messages)
def test_fail(self, key, message):
field = self.MyField()
with pytest.warns(DeprecationWarning):
try:
field.fail(key)
except ValidationError as error:
assert error.args[0] == message
def test_make_error_key_doesnt_exist(self):
with pytest.raises(AssertionError) as excinfo:
self.MyField().make_error("doesntexist")
assert "doesntexist" in excinfo.value.args[0]
assert "MyField" in excinfo.value.args[0]
class TestNestedField:
@pytest.mark.parametrize("param", ("only", "exclude"))
def test_nested_only_and_exclude_as_string(self, param):
with pytest.raises(StringNotCollectionError):
fields.Nested(Schema, **{param: "foo"})
@pytest.mark.parametrize(
"nested_value",
[
{"hello": fields.String()},
lambda: {"hello": fields.String()},
],
)
def test_nested_instantiation_from_dict(self, nested_value):
class MySchema(Schema):
nested = fields.Nested(nested_value)
schema = MySchema()
ret = schema.load({"nested": {"hello": "world"}})
assert ret == {"nested": {"hello": "world"}}
with pytest.raises(ValidationError):
schema.load({"nested": {"x": 1}})
@pytest.mark.parametrize("schema_unknown", (EXCLUDE, INCLUDE, RAISE))
@pytest.mark.parametrize("field_unknown", (None, EXCLUDE, INCLUDE, RAISE))
def test_nested_unknown_override(self, schema_unknown, field_unknown):
class NestedSchema(Schema):
class Meta:
unknown = schema_unknown
class MySchema(Schema):
nested = fields.Nested(NestedSchema, unknown=field_unknown)
if field_unknown == EXCLUDE or (
schema_unknown == EXCLUDE and not field_unknown
):
assert MySchema().load({"nested": {"x": 1}}) == {"nested": {}}
elif field_unknown == INCLUDE or (
schema_unknown == INCLUDE and not field_unknown
):
assert MySchema().load({"nested": {"x": 1}}) == {"nested": {"x": 1}}
elif field_unknown == RAISE or (schema_unknown == RAISE and not field_unknown):
with pytest.raises(ValidationError):
MySchema().load({"nested": {"x": 1}})
@pytest.mark.parametrize(
("param", "fields_list"), [("only", ["foo"]), ("exclude", ["bar"])]
)
def test_ordered_instanced_nested_schema_only_and_exclude(self, param, fields_list):
class NestedSchema(Schema):
foo = fields.String()
bar = fields.String()
class Meta:
ordered = True
class MySchema(Schema):
nested = fields.Nested(NestedSchema(), **{param: fields_list})
assert MySchema().dump({"nested": {"foo": "baz", "bar": "bax"}}) == {
"nested": {"foo": "baz"}
}
class TestListNested:
@pytest.mark.parametrize("param", ("only", "exclude", "dump_only", "load_only"))
def test_list_nested_only_exclude_dump_only_load_only_propagated_to_nested(
self, param
):
class Child(Schema):
name = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.List(fields.Nested(Child))
schema = Family(**{param: ["children.name"]})
assert getattr(schema.fields["children"].inner.schema, param) == {"name"}
@pytest.mark.parametrize(
("param", "expected_attribute", "expected_dump"),
(
("only", {"name"}, {"children": [{"name": "Lily"}]}),
("exclude", {"name", "surname", "age"}, {"children": [{}]}),
),
)
def test_list_nested_class_only_and_exclude_merged_with_nested(
self, param, expected_attribute, expected_dump
):
class Child(Schema):
name = fields.String()
surname = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.List(fields.Nested(Child, **{param: ("name", "surname")}))
schema = Family(**{param: ["children.name", "children.age"]})
assert getattr(schema.fields["children"].inner, param) == expected_attribute
family = {"children": [{"name": "Lily", "surname": "Martinez", "age": 15}]}
assert schema.dump(family) == expected_dump
def test_list_nested_class_multiple_dumps(self):
class Child(Schema):
name = fields.String()
surname = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.List(fields.Nested(Child, only=("name", "age")))
family = {"children": [{"name": "Lily", "surname": "Martinez", "age": 15}]}
assert Family(only=("children.age",)).dump(family) == {
"children": [{"age": 15}]
}
assert Family(only=("children.name",)).dump(family) == {
"children": [{"name": "Lily"}]
}
@pytest.mark.parametrize(
("param", "expected_attribute", "expected_dump"),
(
("only", {"name"}, {"children": [{"name": "Lily"}]}),
("exclude", {"name", "surname", "age"}, {"children": [{}]}),
),
)
def test_list_nested_instance_only_and_exclude_merged_with_nested(
self, param, expected_attribute, expected_dump
):
class Child(Schema):
name = fields.String()
surname = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.List(fields.Nested(Child(**{param: ("name", "surname")})))
schema = Family(**{param: ["children.name", "children.age"]})
assert (
getattr(schema.fields["children"].inner.schema, param) == expected_attribute
)
family = {"children": [{"name": "Lily", "surname": "Martinez", "age": 15}]}
assert schema.dump(family) == expected_dump
def test_list_nested_instance_multiple_dumps(self):
class Child(Schema):
name = fields.String()
surname = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.List(fields.Nested(Child(only=("name", "age"))))
family = {"children": [{"name": "Lily", "surname": "Martinez", "age": 15}]}
assert Family(only=("children.age",)).dump(family) == {
"children": [{"age": 15}]
}
assert Family(only=("children.name",)).dump(family) == {
"children": [{"name": "Lily"}]
}
@pytest.mark.parametrize(
("param", "expected_attribute", "expected_dump"),
(
("only", {"name"}, {"children": [{"name": "Lily"}]}),
("exclude", {"name", "surname", "age"}, {"children": [{}]}),
),
)
def test_list_nested_lambda_only_and_exclude_merged_with_nested(
self, param, expected_attribute, expected_dump
):
class Child(Schema):
name = fields.String()
surname = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.List(
fields.Nested(lambda: Child(**{param: ("name", "surname")}))
)
schema = Family(**{param: ["children.name", "children.age"]})
assert (
getattr(schema.fields["children"].inner.schema, param) == expected_attribute
)
family = {"children": [{"name": "Lily", "surname": "Martinez", "age": 15}]}
assert schema.dump(family) == expected_dump
def test_list_nested_partial_propagated_to_nested(self):
class Child(Schema):
name = fields.String(required=True)
age = fields.Integer(required=True)
class Family(Schema):
children = fields.List(fields.Nested(Child))
payload = {"children": [{"name": "Lucette"}]}
for val in (True, ("children.age",)):
result = Family(partial=val).load(payload)
assert result["children"][0]["name"] == "Lucette"
result = Family().load(payload, partial=val)
assert result["children"][0]["name"] == "Lucette"
for val in (False, ("children.name",)):
with pytest.raises(ValidationError) as excinfo:
result = Family(partial=val).load(payload)
assert excinfo.value.args[0] == {
"children": {0: {"age": ["Missing data for required field."]}}
}
with pytest.raises(ValidationError) as excinfo:
result = Family().load(payload, partial=val)
assert excinfo.value.args[0] == {
"children": {0: {"age": ["Missing data for required field."]}}
}
class TestTupleNested:
@pytest.mark.parametrize("param", ("dump_only", "load_only"))
def test_tuple_nested_only_exclude_dump_only_load_only_propagated_to_nested(
self, param
):
class Child(Schema):
name = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.Tuple((fields.Nested(Child), fields.Nested(Child)))
schema = Family(**{param: ["children.name"]})
assert getattr(schema.fields["children"].tuple_fields[0].schema, param) == {
"name"
}
assert getattr(schema.fields["children"].tuple_fields[1].schema, param) == {
"name"
}
def test_tuple_nested_partial_propagated_to_nested(self):
class Child(Schema):
name = fields.String(required=True)
age = fields.Integer(required=True)
class Family(Schema):
children = fields.Tuple((fields.Nested(Child),))
payload = {"children": [{"name": "Lucette"}]}
for val in (True, ("children.age",)):
result = Family(partial=val).load(payload)
assert result["children"][0]["name"] == "Lucette"
result = Family().load(payload, partial=val)
assert result["children"][0]["name"] == "Lucette"
for val in (False, ("children.name",)):
with pytest.raises(ValidationError) as excinfo:
result = Family(partial=val).load(payload)
assert excinfo.value.args[0] == {
"children": {0: {"age": ["Missing data for required field."]}}
}
with pytest.raises(ValidationError) as excinfo:
result = Family().load(payload, partial=val)
assert excinfo.value.args[0] == {
"children": {0: {"age": ["Missing data for required field."]}}
}
class TestDictNested:
@pytest.mark.parametrize("param", ("only", "exclude", "dump_only", "load_only"))
def test_dict_nested_only_exclude_dump_only_load_only_propagated_to_nested(
self, param
):
class Child(Schema):
name = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.Dict(values=fields.Nested(Child))
schema = Family(**{param: ["children.name"]})
assert getattr(schema.fields["children"].value_field.schema, param) == {"name"}
@pytest.mark.parametrize(
("param", "expected"),
(("only", {"name"}), ("exclude", {"name", "surname", "age"})),
)
def test_dict_nested_only_and_exclude_merged_with_nested(self, param, expected):
class Child(Schema):
name = fields.String()
surname = fields.String()
age = fields.Integer()
class Family(Schema):
children = fields.Dict(
values=fields.Nested(Child, **{param: ("name", "surname")})
)
schema = Family(**{param: ["children.name", "children.age"]})
assert getattr(schema.fields["children"].value_field, param) == expected
def test_dict_nested_partial_propagated_to_nested(self):
class Child(Schema):
name = fields.String(required=True)
age = fields.Integer(required=True)
class Family(Schema):
children = fields.Dict(values=fields.Nested(Child))
payload = {"children": {"daughter": {"name": "Lucette"}}}
for val in (True, ("children.age",)):
result = Family(partial=val).load(payload)
assert result["children"]["daughter"]["name"] == "Lucette"
result = Family().load(payload, partial=val)
assert result["children"]["daughter"]["name"] == "Lucette"
for val in (False, ("children.name",)):
with pytest.raises(ValidationError) as excinfo:
result = Family(partial=val).load(payload)
assert excinfo.value.args[0] == {
"children": {
"daughter": {"value": {"age": ["Missing data for required field."]}}
}
}
with pytest.raises(ValidationError) as excinfo:
result = Family().load(payload, partial=val)
assert excinfo.value.args[0] == {
"children": {
"daughter": {"value": {"age": ["Missing data for required field."]}}
}
}