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
|
from drf_spectacular.drainage import warn
from drf_spectacular.extensions import OpenApiSerializerExtension
from drf_spectacular.plumbing import (
ComponentIdentity, ResolvedComponent, build_basic_type, build_object_type,
is_patched_serializer,
)
from drf_spectacular.settings import spectacular_settings
from drf_spectacular.types import OpenApiTypes
class PolymorphicSerializerExtension(OpenApiSerializerExtension):
target_class = 'rest_polymorphic.serializers.PolymorphicSerializer'
match_subclasses = True
def map_serializer(self, auto_schema, direction):
sub_components = []
serializer = self.target
for sub_model in serializer.model_serializer_mapping:
sub_serializer = serializer._get_serializer_from_model_or_instance(sub_model)
sub_serializer.partial = serializer.partial
resource_type = serializer.to_resource_type(sub_model)
component = auto_schema.resolve_serializer(sub_serializer, direction)
if not component:
# rebuild a virtual schema-less component to model empty serializers
component = ResolvedComponent(
name=auto_schema._get_serializer_name(sub_serializer, direction),
type=ResolvedComponent.SCHEMA,
object=ComponentIdentity('virtual')
)
typed_component = self.build_typed_component(
auto_schema=auto_schema,
component=component,
resource_type_field_name=serializer.resource_type_field_name,
patched=is_patched_serializer(sub_serializer, direction)
)
sub_components.append((resource_type, typed_component.ref))
if not resource_type:
warn(
f'discriminator mapping key is empty for {sub_serializer.__class__}. '
f'this might lead to code generation issues.'
)
one_of_list = []
for _, ref in sub_components:
if ref not in one_of_list:
one_of_list.append(ref)
return {
'oneOf': one_of_list,
'discriminator': {
'propertyName': serializer.resource_type_field_name,
'mapping': {resource_type: ref['$ref'] for resource_type, ref in sub_components},
}
}
def build_typed_component(self, auto_schema, component, resource_type_field_name, patched):
if spectacular_settings.COMPONENT_SPLIT_REQUEST and component.name.endswith('Request'):
typed_component_name = component.name[:-len('Request')] + 'TypedRequest'
else:
typed_component_name = f'{component.name}Typed'
resource_type_schema = build_object_type(
properties={resource_type_field_name: build_basic_type(OpenApiTypes.STR)},
required=None if patched else [resource_type_field_name]
)
# if sub-serializer has an empty schema, only expose the resource_type field part
if component.schema:
schema = {'allOf': [resource_type_schema, component.ref]}
else:
schema = resource_type_schema
component_typed = ResolvedComponent(
name=typed_component_name,
type=ResolvedComponent.SCHEMA,
object=component.object,
schema=schema,
)
auto_schema.registry.register_on_missing(component_typed)
return component_typed
|
