/
serializers.py
executable file
·343 lines (299 loc) · 10.8 KB
/
serializers.py
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
from rest_framework import serializers
from guardian.shortcuts import get_users_with_perms
from webapp.apps.users.serializers import ProjectSerializer
from .models import Inputs, Simulation, PendingPermission, ModelConfig
class OutputsSerializer(serializers.Serializer):
"""
Serialze data from the simulation complete callback.
"""
job_id = serializers.UUIDField()
status = serializers.ChoiceField(choices=(("SUCCESS", "Success"), ("FAIL", "Fail")))
traceback = serializers.CharField(required=False)
model_version = serializers.CharField(required=False)
meta = serializers.JSONField()
outputs = serializers.JSONField(required=False)
# only used with v0!
aggr_outputs = serializers.JSONField(required=False)
version = serializers.CharField(required=False)
def to_internal_value(self, data):
if "task_id" in data:
data["job_id"] = data.pop("task_id")
return super().to_internal_value(data)
class PendingPermissionSerializer(serializers.ModelSerializer):
profile = serializers.StringRelatedField()
grant_url = serializers.CharField(required=False, source="get_absolute_grant_url")
class Meta:
model = PendingPermission
fields = ("grant_url", "profile", "permission_name", "is_expired")
read_only = ("is_expired", "grant_url")
class MiniSimulationSerializer(serializers.ModelSerializer):
"""
Serializer for data about simulations. This does not include
the simulation results. This data is helpful for getting/
setting the title and viewing the simulation's status.
"""
owner = serializers.StringRelatedField(source="get_owner", required=False)
authors = serializers.StringRelatedField(
source="get_authors", many=True, required=False
)
title = serializers.CharField(required=False)
model_pk = serializers.IntegerField(required=False)
project = serializers.StringRelatedField(required=False)
readme = serializers.JSONField(required=False)
status = serializers.CharField(required=False)
api_url = serializers.CharField(required=False, source="get_absolute_api_url")
gui_url = serializers.CharField(required=False, source="get_absolute_url")
is_public = serializers.NullBooleanField(required=False)
# see to_representation
# role = serializers.BooleanField(source="role")
def to_representation(self, obj):
rep = super().to_representation(obj)
if self.context.get("request"):
user = self.context["request"].user
else:
user = None
rep["role"] = obj.role(user)
rep["authors"] = sorted(rep["authors"])
return rep
def validate_is_public(self, value):
if getattr(self, "instance", None) is not None and value is False:
self.instance.make_private_test()
return value
class Meta:
model = Simulation
fields = (
"api_url",
"authors",
"creation_date",
"gui_url",
"is_public",
"model_pk",
"model_version",
"notify_on_completion",
"owner",
"project",
"readme",
# "role",
"status",
"title",
)
read_only = (
"api_url",
"authors",
"creation_date",
"gui_url",
"model_pk",
"model_version",
"owner",
"project",
# "role",
"status",
)
class ModelConfigSerializer(serializers.ModelSerializer):
project = serializers.StringRelatedField()
class Meta:
model = ModelConfig
fields = (
"project",
"model_version",
"meta_parameters_values",
"meta_parameters",
"model_parameters",
"creation_date",
)
read_only = (
"project",
"model_version",
"meta_parameters_values",
"meta_parameters",
"model_parameters",
"creation_date",
)
class InputsSerializer(serializers.ModelSerializer):
"""
Serializer for the Inputs object.
"""
job_id = serializers.UUIDField(required=False)
status = serializers.ChoiceField(
choices=(("SUCCESS", "Success"), ("FAIL", "Fail")), required=False
)
client = serializers.ChoiceField(
choices=(
("web-alpha", "Web-Alpha"),
("web-beta", "Web-Beta"),
("rest-api", "REST API"),
),
required=False,
)
parent_model_pk = serializers.IntegerField(required=False)
job_id = serializers.UUIDField(required=False)
status = serializers.ChoiceField(
choices=(("SUCCESS", "Success"), ("FAIL", "Fail")), required=False
)
api_url = serializers.CharField(source="get_absolute_api_url", required=False)
gui_url = serializers.CharField(source="get_absolute_url", required=False)
sim = MiniSimulationSerializer(required=False)
# Not part of Inputs model but is needed for setting sim completion
# notification status and visibility on sims created from
# /[owner]/[title]/api/v1/
notify_on_completion = serializers.BooleanField(required=False)
is_public = serializers.BooleanField(required=False)
model_config = ModelConfigSerializer(allow_null=True, required=False)
# see to_representation
# role = serializers.BooleanField(source="role")
def to_representation(self, obj):
rep = super().to_representation(obj)
if self.context.get("request"):
user = self.context["request"].user
else:
user = None
rep["role"] = obj.role(user)
rep["sim"]["authors"] = sorted(rep["sim"]["authors"])
return rep
def to_internal_value(self, data):
if "outputs" in data:
data.update(**data.pop("outputs"))
if "task_id" in data:
data["job_id"] = data.pop("task_id")
return super().to_internal_value(data)
class Meta:
model = Inputs
fields = (
"adjustment",
"api_url",
"client",
"custom_adjustment",
"errors_warnings",
"gui_url",
"is_public",
"job_id",
"meta_parameters",
"model_config",
"notify_on_completion",
"parent_model_pk",
"role",
"sim",
"status",
"traceback",
)
class SimAccessSerializer(serializers.Serializer):
"""Serialize user's permissions for a given simulation"""
is_owner = serializers.BooleanField(required=False)
role = serializers.ChoiceField(
required=True, choices=("read", "write", "admin"), allow_null=True
)
username = serializers.CharField(required=True)
msg = serializers.CharField(required=False, allow_blank=True)
@staticmethod
def ser(sim: Simulation, user=None):
"""
Hacked on method for serializing data that doesn't quite fit the
drf ModelSerialization approach.
"""
return {
"is_owner": sim.is_owner(user),
"role": sim.role(user),
"username": user.username,
}
class Meta:
fields = ("is_owner", "role", "username", "msg")
read_only = ("is_owner",)
write_only = ("msg",)
class SimulationSerializer(serializers.ModelSerializer):
"""
Serializer for entire Simulation object. This contains meta
data about simulations as well as the outputs. The outputs
can be either the full outputs or references to their
location in the storage bucket.
"""
api_url = serializers.CharField(source="get_absolute_api_url")
gui_url = serializers.CharField(source="get_absolute_url")
eta = serializers.FloatField(source="compute_eta")
original_eta = serializers.FloatField(source="compute_original_eta")
title = serializers.CharField(required=False)
owner = serializers.StringRelatedField(source="get_owner", required=False)
authors = serializers.StringRelatedField(source="get_authors", many=True)
project = ProjectSerializer()
outputs_version = serializers.CharField()
# see to_representation for definition of parent_sims:
# parent_sims = MiniSimulationSerializer(many=True)
# role = serializers.BooleanField(source="role")
def to_representation(self, obj):
rep = super().to_representation(obj)
if self.context.get("request"):
user = self.context["request"].user
else:
user = None
rep["parent_sims"] = MiniSimulationSerializer(
obj.parent_sims(user=user), many=True
).data
rep["role"] = obj.role(user)
rep["authors"] = sorted(rep["authors"])
if obj.has_admin_access(user):
rep["pending_permissions"] = PendingPermissionSerializer(
instance=obj.pending_permissions.all(), many=True
).data
permission_objects = get_users_with_perms(obj)
rep["access"] = []
for user in permission_objects:
rep["access"].append(SimAccessSerializer.ser(obj, user))
elif (
user is not None
and user.is_authenticated
and obj.pending_permissions.filter(profile__user=user).count() > 0
):
rep["pending_permissions"] = PendingPermissionSerializer(
instance=obj.pending_permissions.filter(profile__user=user), many=True
).data
return rep
class Meta:
model = Simulation
fields = (
"api_url",
"authors",
"creation_date",
"eta",
"exp_comp_datetime",
"gui_url",
"is_public",
"model_pk",
"model_version",
"notify_on_completion",
"original_eta",
"outputs",
"owner",
"outputs_version",
# "parent_sims",
"project",
"readme",
# "role",
"run_time",
"status",
"title",
"traceback",
)
read_only = (
"api_url",
"authors",
"creation_date",
"eta",
"exp_comp_datetime",
"gui_url",
"model_pk",
"model_version",
"original_eta",
"outputs",
"owner",
"outputs_version",
# "parent_sims",
"project",
# "role",
"run_time",
"status",
"traceback",
)
class AuthorSerializer(serializers.Serializer):
username = serializers.CharField(required=True)
msg = serializers.CharField(required=False, allow_blank=True)
class AddAuthorsSerializer(serializers.Serializer):
authors = serializers.ListField(child=AuthorSerializer(), max_length=10)