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
|
import pytest
from pydantic_core import CoreSchema
from pydantic import BaseModel, GetJsonSchemaHandler, ValidationError, model_validator, parse_obj_as
from pydantic.functional_serializers import model_serializer
from pydantic.json_schema import JsonSchemaValue
class Model(BaseModel):
a: float
b: int = 10
def test_obj():
m = Model.model_validate(dict(a=10.2))
assert str(m) == 'a=10.2 b=10'
def test_model_validate_fails():
with pytest.raises(ValidationError) as exc_info:
Model.model_validate([1, 2, 3])
assert exc_info.value.errors(include_url=False) == [
{
'type': 'model_type',
'loc': (),
'msg': 'Input should be a valid dictionary or instance of Model',
'input': [1, 2, 3],
'ctx': {'class_name': 'Model'},
}
]
def test_model_validate_submodel():
m = Model.model_validate(Model(a=10.2))
assert m.model_dump() == {'a': 10.2, 'b': 10}
def test_model_validate_wrong_model():
class Foo(BaseModel):
c: int = 123
with pytest.raises(ValidationError) as exc_info:
Model.model_validate(Foo())
assert exc_info.value.errors(include_url=False) == [
{
'type': 'model_type',
'loc': (),
'msg': 'Input should be a valid dictionary or instance of Model',
'input': Foo(),
'ctx': {'class_name': 'Model'},
}
]
with pytest.raises(ValidationError) as exc_info:
Model.model_validate(Foo().model_dump())
assert exc_info.value.errors(include_url=False) == [
{'input': {'c': 123}, 'loc': ('a',), 'msg': 'Field required', 'type': 'missing'}
]
def test_root_model_error():
with pytest.raises(
TypeError, match="To define root models, use `pydantic.RootModel` rather than a field called '__root__'"
):
class MyModel(BaseModel):
__root__: str
def test_model_validate_root():
class MyModel(BaseModel):
root: str
# Note that the following three definitions require no changes across all __root__ models
# I couldn't see a nice way to create a decorator that reduces the boilerplate,
# but if we want to discourage this pattern, perhaps that's okay?
@model_validator(mode='before')
@classmethod
def populate_root(cls, values):
return {'root': values}
@model_serializer(mode='wrap')
def _serialize(self, handler, info):
data = handler(self)
if info.mode == 'json':
return data['root']
else:
return data
@classmethod
def __get_pydantic_json_schema__(
cls, core_schema: CoreSchema, handler: GetJsonSchemaHandler
) -> JsonSchemaValue:
json_schema = handler(core_schema)
root = handler.resolve_ref_schema(json_schema)['properties']['root']
return root
# Validation
m = MyModel.model_validate('a')
assert m.root == 'a'
# Serialization
assert m.model_dump() == {'root': 'a'}
assert m.model_dump_json() == '"a"'
# JSON schema
assert m.model_json_schema() == {'title': 'Root', 'type': 'string'}
def test_parse_root_list():
class MyModel(BaseModel):
root: list[str]
@model_validator(mode='before')
@classmethod
def populate_root(cls, values):
return {'root': values}
@model_serializer(mode='wrap')
def _serialize(self, handler, info):
data = handler(self)
if info.mode == 'json':
return data['root']
else:
return data
@classmethod
def model_modify_json_schema(cls, json_schema):
return json_schema['properties']['root']
m = MyModel.model_validate(['a'])
assert m.model_dump() == {'root': ['a']}
assert m.model_dump_json() == '["a"]'
assert m.root == ['a']
def test_parse_nested_root_list():
class NestedData(BaseModel):
id: str
class NestedModel(BaseModel):
root: list[NestedData]
@model_validator(mode='before')
@classmethod
def populate_root(cls, values):
return {'root': values}
@model_serializer(mode='wrap')
def _serialize(self, handler, info):
data = handler(self)
if info.mode == 'json':
return data['root']
else:
return data
@classmethod
def model_modify_json_schema(cls, json_schema):
return json_schema['properties']['root']
class MyModel(BaseModel):
nested: NestedModel
m = MyModel.model_validate({'nested': [{'id': 'foo'}]})
assert isinstance(m.nested, NestedModel)
assert isinstance(m.nested.root[0], NestedData)
@pytest.mark.filterwarnings('ignore:`parse_obj_as` is deprecated.*:DeprecationWarning')
def test_parse_nested_root_tuple():
class NestedData(BaseModel):
id: str
class NestedModel(BaseModel):
root: tuple[int, NestedData]
@model_validator(mode='before')
@classmethod
def populate_root(cls, values):
return {'root': values}
@model_serializer(mode='wrap')
def _serialize(self, handler, info):
data = handler(self)
if info.mode == 'json':
return data['root']
else:
return data
@classmethod
def model_modify_json_schema(cls, json_schema):
return json_schema['properties']['root']
class MyModel(BaseModel):
nested: list[NestedModel]
data = [0, {'id': 'foo'}]
m = MyModel.model_validate({'nested': [data]})
assert isinstance(m.nested[0], NestedModel)
assert isinstance(m.nested[0].root[1], NestedData)
nested = parse_obj_as(NestedModel, data)
assert isinstance(nested, NestedModel)
def test_parse_nested_custom_root():
class NestedModel(BaseModel):
root: list[str]
@model_validator(mode='before')
@classmethod
def populate_root(cls, values):
return {'root': values}
@model_serializer(mode='wrap')
def _serialize(self, handler, info):
data = handler(self)
if info.mode == 'json':
return data['root']
else:
return data
@classmethod
def model_modify_json_schema(cls, json_schema):
return json_schema['properties']['root']
class MyModel(BaseModel):
root: NestedModel
@model_validator(mode='before')
@classmethod
def populate_root(cls, values):
return {'root': values}
@model_serializer(mode='wrap')
def _serialize(self, handler, info):
data = handler(self)
if info.mode == 'json':
return data['root']
else:
return data
@classmethod
def model_modify_json_schema(cls, json_schema):
return json_schema['properties']['root']
nested = ['foo', 'bar']
m = MyModel.model_validate(nested)
assert isinstance(m, MyModel)
assert isinstance(m.root, NestedModel)
assert isinstance(m.root.root, list)
assert isinstance(m.root.root[0], str)
def test_json():
assert Model.model_validate_json('{"a": 12, "b": 8}') == Model(a=12, b=8)
|
