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
|
import datetime
from typing import Optional
import pytest
from pydantic import BaseModel, Field
from testapp.models import User, Profile, Configuration
from djantic import ModelSchema
@pytest.mark.django_db
def test_description():
"""
Test setting the schema description to the docstring of the Pydantic model.
"""
class ProfileSchema(ModelSchema):
"""
Pydantic profile docstring.
"""
class Config:
model = Profile
assert ProfileSchema.schema()["description"] == "Pydantic profile docstring."
class UserSchema(ModelSchema):
"""
Pydantic user docstring.
"""
class Config:
model = User
assert UserSchema.schema()["description"] == "Pydantic user docstring."
# Default will be the model docstring
class UserSchema(ModelSchema):
class Config:
model = User
assert UserSchema.schema()["description"] == "A user of the application."
@pytest.mark.django_db
def test_cache():
"""
Test the schema cache.
"""
class UserSchema(ModelSchema):
class Config:
model = User
include = ["id", "first_name"]
expected = {
"title": "UserSchema",
"description": "A user of the application.",
"type": "object",
"properties": {
"id": {"title": "Id", "description": "id", "type": "integer"},
"first_name": {
"title": "First Name",
"description": "first_name",
"maxLength": 50,
"type": "string",
},
},
"required": ["first_name"],
}
assert True not in UserSchema.__schema_cache__
assert False not in UserSchema.__schema_cache__
assert UserSchema.schema() == expected
assert UserSchema.__schema_cache__.keys() == {(True, "#/definitions/{model}")}
assert UserSchema.schema() == expected
@pytest.mark.django_db
def test_include_exclude():
"""
Test include and exclude rules in the model config.
"""
all_user_fields = [field.name for field in User._meta.get_fields()]
class UserSchema(ModelSchema):
"""
All fields are included by default.
"""
class Config:
model = User
assert set(UserSchema.schema()["properties"].keys()) == set(all_user_fields)
class UserSchema(ModelSchema):
"""
All fields are included explicitly.
"""
class Config:
model = User
assert set(UserSchema.schema()["properties"].keys()) == set(all_user_fields)
class UserSchema(ModelSchema):
"""
Only 'first_name' and 'email' are included.
"""
last_name: str # Fields annotations follow the same config rules
class Config:
model = User
include = ["first_name", "email"]
included = UserSchema.schema()["properties"].keys()
assert set(included) == set(UserSchema.__config__.include)
assert set(included) == set(["first_name", "email"])
class UserSchema(ModelSchema):
"""
Only 'id' and 'profile' are not excluded.
"""
first_name: str
last_name: str
class Config:
model = User
exclude = ["first_name", "last_name", "email", "created_at", "updated_at"]
not_excluded = UserSchema.schema()["properties"].keys()
assert set(not_excluded) == set(
[
field
for field in all_user_fields
if field not in UserSchema.__config__.exclude
]
)
assert set(not_excluded) == set(["profile", "id"])
@pytest.mark.django_db
def test_annotations():
"""
Test annotating fields.
"""
class UserSchema(ModelSchema):
"""
Test required, optional, and function fields.
'first_name' is required in Django model, but optional in schema
'last_name' is optional in Django model, but required in schema
"""
first_name: Optional[str]
last_name: str
class Config:
model = User
include = ["first_name", "last_name"]
assert UserSchema.schema()["required"] == ["last_name"]
updated_at_dt = datetime.datetime(2020, 12, 31, 0, 0)
class UserSchema(ModelSchema):
"""
Test field functions and factory defaults.
"""
first_name: str = Field(default="Hello")
last_name: str = Field(..., min_length=1, max_length=50)
email: str = Field(default_factory=lambda: "jordan@eremieff.com")
created_at: datetime.datetime = Field(default_factory=datetime.datetime.now)
updated_at: datetime.datetime = updated_at_dt
class Config:
model = User
schema = UserSchema.schema()
props = schema["properties"]
assert "default" in props["created_at"]
assert props["email"]["default"] == "jordan@eremieff.com"
assert props["first_name"]["default"] == "Hello"
assert props["updated_at"]["default"] == updated_at_dt.strftime("%Y-%m-%dT00:00:00")
assert set(schema["required"]) == set(["last_name"])
def test_by_alias_generator():
class UserSchema(ModelSchema):
"""
Test alias generator.
"""
class Config:
model = User
include = ["first_name", "last_name"]
@staticmethod
def alias_generator(x):
return x.upper()
assert UserSchema.schema() == {
"title": "UserSchema",
"description": "Test alias generator.",
"type": "object",
"properties": {
"FIRST_NAME": {
"title": "First Name",
"description": "first_name",
"maxLength": 50,
"type": "string",
},
"LAST_NAME": {
"title": "Last Name",
"description": "last_name",
"maxLength": 50,
"type": "string",
},
},
"required": ["FIRST_NAME"],
}
assert set(UserSchema.schema()["properties"].keys()) == set(
["FIRST_NAME", "LAST_NAME"]
)
assert set(UserSchema.schema(by_alias=False)["properties"].keys()) == set(
["first_name", "last_name"]
)
def test_sub_model():
"""
Test compatability with normal Pydantic models.
"""
class SignUp(BaseModel):
"""
Pydantic model as the sub-model.
"""
referral_code: Optional[str]
class ProfileSchema(ModelSchema):
"""
Django model relation as a sub-model.
"""
class Config:
model = Profile
include = ["id"]
class UserSchema(ModelSchema):
sign_up: SignUp
profile: ProfileSchema
class Config:
model = User
include = ["id", "sign_up", "profile"]
assert set(UserSchema.schema()["definitions"].keys()) == set(
["ProfileSchema", "SignUp"]
)
class Notification(BaseModel):
"""
Pydantic model as the main model.
"""
user: UserSchema
content: str
sent_at: datetime.datetime = Field(default_factory=datetime.datetime.now)
assert set(Notification.schema()["properties"].keys()) == set(
["user", "content", "sent_at"]
)
assert set(Notification.schema()["definitions"].keys()) == set(
["ProfileSchema", "SignUp", "UserSchema"]
)
@pytest.mark.django_db
def test_json():
class ConfigurationSchema(ModelSchema):
"""
Test JSON schema.
"""
class Config:
model = Configuration
expected = """{
"title": "ConfigurationSchema",
"description": "Test JSON schema.",
"type": "object",
"properties": {
"id": {
"title": "Id",
"description": "id",
"type": "integer"
},
"config_id": {
"title": "Config Id",
"description": "Unique id of the configuration.",
"type": "string",
"format": "uuid"
},
"name": {
"title": "Name",
"description": "name",
"maxLength": 100,
"type": "string"
},
"permissions": {
"title": "Permissions",
"description": "permissions",
"anyOf": [
{
"type": "string",
"format": "json-string"
},
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"changelog": {
"title": "Changelog",
"description": "changelog",
"anyOf": [
{
"type": "string",
"format": "json-string"
},
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"metadata": {
"title": "Metadata",
"description": "metadata",
"anyOf": [
{
"type": "string",
"format": "json-string"
},
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"version": {
"title": "Version",
"description": "version",
"default": "0.0.1",
"maxLength": 5,
"type": "string"
}
},
"required": [
"name"
]
}"""
assert ConfigurationSchema.schema_json(indent=2) == expected
@pytest.mark.django_db
def test_include_from_annotations():
"""
Test include="__annotations__" config.
"""
class ProfileSchema(ModelSchema):
website: str
class Config:
model = Profile
include = "__annotations__"
assert ProfileSchema.schema() == {
"title": "ProfileSchema",
"description": "A user's profile.",
"type": "object",
"properties": {
"website": {
"title": "Website",
"type": "string"
}
},
"required": [
"website"
]
}
|
