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
|
import pytest
from marshmallow import Schema, class_registry, fields
from marshmallow.exceptions import RegistryError
def test_serializer_has_class_registry():
class MySchema(Schema):
pass
class MySubSchema(Schema):
pass
assert "MySchema" in class_registry._registry
assert "MySubSchema" in class_registry._registry
# by fullpath
assert "tests.test_registry.MySchema" in class_registry._registry
assert "tests.test_registry.MySubSchema" in class_registry._registry
def test_register_class_meta_option():
class UnregisteredSchema(Schema):
class Meta:
register = False
class RegisteredSchema(Schema):
class Meta:
register = True
class RegisteredOverrideSchema(UnregisteredSchema):
class Meta:
register = True
class UnregisteredOverrideSchema(RegisteredSchema):
class Meta:
register = False
assert "UnregisteredSchema" not in class_registry._registry
assert "tests.test_registry.UnregisteredSchema" not in class_registry._registry
assert "RegisteredSchema" in class_registry._registry
assert "tests.test_registry.RegisteredSchema" in class_registry._registry
assert "RegisteredOverrideSchema" in class_registry._registry
assert "tests.test_registry.RegisteredOverrideSchema" in class_registry._registry
assert "UnregisteredOverrideSchema" not in class_registry._registry
assert (
"tests.test_registry.UnregisteredOverrideSchema" not in class_registry._registry
)
def test_serializer_class_registry_register_same_classname_different_module():
reglen = len(class_registry._registry)
type("MyTestRegSchema", (Schema,), {"__module__": "modA"})
assert "MyTestRegSchema" in class_registry._registry
assert len(class_registry._registry.get("MyTestRegSchema")) == 1
assert "modA.MyTestRegSchema" in class_registry._registry
# storing for classname and fullpath
assert len(class_registry._registry) == reglen + 2
type("MyTestRegSchema", (Schema,), {"__module__": "modB"})
assert "MyTestRegSchema" in class_registry._registry
# aggregating classes with same name from different modules
assert len(class_registry._registry.get("MyTestRegSchema")) == 2
assert "modB.MyTestRegSchema" in class_registry._registry
# storing for same classname (+0) and different module (+1)
assert len(class_registry._registry) == reglen + 2 + 1
type("MyTestRegSchema", (Schema,), {"__module__": "modB"})
assert "MyTestRegSchema" in class_registry._registry
# only the class with matching module has been replaced
assert len(class_registry._registry.get("MyTestRegSchema")) == 2
assert "modB.MyTestRegSchema" in class_registry._registry
# only the class with matching module has been replaced (+0)
assert len(class_registry._registry) == reglen + 2 + 1
def test_serializer_class_registry_override_if_same_classname_same_module():
reglen = len(class_registry._registry)
type("MyTestReg2Schema", (Schema,), {"__module__": "SameModulePath"})
assert "MyTestReg2Schema" in class_registry._registry
assert len(class_registry._registry.get("MyTestReg2Schema")) == 1
assert "SameModulePath.MyTestReg2Schema" in class_registry._registry
assert len(class_registry._registry.get("SameModulePath.MyTestReg2Schema")) == 1
# storing for classname and fullpath
assert len(class_registry._registry) == reglen + 2
type("MyTestReg2Schema", (Schema,), {"__module__": "SameModulePath"})
assert "MyTestReg2Schema" in class_registry._registry
# overriding same class name and same module
assert len(class_registry._registry.get("MyTestReg2Schema")) == 1
assert "SameModulePath.MyTestReg2Schema" in class_registry._registry
# overriding same fullpath
assert len(class_registry._registry.get("SameModulePath.MyTestReg2Schema")) == 1
# overriding for same classname (+0) and different module (+0)
assert len(class_registry._registry) == reglen + 2
class A:
def __init__(self, _id, b=None):
self.id = _id
self.b = b
class B:
def __init__(self, _id, a=None):
self.id = _id
self.a = a
class C:
def __init__(self, _id, bs=None):
self.id = _id
self.bs = bs or []
class ASchema(Schema):
id = fields.Integer()
b = fields.Nested("tests.test_registry.BSchema", exclude=("a",))
class BSchema(Schema):
id = fields.Integer()
a = fields.Nested("tests.test_registry.ASchema")
class CSchema(Schema):
id = fields.Integer()
bs = fields.Nested("tests.test_registry.BSchema", many=True)
def test_two_way_nesting():
a_obj = A(1)
b_obj = B(2, a=a_obj)
a_obj.b = b_obj
a_serialized = ASchema().dump(a_obj)
b_serialized = BSchema().dump(b_obj)
assert a_serialized["b"]["id"] == b_obj.id
assert b_serialized["a"]["id"] == a_obj.id
def test_nesting_with_class_name_many():
c_obj = C(1, bs=[B(2), B(3), B(4)])
c_serialized = CSchema().dump(c_obj)
assert len(c_serialized["bs"]) == len(c_obj.bs)
assert c_serialized["bs"][0]["id"] == c_obj.bs[0].id
def test_invalid_class_name_in_nested_field_raises_error(user):
class MySchema(Schema):
nf = fields.Nested("notfound")
sch = MySchema()
msg = "Class with name {!r} was not found".format("notfound")
with pytest.raises(RegistryError, match=msg):
sch.dump({"nf": None})
class FooSerializer(Schema):
_id = fields.Integer()
def test_multiple_classes_with_same_name_raises_error():
# Import a class with the same name
from .foo_serializer import FooSerializer as FooSerializer1 # noqa: F401
class MySchema(Schema):
foo = fields.Nested("FooSerializer")
# Using a nested field with the class name fails because there are
# two defined classes with the same name
sch = MySchema()
msg = "Multiple classes with name {!r} were found.".format("FooSerializer")
with pytest.raises(RegistryError, match=msg):
sch.dump({"foo": {"_id": 1}})
def test_multiple_classes_with_all():
# Import a class with the same name
from .foo_serializer import FooSerializer as FooSerializer1 # noqa: F401
classes = class_registry.get_class("FooSerializer", all=True)
assert len(classes) == 2
def test_can_use_full_module_path_to_class():
from .foo_serializer import FooSerializer as FooSerializer1 # noqa: F401
# Using full paths is ok
class Schema1(Schema):
foo = fields.Nested("tests.foo_serializer.FooSerializer")
sch = Schema1()
# Note: The arguments here don't matter. What matters is that no
# error is raised
assert sch.dump({"foo": {"_id": 42}})
class Schema2(Schema):
foo = fields.Nested("tests.test_registry.FooSerializer")
sch = Schema2()
assert sch.dump({"foo": {"_id": 42}})
|
