File: rest_framework_gis.py

package info (click to toggle)
python-drf-spectacular 0.28.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,748 kB
  • sloc: python: 14,174; javascript: 114; sh: 61; makefile: 30
file content (219 lines) | stat: -rw-r--r-- 7,906 bytes parent folder | download | duplicates (3)
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
from rest_framework.utils.model_meta import get_field_info

from drf_spectacular.drainage import warn
from drf_spectacular.extensions import OpenApiSerializerExtension, OpenApiSerializerFieldExtension
from drf_spectacular.plumbing import (
    ResolvedComponent, build_array_type, build_object_type, follow_field_source, get_doc,
)


def build_point_schema():
    return {
        "type": "array",
        "items": {"type": "number", "format": "float"},
        "example": [12.9721, 77.5933],
        "minItems": 2,
        "maxItems": 3,
    }


def build_linestring_schema():
    return {
        "type": "array",
        "items": build_point_schema(),
        "example": [[22.4707, 70.0577], [12.9721, 77.5933]],
        "minItems": 2,
    }


def build_polygon_schema():
    return {
        "type": "array",
        "items": {**build_linestring_schema(), "minItems": 4},
        "example": [
            [
                [0.0, 0.0],
                [0.0, 50.0],
                [50.0, 50.0],
                [50.0, 0.0],
                [0.0, 0.0],
            ],
        ]
    }


def build_geo_container_schema(name, coords):
    return build_object_type(
        properties={
            "type": {"type": "string", "enum": [name]},
            "coordinates": coords,
        }
    )


def build_point_geo_schema():
    return build_geo_container_schema("Point", build_point_schema())


def build_linestring_geo_schema():
    return build_geo_container_schema("LineString", build_linestring_schema())


def build_polygon_geo_schema():
    return build_geo_container_schema("Polygon", build_polygon_schema())


def build_geometry_geo_schema():
    return {
        'oneOf': [
            build_point_geo_schema(),
            build_linestring_geo_schema(),
            build_polygon_geo_schema(),
        ]
    }


def build_bbox_schema():
    return {
        "type": "array",
        "items": {"type": "number"},
        "minItems": 4,
        "maxItems": 4,
        "example": [12.9721, 77.5933, 12.9721, 77.5933],
    }


def build_geo_schema(model_field):
    from django.contrib.gis.db import models

    if isinstance(model_field, models.PointField):
        return build_point_geo_schema()
    elif isinstance(model_field, models.LineStringField):
        return build_linestring_geo_schema()
    elif isinstance(model_field, models.PolygonField):
        return build_polygon_geo_schema()
    elif isinstance(model_field, models.MultiPointField):
        return build_geo_container_schema(
            "MultiPoint", build_array_type(build_point_schema())
        )
    elif isinstance(model_field, models.MultiLineStringField):
        return build_geo_container_schema(
            "MultiLineString", build_array_type(build_linestring_schema())
        )
    elif isinstance(model_field, models.MultiPolygonField):
        return build_geo_container_schema(
            "MultiPolygon", build_array_type(build_polygon_schema())
        )
    elif isinstance(model_field, models.GeometryCollectionField):
        return build_geo_container_schema(
            "GeometryCollection", build_array_type(build_geometry_geo_schema())
        )
    elif isinstance(model_field, models.GeometryField):
        return build_geometry_geo_schema()
    else:
        warn("Encountered unknown GIS geometry field")
        return {}


def map_geo_field(serializer, geo_field_name):
    from rest_framework_gis.fields import GeometrySerializerMethodField

    field = serializer.fields[geo_field_name]
    if isinstance(field, GeometrySerializerMethodField):
        warn("Geometry generation for GeometrySerializerMethodField is not supported.")
        return {}
    model_field = get_field_info(serializer.Meta.model).fields[geo_field_name]
    return build_geo_schema(model_field)


def _inject_enum_collision_fix(collection):
    from drf_spectacular.settings import spectacular_settings
    if not collection and 'GisFeatureEnum' not in spectacular_settings.ENUM_NAME_OVERRIDES:
        spectacular_settings.ENUM_NAME_OVERRIDES['GisFeatureEnum'] = ('Feature',)
    if collection and 'GisFeatureCollectionEnum' not in spectacular_settings.ENUM_NAME_OVERRIDES:
        spectacular_settings.ENUM_NAME_OVERRIDES['GisFeatureCollectionEnum'] = ('FeatureCollection',)


class GeoFeatureModelSerializerExtension(OpenApiSerializerExtension):
    target_class = 'rest_framework_gis.serializers.GeoFeatureModelSerializer'
    match_subclasses = True

    def map_serializer(self, auto_schema, direction):
        _inject_enum_collision_fix(collection=False)

        base_schema = auto_schema._map_serializer(self.target, direction, bypass_extensions=True)
        return self.map_geo_feature_model_serializer(self.target, base_schema)

    def map_geo_feature_model_serializer(self, serializer, base_schema):
        from rest_framework_gis.serializers import GeoFeatureModelSerializer

        geo_properties = {
            "type": {"type": "string", "enum": ["Feature"]}
        }
        if serializer.Meta.id_field:
            geo_properties["id"] = base_schema["properties"].pop(serializer.Meta.id_field)

        geo_properties["geometry"] = map_geo_field(serializer, serializer.Meta.geo_field)
        base_schema["properties"].pop(serializer.Meta.geo_field)

        if serializer.Meta.auto_bbox or serializer.Meta.bbox_geo_field:
            geo_properties["bbox"] = build_bbox_schema()
            base_schema["properties"].pop(serializer.Meta.bbox_geo_field, None)

        # only expose if description comes from the user
        description = base_schema.pop('description', None)
        if description == get_doc(GeoFeatureModelSerializer):
            description = None

        # ignore this aspect for now
        base_schema.pop('required', None)

        # nest remaining fields under property "properties"
        geo_properties["properties"] = base_schema

        return build_object_type(
            properties=geo_properties,
            description=description,
        )


class GeoFeatureModelListSerializerExtension(OpenApiSerializerExtension):
    target_class = 'rest_framework_gis.serializers.GeoFeatureModelListSerializer'

    def map_serializer(self, auto_schema, direction):
        _inject_enum_collision_fix(collection=True)

        # build/retrieve feature component generated by GeoFeatureModelSerializerExtension.
        # wrap the ref in the special list structure and build another component based on that.
        feature_component = auto_schema.resolve_serializer(self.target.child, direction)
        collection_schema = build_object_type(
            properties={
                "type": {"type": "string", "enum": ["FeatureCollection"]},
                "features": build_array_type(feature_component.ref)
            }
        )
        list_component = ResolvedComponent(
            name=f'{feature_component.name}List',
            type=ResolvedComponent.SCHEMA,
            object=self.target.child,
            schema=collection_schema
        )
        auto_schema.registry.register_on_missing(list_component)
        return list_component.ref


class GeometryFieldExtension(OpenApiSerializerFieldExtension):
    target_class = 'rest_framework_gis.fields.GeometryField'
    match_subclasses = True

    def map_serializer_field(self, auto_schema, direction):
        # running this extension for GeoFeatureModelSerializer's geo_field is superfluous
        # as above extension already handles that individually. We run it anyway because
        # robustly checking the proper condition is harder.
        try:
            model = self.target.parent.Meta.model
            model_field = follow_field_source(model, self.target.source.split('.'))
            return build_geo_schema(model_field)
        except:  # noqa: E722
            warn(f'Encountered an issue resolving field {self.target}. defaulting to generic object.')
            return {}