-
Notifications
You must be signed in to change notification settings - Fork 91
Expand file tree
/
Copy pathembedded.py
More file actions
343 lines (295 loc) · 10.5 KB
/
Copy pathembedded.py
File metadata and controls
343 lines (295 loc) · 10.5 KB
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
# Patchwork - automated patch tracking system
# Copyright (C) 2017 Stephen Finucane <stephen@that.guru>
#
# SPDX-License-Identifier: GPL-2.0-or-later
"""Serializers for embedded use.
A collection of serializers. None of the serializers here should reference
nested fields.
"""
from collections import OrderedDict
from rest_framework.serializers import CharField
from rest_framework.serializers import PrimaryKeyRelatedField
from rest_framework.serializers import SerializerMethodField
from patchwork.api.base import BaseHyperlinkedModelSerializer
from patchwork.api.base import NestedHyperlinkedIdentityField
from patchwork import models
class SerializedRelatedField(PrimaryKeyRelatedField):
"""
A read-write field that expects a primary key for writes and returns a
serialized version of the underlying field on reads.
"""
def use_pk_only_optimization(self):
# We're using embedded serializers so we want the whole object
return False
def get_queryset(self):
return self._Serializer.Meta.model.objects.all()
def get_choices(self, cutoff=None):
# Override this so we don't call 'to_representation', which no longer
# returns a flat value
queryset = self.get_queryset()
if queryset is None:
# Ensure that field.choices returns something sensible
# even when accessed with a read-only field.
return {}
if cutoff is not None:
queryset = queryset[:cutoff]
return OrderedDict(
[(item.pk, self.display_value(item)) for item in queryset]
)
def to_representation(self, data):
return self._Serializer(context=self.context).to_representation(data)
class MboxMixin(BaseHyperlinkedModelSerializer):
"""Embed a link to the mbox URL.
This field is just way too useful to leave out of even the embedded
serialization.
"""
mbox = SerializerMethodField()
def get_mbox(self, instance):
request = self.context.get('request')
return request.build_absolute_uri(instance.get_mbox_url())
class WebURLMixin(BaseHyperlinkedModelSerializer):
"""Embed a link to the web URL."""
web_url = SerializerMethodField()
def get_web_url(self, instance):
request = self.context.get('request')
return request.build_absolute_uri(instance.get_absolute_url())
class CheckSerializer(SerializedRelatedField):
class _Serializer(BaseHyperlinkedModelSerializer):
url = NestedHyperlinkedIdentityField(
'api-check-detail',
lookup_field_mapping={
'patch_id': 'patch_id',
'check_id': 'id',
},
)
def to_representation(self, instance):
data = super(CheckSerializer._Serializer, self).to_representation(
instance
)
data['state'] = instance.get_state_display()
return data
class Meta:
model = models.Check
fields = ('id', 'url', 'date', 'state', 'target_url', 'context')
read_only_fields = fields
extra_kwargs = {
'url': {'view_name': 'api-check-detail'},
}
class CoverSerializer(SerializedRelatedField):
class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer):
class Meta:
model = models.Cover
fields = (
'id',
'url',
'web_url',
'msgid',
# TODO(stephenfin): Drop this in a future API version - it is
# too slow to calculate and not necessary here.
'list_archive_url',
'date',
'name',
'mbox',
)
read_only_fields = fields
versioned_fields = {
'1.1': (
'web_url',
'mbox',
),
'1.2': ('list_archive_url',),
}
extra_kwargs = {
'url': {'view_name': 'api-cover-detail'},
}
class CoverCommentSerializer(SerializedRelatedField):
class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer):
url = NestedHyperlinkedIdentityField(
'api-cover-comment-detail',
lookup_field_mapping={
'cover_id': 'cover_id',
'comment_id': 'id',
},
)
class Meta:
model = models.CoverComment
fields = (
'id',
'url',
'web_url',
'msgid',
# TODO(stephenfin): Drop this in a future API version - it is
# too slow to calculate and not necessary here.
'list_archive_url',
'date',
)
read_only_fields = fields
versioned_fields = {
'1.1': (
'web_url',
'mbox',
),
'1.2': ('list_archive_url',),
'1.3': ('url',),
}
extra_kwargs = {
'url': {'view_name': 'api-cover-comment-detail'},
}
class PatchSerializer(SerializedRelatedField):
class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer):
class Meta:
model = models.Patch
fields = (
'id',
'url',
'web_url',
'msgid',
# TODO(stephenfin): Drop this in a future API version - it is
# too slow to calculate and not necessary here.
'list_archive_url',
'date',
'name',
'mbox',
)
read_only_fields = fields
versioned_fields = {
'1.1': ('web_url',),
'1.2': ('list_archive_url',),
}
extra_kwargs = {
'url': {'view_name': 'api-patch-detail'},
}
class PatchCommentSerializer(SerializedRelatedField):
class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer):
url = NestedHyperlinkedIdentityField(
'api-patch-comment-detail',
lookup_field_mapping={
'patch_id': 'patch_id',
'comment_id': 'id',
},
)
class Meta:
model = models.PatchComment
fields = (
'id',
'url',
'web_url',
'msgid',
# TODO(stephenfin): Drop this in a future API version - it is
# too slow to calculate and not necessary here.
'list_archive_url',
'date',
)
read_only_fields = fields
versioned_fields = {
'1.1': (
'web_url',
'mbox',
),
'1.2': ('list_archive_url',),
'1.3': ('url',),
}
extra_kwargs = {
'url': {'view_name': 'api-patch-comment-detail'},
}
class PersonSerializer(SerializedRelatedField):
class _Serializer(BaseHyperlinkedModelSerializer):
class Meta:
model = models.Person
fields = ('id', 'url', 'name', 'email')
read_only_fields = fields
extra_kwargs = {
'url': {'view_name': 'api-person-detail'},
}
class ProjectSerializer(SerializedRelatedField):
class _Serializer(BaseHyperlinkedModelSerializer):
link_name = CharField(max_length=255, source='linkname')
list_id = CharField(max_length=255, source='listid')
list_email = CharField(max_length=200, source='listemail')
class Meta:
model = models.Project
fields = (
'id',
'url',
'name',
'link_name',
'list_id',
'list_email',
'web_url',
'scm_url',
'webscm_url',
# TODO(stephenfin): Drop this in a future API version - it is
# too slow to calculate and not necessary here.
'list_archive_url',
# TODO(stephenfin): Ditto
'list_archive_url_format',
# TODO(stephenfin): Ditto
'commit_url_format',
)
read_only_fields = fields
extra_kwargs = {
'url': {'view_name': 'api-project-detail'},
}
versioned_fields = {
'1.2': (
'list_archive_url',
'list_archive_url_format',
'commit_url_format',
),
}
class SeriesSerializer(SerializedRelatedField):
class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer):
class Meta:
model = models.Series
fields = (
'id',
'url',
'web_url',
'date',
'name',
'version',
'mbox',
)
read_only_fields = fields
versioned_fields = {
'1.1': ('web_url',),
}
extra_kwargs = {
'url': {'view_name': 'api-series-detail'},
}
class UserSerializer(SerializedRelatedField):
class _Serializer(BaseHyperlinkedModelSerializer):
class Meta:
model = models.User
fields = (
'id',
'url',
'username',
'first_name',
'last_name',
'email',
)
read_only_fields = fields
extra_kwargs = {
'url': {'view_name': 'api-user-detail'},
}
class UserProfileSerializer(SerializedRelatedField):
class _Serializer(BaseHyperlinkedModelSerializer):
username = CharField(source='user.username')
first_name = CharField(source='user.first_name')
last_name = CharField(source='user.last_name')
email = CharField(source='user.email')
class Meta:
model = models.UserProfile
fields = (
'id',
'url',
'username',
'first_name',
'last_name',
'email',
)
read_only_fields = fields
extra_kwargs = {
'url': {'view_name': 'api-user-detail'},
}