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
|
import datetime as dt
from collections import OrderedDict
import pytest
from marshmallow import EXCLUDE, Schema, fields
from marshmallow.warnings import RemovedInMarshmallow4Warning
from tests.base import User
class TestUnordered:
class UnorderedSchema(Schema):
name = fields.Str()
email = fields.Str()
class Meta:
ordered = False
def test_unordered_dump_returns_dict(self):
schema = self.UnorderedSchema()
u = User("steve", email="steve@steve.steve")
result = schema.dump(u)
assert not isinstance(result, OrderedDict)
assert type(result) is dict
def test_unordered_load_returns_dict(self):
schema = self.UnorderedSchema()
result = schema.load({"name": "steve", "email": "steve@steve.steve"})
assert not isinstance(result, OrderedDict)
assert type(result) is dict
class KeepOrder(Schema):
class Meta:
ordered = True
name = fields.String(allow_none=True)
email = fields.Email(allow_none=True)
age = fields.Integer()
created = fields.DateTime()
id = fields.Integer(allow_none=True)
homepage = fields.Url()
birthdate = fields.Date()
class OrderedMetaSchema(Schema):
id = fields.Int(allow_none=True)
email = fields.Email(allow_none=True)
class Meta:
fields = ("name", "email", "age", "created", "id", "homepage", "birthdate")
ordered = True
class OrderedNestedOnly(Schema):
class Meta:
ordered = True
user = fields.Nested(KeepOrder)
class TestFieldOrdering:
def test_ordered_option_is_deprecate(self):
with pytest.warns(RemovedInMarshmallow4Warning):
class MySchema(Schema):
class Meta:
ordered = True
with pytest.warns(RemovedInMarshmallow4Warning):
class MySchema(Schema):
class Meta:
ordered = False
@pytest.mark.parametrize("with_meta", (False, True))
def test_ordered_option_is_inherited(self, user, with_meta):
class ParentUnordered(Schema):
class Meta:
ordered = False
# KeepOrder is before ParentUnordered in MRO,
# so ChildOrderedSchema will be ordered
class ChildOrderedSchema(KeepOrder, ParentUnordered):
if with_meta:
class Meta:
pass
schema = ChildOrderedSchema()
assert schema.opts.ordered is True
assert schema.dict_class == OrderedDict
data = schema.dump(user)
keys = list(data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
# KeepOrder is before ParentUnordered in MRO,
# so ChildOrderedSchema will be ordered
class ChildUnorderedSchema(ParentUnordered, KeepOrder):
class Meta:
pass
schema = ChildUnorderedSchema()
assert schema.opts.ordered is False
def test_ordering_is_off_by_default(self):
class DummySchema(Schema):
pass
schema = DummySchema()
assert schema.ordered is False
def test_declared_field_order_is_maintained_on_dump(self, user):
ser = KeepOrder()
data = ser.dump(user)
keys = list(data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
def test_declared_field_order_is_maintained_on_load(self, serialized_user):
schema = KeepOrder(unknown=EXCLUDE)
data = schema.load(serialized_user)
keys = list(data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
def test_nested_field_order_with_only_arg_is_maintained_on_dump(self, user):
schema = OrderedNestedOnly()
data = schema.dump({"user": user})
user_data = data["user"]
keys = list(user_data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
def test_nested_field_order_with_only_arg_is_maintained_on_load(self):
schema = OrderedNestedOnly()
data = schema.load(
{
"user": {
"name": "Foo",
"email": "Foo@bar.com",
"age": 42,
"created": dt.datetime.now().isoformat(),
"id": 123,
"homepage": "http://foo.com",
"birthdate": dt.datetime.now().date().isoformat(),
}
}
)
user_data = data["user"]
keys = list(user_data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
def test_nested_field_order_with_exclude_arg_is_maintained(self, user):
class HasNestedExclude(Schema):
user = fields.Nested(KeepOrder, exclude=("birthdate",))
ser = HasNestedExclude()
data = ser.dump({"user": user})
user_data = data["user"]
keys = list(user_data)
assert keys == ["name", "email", "age", "created", "id", "homepage"]
def test_meta_fields_order_is_maintained_on_dump(self, user):
ser = OrderedMetaSchema()
data = ser.dump(user)
keys = list(data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
def test_meta_fields_order_is_maintained_on_load(self, serialized_user):
schema = OrderedMetaSchema(unknown=EXCLUDE)
data = schema.load(serialized_user)
keys = list(data)
assert keys == [
"name",
"email",
"age",
"created",
"id",
"homepage",
"birthdate",
]
class TestIncludeOption:
class AddFieldsSchema(Schema):
name = fields.Str()
class Meta:
include = {"from": fields.Str()}
def test_fields_are_added(self):
s = self.AddFieldsSchema()
in_data = {"name": "Steve", "from": "Oskosh"}
result = s.load({"name": "Steve", "from": "Oskosh"})
assert result == in_data
def test_included_fields_ordered_after_declared_fields(self):
class AddFieldsOrdered(Schema):
name = fields.Str()
email = fields.Str()
class Meta:
include = {
"from": fields.Str(),
"in": fields.Str(),
"@at": fields.Str(),
}
s = AddFieldsOrdered()
in_data = {
"name": "Steve",
"from": "Oskosh",
"email": "steve@steve.steve",
"in": "VA",
"@at": "Charlottesville",
}
# declared fields, then "included" fields
expected_fields = ["name", "email", "from", "in", "@at"]
assert list(AddFieldsOrdered._declared_fields.keys()) == expected_fields
result = s.load(in_data)
assert list(result.keys()) == expected_fields
def test_added_fields_are_inherited(self):
class AddFieldsChild(self.AddFieldsSchema):
email = fields.Str()
s = AddFieldsChild()
assert "email" in s._declared_fields
assert "from" in s._declared_fields
assert isinstance(s._declared_fields["from"], fields.Str)
class TestManyOption:
class ManySchema(Schema):
foo = fields.Str()
class Meta:
many = True
def test_many_by_default(self):
test = self.ManySchema()
assert test.load([{"foo": "bar"}]) == [{"foo": "bar"}]
def test_explicit_single(self):
test = self.ManySchema(many=False)
assert test.load({"foo": "bar"}) == {"foo": "bar"}
|
