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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
|
from random import choice
from unittest import mock
import pytest
from django.db import models
from rest_framework import serializers, viewsets
from rest_framework.decorators import api_view
from rest_framework.response import Response
from drf_spectacular.openapi import AutoSchema
from drf_spectacular.utils import (
OpenApiParameter, PolymorphicProxySerializer, extend_schema, extend_schema_field,
)
from tests import assert_schema, generate_schema, get_request_schema, get_response_schema
class LegalPerson2(models.Model):
company_name = models.CharField(max_length=30)
class NaturalPerson2(models.Model):
first_name = models.CharField(max_length=30)
last_name = models.CharField(max_length=30)
class LegalPersonSerializer(serializers.ModelSerializer):
type = serializers.SerializerMethodField()
class Meta:
model = LegalPerson2
fields = ('id', 'company_name', 'type')
def get_type(self, obj) -> str:
return 'legal'
class NaturalPersonSerializer(serializers.ModelSerializer):
type = serializers.SerializerMethodField()
class Meta:
model = NaturalPerson2
fields = ('id', 'first_name', 'last_name', 'type')
def get_type(self, obj) -> str:
return 'natural'
PROXY_SERIALIZER_PARAMS = {
'component_name': 'MetaPerson',
'serializers': [LegalPersonSerializer, NaturalPersonSerializer],
'resource_type_field_name': 'type',
}
with mock.patch('rest_framework.settings.api_settings.DEFAULT_SCHEMA_CLASS', AutoSchema):
implicit_poly_proxy = PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=[LegalPersonSerializer, NaturalPersonSerializer],
resource_type_field_name='type',
)
class ImplicitPersonViewSet(viewsets.GenericViewSet):
@extend_schema(request=implicit_poly_proxy, responses=implicit_poly_proxy)
def create(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
@extend_schema(
request=implicit_poly_proxy,
responses=implicit_poly_proxy,
parameters=[OpenApiParameter('id', int, OpenApiParameter.PATH)],
)
def partial_update(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
explicit_poly_proxy = PolymorphicProxySerializer(
component_name='MetaPerson',
serializers={
'legal': LegalPersonSerializer,
'natural': NaturalPersonSerializer,
},
resource_type_field_name='type',
)
class ExplicitPersonViewSet(viewsets.GenericViewSet):
@extend_schema(request=explicit_poly_proxy, responses=explicit_poly_proxy)
def create(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
@extend_schema(
request=explicit_poly_proxy,
responses=explicit_poly_proxy,
parameters=[OpenApiParameter('id', int, OpenApiParameter.PATH)],
)
def partial_update(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
lambda_poly_proxy = PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=lambda: [LegalPersonSerializer, NaturalPersonSerializer],
resource_type_field_name='type',
)
class LambdaPersonViewSet(viewsets.GenericViewSet):
@extend_schema(request=lambda_poly_proxy, responses=lambda_poly_proxy)
def create(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
@extend_schema(
request=lambda_poly_proxy,
responses=lambda_poly_proxy,
parameters=[OpenApiParameter('id', int, OpenApiParameter.PATH)],
)
def partial_update(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
@pytest.mark.parametrize('viewset', [ImplicitPersonViewSet, ExplicitPersonViewSet, LambdaPersonViewSet])
def test_polymorphic(no_warnings, viewset):
assert_schema(
generate_schema('persons', viewset),
'tests/test_polymorphic.yml'
)
def test_polymorphic_serializer_as_field_via_extend_schema_field(no_warnings):
@extend_schema_field(
PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=[LegalPersonSerializer, NaturalPersonSerializer],
resource_type_field_name='type',
)
)
class XField(serializers.DictField):
pass # pragma: no cover
class XSerializer(serializers.Serializer):
field = XField()
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['GET'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert 'MetaPerson' in schema['components']['schemas']
assert 'MetaPerson' in schema['components']['schemas']['X']['properties']['field']['$ref']
def test_polymorphic_serializer_as_method_field_via_extend_schema_field(no_warnings):
class XSerializer(serializers.Serializer):
field = serializers.SerializerMethodField()
@extend_schema_field(
PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=[LegalPersonSerializer, NaturalPersonSerializer],
resource_type_field_name='type',
)
)
def get_field(self, request):
pass # pragma: no cover
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['GET'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert 'MetaPerson' in schema['components']['schemas']
assert schema['components']['schemas']['X'] == {
'type': 'object',
'properties': {
'field': {'allOf': [{'$ref': '#/components/schemas/MetaPerson'}], 'readOnly': True}
},
'required': ['field']
}
def test_stripped_down_polymorphic_serializer(no_warnings):
@extend_schema_field(
PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=[LegalPersonSerializer, NaturalPersonSerializer],
resource_type_field_name=None,
)
)
class XField(serializers.DictField):
pass # pragma: no cover
class XSerializer(serializers.Serializer):
field = XField()
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['GET'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
assert schema['components']['schemas']['MetaPerson'] == {'oneOf': [
{'$ref': '#/components/schemas/LegalPerson'},
{'$ref': '#/components/schemas/NaturalPerson'}
]}
@pytest.mark.parametrize('explicit', [True, False])
def test_many_polymorphic_serializer_extend_schema(no_warnings, explicit):
if explicit:
proxy_serializer = serializers.ListSerializer(
child=PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS)
)
else:
proxy_serializer = PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS, many=True)
@extend_schema(request=proxy_serializer, responses=proxy_serializer)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('/x/', view_function=view_func)
assert 'MetaPerson' in schema['components']['schemas']
op = schema['paths']['/x/']['post']
assert get_response_schema(op) == {
'type': 'array',
'items': {'$ref': '#/components/schemas/MetaPerson'}
}
assert get_request_schema(op) == {
'type': 'array',
'items': {'$ref': '#/components/schemas/MetaPerson'}
}
@pytest.mark.parametrize('explicit', [True, False])
def test_many_polymorphic_proxy_serializer_extend_schema_field(no_warnings, explicit):
if explicit:
proxy_serializer = serializers.ListField(
child=PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS)
)
else:
proxy_serializer = PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS, many=True)
@extend_schema_field(proxy_serializer)
class XField(serializers.DictField):
pass # pragma: no cover
class XSerializer(serializers.Serializer):
field = XField()
@extend_schema(request=XSerializer, responses=XSerializer)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('/x/', view_function=view_func)
assert 'MetaPerson' in schema['components']['schemas']
assert schema['components']['schemas']['X'] == {
'type': 'object',
'properties': {
'field': {'type': 'array', 'items': {'$ref': '#/components/schemas/MetaPerson'}}
},
'required': ['field']
}
op = schema['paths']['/x/']['post']
assert get_request_schema(op) == {'$ref': '#/components/schemas/X'}
assert get_response_schema(op) == {'$ref': '#/components/schemas/X'}
def test_polymorphic_proxy_serializer_misusage(no_warnings):
with pytest.raises(AssertionError):
PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS).data
with pytest.raises(AssertionError):
PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS).to_representation(None)
with pytest.raises(AssertionError):
PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS).to_internal_value(None)
@mock.patch('drf_spectacular.settings.spectacular_settings.COMPONENT_SPLIT_REQUEST', True)
@pytest.mark.parametrize('explicit', [True, False])
def test_polymorphic_split_request_with_ro_serializer(no_warnings, explicit):
class BasicPersonSerializer(serializers.ModelSerializer):
type = serializers.SerializerMethodField()
class Meta:
model = NaturalPerson2
fields = ('id', 'type')
def get_type(self, obj) -> str:
return 'basic'
if explicit:
poly_proxy = PolymorphicProxySerializer(
component_name='MetaPerson',
serializers={'natural': NaturalPersonSerializer, 'basic': BasicPersonSerializer},
resource_type_field_name='type',
)
else:
poly_proxy = PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=[NaturalPersonSerializer, BasicPersonSerializer],
resource_type_field_name='type',
)
@extend_schema(request=poly_proxy, responses=poly_proxy)
@api_view(['POST'])
def view_func(request, format=None):
pass # pragma: no cover
schema = generate_schema('x', view_function=view_func)
components = schema['components']['schemas']
assert 'BasicPersonRequest' not in components
assert components['MetaPerson']['oneOf'] == [
{'$ref': '#/components/schemas/NaturalPerson'},
{'$ref': '#/components/schemas/BasicPerson'}
]
assert components['MetaPerson']['discriminator']['mapping'] == {
'natural': '#/components/schemas/NaturalPerson',
'basic': '#/components/schemas/BasicPerson'
}
assert components['MetaPersonRequest']['oneOf'] == [
{'$ref': '#/components/schemas/NaturalPersonRequest'},
]
assert components['MetaPersonRequest']['discriminator']['mapping'] == {
'natural': '#/components/schemas/NaturalPersonRequest',
}
def test_polymorphic_with_default_serializer(no_warnings):
class DefaultPersonSerializer(serializers.ModelSerializer):
type = serializers.SerializerMethodField()
class Meta:
model = NaturalPerson2
fields = ('id', 'type')
def get_type(self, obj) -> str:
return choice(['basic', 'simple'])
class XViewSet(viewsets.GenericViewSet):
@extend_schema(
responses=PolymorphicProxySerializer(
component_name='MetaPerson',
serializers={
'natural': NaturalPersonSerializer,
'basic': DefaultPersonSerializer,
'simple': DefaultPersonSerializer,
},
resource_type_field_name='type',
)
)
def list(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
schema = generate_schema('x', XViewSet)
components = schema['components']['schemas']
assert components['MetaPerson']['oneOf'] == [
{'$ref': '#/components/schemas/NaturalPerson'},
{'$ref': '#/components/schemas/DefaultPerson'}
]
assert components['MetaPerson']['discriminator']['mapping'] == {
'natural': '#/components/schemas/NaturalPerson',
'basic': '#/components/schemas/DefaultPerson',
'simple': '#/components/schemas/DefaultPerson'
}
def test_polymorphic_forced_many_false(no_warnings):
class XViewSet(viewsets.GenericViewSet):
@extend_schema(
responses=PolymorphicProxySerializer(
component_name='MetaPerson',
serializers=[NaturalPersonSerializer, LegalPersonSerializer],
resource_type_field_name='type',
many=False
)
)
def list(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
schema = generate_schema('x', XViewSet)
assert get_response_schema(schema['paths']['/x/']['get']) == {
'$ref': '#/components/schemas/MetaPerson'
}
def test_polymorphic_manual_many(no_warnings):
mixed_poly = PolymorphicProxySerializer(
component_name='MetaLegalPerson',
serializers=[NaturalPersonSerializer, NaturalPersonSerializer(many=True)],
resource_type_field_name=None,
many=False,
)
class XViewSet(viewsets.GenericViewSet):
@extend_schema(request=mixed_poly, responses=mixed_poly)
def create(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
@extend_schema(responses=mixed_poly)
def list(self, request, *args, **kwargs):
return Response({}) # pragma: no cover
schema = generate_schema('x', XViewSet)
response_schema = get_response_schema(schema['paths']['/x/']['post'])
request_schema = get_request_schema(schema['paths']['/x/']['post'])
assert response_schema == request_schema == {'$ref': '#/components/schemas/MetaLegalPerson'}
assert schema['components']['schemas']['MetaLegalPerson'] == {
'oneOf': [
{'$ref': '#/components/schemas/NaturalPerson'},
{'type': 'array', 'items': {'$ref': '#/components/schemas/NaturalPerson'}}
]
}
def test_polymorphic_implicit_many_through_list_method_decoration(no_warnings):
@extend_schema(responses=PolymorphicProxySerializer(**PROXY_SERIALIZER_PARAMS))
class XViewSet(viewsets.ReadOnlyModelViewSet):
queryset = LegalPerson2.objects.none()
serializer_class = LegalPersonSerializer
schema = generate_schema('/x', XViewSet)
assert get_response_schema(schema['paths']['/x/']['get']) == {
'items': {'$ref': '#/components/schemas/MetaPerson'}, 'type': 'array'
}
assert get_response_schema(schema['paths']['/x/{id}/']['get']) == {
'$ref': '#/components/schemas/MetaPerson'
}
assert schema['components']['schemas']['MetaPerson'] == {
'discriminator': {
'mapping': {
'legal': '#/components/schemas/LegalPerson',
'natural': '#/components/schemas/NaturalPerson'
},
'propertyName': 'type'
},
'oneOf': [
{'$ref': '#/components/schemas/LegalPerson'}, {'$ref': '#/components/schemas/NaturalPerson'}
]
}
|
