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
|
from typing import List
import pytest
from testapp.models import Bookmark, Message, Profile, Tagged, Thread, User
from djantic import ModelSchema
@pytest.mark.django_db
def test_get_instance():
"""
Test retrieving an existing Django object to populate the schema model.
"""
user = User.objects.create(
first_name="Jordan", last_name="Eremieff", email="jordan@eremieff.com"
)
class UserSchema(ModelSchema):
class Config:
model = User
include = ["id", "first_name"]
assert UserSchema.from_django(user).dict() == {"first_name": "Jordan", "id": 1}
@pytest.mark.django_db
def test_get_instance_with_generic_foreign_key():
bookmark = Bookmark.objects.create(url="https://www.djangoproject.com/")
Tagged.objects.create(content_object=bookmark, slug="django")
class TaggedSchema(ModelSchema):
class Config:
model = Tagged
class BookmarkWithTaggedSchema(ModelSchema):
tags: List[TaggedSchema]
class Config:
model = Bookmark
bookmark_with_tagged_schema = BookmarkWithTaggedSchema.from_django(bookmark)
assert bookmark_with_tagged_schema.dict() == {
"id": 1,
"tags": [
{
'content_object': 1,
"content_type": 20,
"id": 1,
"object_id": 1,
"slug": "django",
}
],
"url": "https://www.djangoproject.com/",
}
@pytest.mark.django_db
def test_get_queryset_with_reverse_one_to_one():
"""
Test retrieving a Django queryset with reverse one-to-one relationships.
"""
user_data = [
{"first_name": "Jordan", "email": "jordan@eremieff.com"},
{"first_name": "Sara", "email": "sara@example.com"},
]
for kwargs in user_data:
user = User.objects.create(**kwargs)
Profile.objects.create(user=user, location="Australia")
class UserSchema(ModelSchema):
class Config:
model = User
include = ["id", "email", "first_name", "profile"]
users = User.objects.all()
user_schema_qs = UserSchema.from_django(users, many=True)
assert user_schema_qs == [
{
"email": "jordan@eremieff.com",
"first_name": "Jordan",
"id": 1,
"profile": 1,
},
{"email": "sara@example.com", "first_name": "Sara", "id": 2, "profile": 2},
]
# Test when using a declared sub-model
class ProfileSchema(ModelSchema):
class Config:
model = Profile
include = ["id", "location"]
class UserWithProfileSchema(ModelSchema):
profile: ProfileSchema
class Config:
model = User
exclude = ["created_at", "updated_at", "last_name"]
users = User.objects.all()
user_with_profile_schema_qs = UserWithProfileSchema.from_django(users, many=True)
assert user_with_profile_schema_qs == [
{
"email": "jordan@eremieff.com",
"first_name": "Jordan",
"id": 1,
"profile": {"id": 1, "location": "Australia"},
},
{
"email": "sara@example.com",
"first_name": "Sara",
"id": 2,
"profile": {"id": 2, "location": "Australia"},
},
]
@pytest.mark.django_db
def test_get_queryset_with_foreign_key():
"""
Test retrieving a Django queryset with foreign-key relationships.
"""
thread = Thread.objects.create(title="My thread topic")
thread2 = Thread.objects.create(title="Another topic")
for content in ("I agree.", "I disagree!", "lol"):
message_one = Message.objects.create(content=content, thread=thread)
Message.objects.create(content=content, thread=thread2)
class MessageSchema(ModelSchema):
class Config:
model = Message
exclude = ["created_at"]
schema = MessageSchema.from_django(message_one)
assert schema.dict() == {"id": 5, "content": "lol", "thread": 1}
class ThreadSchema(ModelSchema):
class Config:
model = Thread
exclude = ["created_at"]
class MessageWithThreadSchema(ModelSchema):
thread: ThreadSchema
class Config:
model = Message
exclude = ["created_at"]
schema = MessageWithThreadSchema.from_django(message_one)
assert schema.dict() == {
"id": 5,
"content": "lol",
"thread": {
"messages": [{"id": 1}, {"id": 3}, {"id": 5}],
"id": 1,
"title": "My thread topic",
},
}
@pytest.mark.django_db
def test_get_queryset_with_reverse_foreign_key():
"""
Test retrieving a Django queryset with reverse foreign-key relationships.
"""
thread = Thread.objects.create(title="My thread topic")
thread2 = Thread.objects.create(title="Another topic")
for content in ("I agree.", "I disagree!", "lol"):
Message.objects.create(content=content, thread=thread)
Message.objects.create(content=content, thread=thread2)
threads = Thread.objects.all()
class MessageSchema(ModelSchema):
class Config:
model = Message
include = ["id", "content"]
class ThreadSchema(ModelSchema):
class Config:
model = Thread
thread_schema_qs = ThreadSchema.from_django(threads, many=True)
thread_schemas = [t.dict() for t in thread_schema_qs]
assert thread_schemas == [
{
"messages": [{"id": 2}, {"id": 4}, {"id": 6}],
"id": 2,
"title": "Another topic",
},
{
"messages": [{"id": 1}, {"id": 3}, {"id": 5}],
"id": 1,
"title": "My thread topic",
},
]
# Test when using a declared sub-model
class ThreadWithMessageListSchema(ModelSchema):
messages: List[MessageSchema]
class Config:
model = Thread
exclude = ["created_at", "updated_at"]
thread_with_message_list_schema_qs = ThreadWithMessageListSchema.from_django(
threads, many=True
)
assert thread_with_message_list_schema_qs == [
{
"messages": [
{"id": 2, "content": "I agree."},
{"id": 4, "content": "I disagree!"},
{"id": 6, "content": "lol"},
],
"id": 2,
"title": "Another topic",
},
{
"messages": [
{"id": 1, "content": "I agree."},
{"id": 3, "content": "I disagree!"},
{"id": 5, "content": "lol"},
],
"id": 1,
"title": "My thread topic",
},
]
@pytest.mark.django_db
def test_get_queryset_with_generic_foreign_key():
bookmark = Bookmark.objects.create(url="https://github.com")
bookmark.tags.create(slug="tag-1")
bookmark.tags.create(slug="tag-2")
class TaggedSchema(ModelSchema):
class Config:
model = Tagged
class BookmarkSchema(ModelSchema):
class Config:
model = Bookmark
schema = BookmarkSchema.from_django(bookmark)
schema.dict() == {
"id": 1,
"url": "https://github.com",
"tags": [{"id": 1}, {"id": 2}],
}
|
