openwisp / django-rest-framework-gis / 625

pending completion

Build # 625

Build Type

Pull #223

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/openwisp/django-rest-framework-gis/commit/<a class=hub.com/openwisp/django-rest-framework-gis/commit/<a class="double-link" href="https://git"><a class=hub.com/openwisp/django-rest-framework-gis/commit/<a class="double-link" href="https://git"><a class=hub.com/openwisp/django-rest-framework-gis/commit/<a class="double-link" href="https://git"><a class=hub.com/openwisp/django-rest-framework-gis/commit/c1e75d722d7ec9331ac692fbf26c86d9e79cabf8">c1e75d722">&lt;a href=&quot;https://github.com/openwisp/django-rest-framework-gis/commit/</a><a class="double-link" href="https://github.com/openwisp/django-rest-framework-gis/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/openwisp/django-rest-framework-gis/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/openwisp/django-rest-framework-gis/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/openwisp/django-rest-framework-gis/commit/c1e75d722d7ec9331ac692fbf26c86d9e79cabf8">c1e75d722</a><a href="https://github.com/openwisp/django-rest-framework-gis/commit/c1e75d722d7ec9331ac692fbf26c86d9e79cabf8">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/openwisp/django-rest-framework-gis/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/openwisp/django-rest-framework-gis/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/openwisp/django-rest-framework-gis/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/openwisp/django-rest-framework-gis/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/openwisp/django-rest-framework-gis/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/openwisp/django-rest-framework-gis/commit/c1e75d722d7ec9331ac692fbf26c86d9e79cabf8&quot;&gt;c1e75d722&lt;/a&gt;&lt;a href=&quot;https://github.com/openwisp/django-rest-framework-gis/commit/c1e75d722d7ec9331ac692fbf26c86d9e79cabf8&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/openwisp/django-rest-framework-gis/... (continued)

Pull Request Pull Request #223: OpenAPI Schema Generation

Run Details

66 of 66 new or added lines in 3 files covered. (100.0%)

395 of 408 relevant lines covered (96.81%)

9.68 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.04

/rest_framework_gis/schema.py

import warnings

from django.contrib.gis.db import models
from rest_framework.schemas.openapi import AutoSchema
from rest_framework.utils import model_meta

from rest_framework_gis.fields import GeometrySerializerMethodField
from rest_framework_gis.serializers import (
    GeoFeatureModelListSerializer,
    GeoFeatureModelSerializer,
)


class GeoFeatureAutoSchema(AutoSchema):
    COORDINATES_SCHEMA_FOR_POINT = {
        "type": "array",
        "items": {"type": "number", "format": "float"},
        "example": [12.9721, 77.5933],
        "minItems": 2,
        "maxItems": 3,
    }

    COORDINATES_SCHEMA_FOR_LINE_STRING = {
        "type": "array",
        "items": COORDINATES_SCHEMA_FOR_POINT,
        "example": [[22.4707, 70.0577], [12.9721, 77.5933]],
        "minItems": 2,
    }

    GEO_FIELD_TO_SCHEMA = {
        models.PointField: {
            "type": {"type": "string", "enum": ["Point"]},
            "coordinates": COORDINATES_SCHEMA_FOR_POINT,
        },
        models.LineStringField: {
            "type": {"type": "string", "enum": ["LineString"]},
            "coordinates": COORDINATES_SCHEMA_FOR_LINE_STRING,
        },
        models.PolygonField: {
            "type": {"type": "string", "enum": ["Polygon"]},
            "coordinates": {
                "type": "array",
                "items": {**COORDINATES_SCHEMA_FOR_LINE_STRING, "minItems": 4},
                "example": [
                    [0.0, 0.0],
                    [0.0, 50.0],
                    [50.0, 50.0],
                    [50.0, 0.0],
                    [0.0, 0.0],
                ],
            },
        },
    }

    MULTI_FIELD_MAPPING = {
        models.PointField: models.MultiPointField,
        models.LineStringField: models.MultiLineStringField,
        models.PolygonField: models.MultiPolygonField,
    }

    for singular_field, multi_field in MULTI_FIELD_MAPPING.items():
        GEO_FIELD_TO_SCHEMA[multi_field] = {
            "type": {"type": "string", "enum": [multi_field.geom_class.__name__]},
            "coordinates": {
                "type": "array",
                "items": GEO_FIELD_TO_SCHEMA[singular_field]["coordinates"],
                "example": [
                    GEO_FIELD_TO_SCHEMA[singular_field]["coordinates"]["example"]
                ],
            },
        }

    def _map_geo_field(self, serializer, geo_field_name):
        field = serializer.fields[geo_field_name]
        if isinstance(field, GeometrySerializerMethodField):
            warnings.warn(
                "Geometry generation for GeometrySerializerMethodField is not supported."
            )
            return {}

        model_field_name = geo_field_name

        geo_field = model_meta.get_field_info(serializer.Meta.model).fields[
            model_field_name
        ]
        try:
            return self.GEO_FIELD_TO_SCHEMA[geo_field.__class__]
        except KeyError:
            warnings.warn(
                "Geometry generation for {field} is not supported.".format(field=field)
            )
            return {}

    def map_field(self, field):
        if isinstance(field, GeoFeatureModelListSerializer):
            return self._map_geo_feature_model_list_serializer(field)

        return super().map_field(field)

    def _map_geo_feature_model_list_serializer(self, serializer):
        return {
            "type": "object",
            "properties": {
                "type": {"type": "string", "enum": ["FeatureCollection"]},
                "features": {
                    "type": "array",
                    "items": self.map_serializer(serializer.child),
                },
            },
        }

    def _map_geo_feature_model_serializer(self, serializer):
        schema = super().map_serializer(serializer)

        geo_json_schema = {
            "type": "object",
            "properties": {"type": {"type": "string", "enum": ["Feature"]}},
        }

        if serializer.Meta.id_field:
            geo_json_schema["properties"]["id"] = schema["properties"].pop(
                serializer.Meta.id_field
            )

        geo_field = serializer.Meta.geo_field
        geo_json_schema["properties"]["geometry"] = {
            "type": "object",
            "properties": self._map_geo_field(serializer, geo_field),
        }
        schema["properties"].pop(geo_field)

        if serializer.Meta.auto_bbox or serializer.Meta.bbox_geo_field:
            geo_json_schema["properties"]["bbox"] = {
                "type": "array",
                "items": {"type": "number"},
                "minItems": 4,
                "maxItems": 4,
                "example": [12.9721, 77.5933, 12.9721, 77.5933],
            }
            if serializer.Meta.bbox_geo_field in schema["properties"]:
                schema["properties"].pop(serializer.Meta.bbox_geo_field)

        geo_json_schema["properties"]["properties"] = schema

        return geo_json_schema

    def map_serializer(self, serializer):
        if isinstance(serializer, GeoFeatureModelListSerializer):
            return self._map_geo_feature_model_list_serializer(serializer)

        if isinstance(serializer, GeoFeatureModelSerializer):
            return self._map_geo_feature_model_serializer(serializer)

        return super().map_serializer(serializer)

1	import warnings	10✔
2
3	from django.contrib.gis.db import models	10✔
4	from rest_framework.schemas.openapi import AutoSchema	10✔
5	from rest_framework.utils import model_meta	10✔
6
7	from rest_framework_gis.fields import GeometrySerializerMethodField	10✔
8	from rest_framework_gis.serializers import (	10✔
9	GeoFeatureModelListSerializer,
10	GeoFeatureModelSerializer,
11	)
12
13
14	class GeoFeatureAutoSchema(AutoSchema):	10✔
15	COORDINATES_SCHEMA_FOR_POINT = {	10✔
16	"type": "array",
17	"items": {"type": "number", "format": "float"},
18	"example": [12.9721, 77.5933],
19	"minItems": 2,
20	"maxItems": 3,
21	}
22
23	COORDINATES_SCHEMA_FOR_LINE_STRING = {	10✔
24	"type": "array",
25	"items": COORDINATES_SCHEMA_FOR_POINT,
26	"example": [[22.4707, 70.0577], [12.9721, 77.5933]],
27	"minItems": 2,
28	}
29
30	GEO_FIELD_TO_SCHEMA = {	10✔
31	models.PointField: {
32	"type": {"type": "string", "enum": ["Point"]},
33	"coordinates": COORDINATES_SCHEMA_FOR_POINT,
34	},
35	models.LineStringField: {
36	"type": {"type": "string", "enum": ["LineString"]},
37	"coordinates": COORDINATES_SCHEMA_FOR_LINE_STRING,
38	},
39	models.PolygonField: {
40	"type": {"type": "string", "enum": ["Polygon"]},
41	"coordinates": {
42	"type": "array",
43	"items": {**COORDINATES_SCHEMA_FOR_LINE_STRING, "minItems": 4},
44	"example": [
45	[0.0, 0.0],
46	[0.0, 50.0],
47	[50.0, 50.0],
48	[50.0, 0.0],
49	[0.0, 0.0],
50	],
51	},
52	},
53	}
54
55	MULTI_FIELD_MAPPING = {	10✔
56	models.PointField: models.MultiPointField,
57	models.LineStringField: models.MultiLineStringField,
58	models.PolygonField: models.MultiPolygonField,
59	}
60
61	for singular_field, multi_field in MULTI_FIELD_MAPPING.items():	10✔
62	GEO_FIELD_TO_SCHEMA[multi_field] = {	10✔
63	"type": {"type": "string", "enum": [multi_field.geom_class.__name__]},
64	"coordinates": {
65	"type": "array",
66	"items": GEO_FIELD_TO_SCHEMA[singular_field]["coordinates"],
67	"example": [
68	GEO_FIELD_TO_SCHEMA[singular_field]["coordinates"]["example"]
69	],
70	},
71	}
72
73	def _map_geo_field(self, serializer, geo_field_name):	10✔
74	field = serializer.fields[geo_field_name]	10✔
75	if isinstance(field, GeometrySerializerMethodField):	10✔
76	warnings.warn(	10✔
77	"Geometry generation for GeometrySerializerMethodField is not supported."
78	)
79	return {}	10✔
80
81	model_field_name = geo_field_name	10✔
82
83	geo_field = model_meta.get_field_info(serializer.Meta.model).fields[	10✔
84	model_field_name
85	]
86	try:	10✔
87	return self.GEO_FIELD_TO_SCHEMA[geo_field.__class__]	10✔
88	except KeyError:	10✔
89	warnings.warn(	10✔
90	"Geometry generation for {field} is not supported.".format(field=field)
91	)
92	return {}	10✔
93
94	def map_field(self, field):	10✔
95	if isinstance(field, GeoFeatureModelListSerializer):	10✔
96	return self._map_geo_feature_model_list_serializer(field)	10✔
97
98	return super().map_field(field)	10✔
99
100	def _map_geo_feature_model_list_serializer(self, serializer):	10✔
101	return {	10✔
102	"type": "object",
103	"properties": {
104	"type": {"type": "string", "enum": ["FeatureCollection"]},
105	"features": {
106	"type": "array",
107	"items": self.map_serializer(serializer.child),
108	},
109	},
110	}
111
112	def _map_geo_feature_model_serializer(self, serializer):	10✔
113	schema = super().map_serializer(serializer)	10✔
114
115	geo_json_schema = {	10✔
116	"type": "object",
117	"properties": {"type": {"type": "string", "enum": ["Feature"]}},
118	}
119
120	if serializer.Meta.id_field:	10✔
121	geo_json_schema["properties"]["id"] = schema["properties"].pop(	10✔
122	serializer.Meta.id_field
123	)
124
125	geo_field = serializer.Meta.geo_field	10✔
126	geo_json_schema["properties"]["geometry"] = {	10✔
127	"type": "object",
128	"properties": self._map_geo_field(serializer, geo_field),
129	}
130	schema["properties"].pop(geo_field)	10✔
131
132	if serializer.Meta.auto_bbox or serializer.Meta.bbox_geo_field:	10✔
133	geo_json_schema["properties"]["bbox"] = {	10✔
134	"type": "array",
135	"items": {"type": "number"},
136	"minItems": 4,
137	"maxItems": 4,
138	"example": [12.9721, 77.5933, 12.9721, 77.5933],
139	}
140	if serializer.Meta.bbox_geo_field in schema["properties"]:	10✔
141	schema["properties"].pop(serializer.Meta.bbox_geo_field)	10✔
142
143	geo_json_schema["properties"]["properties"] = schema	10✔
144
145	return geo_json_schema	10✔
146
147	def map_serializer(self, serializer):	10✔
148	if isinstance(serializer, GeoFeatureModelListSerializer):	10✔
149	return self._map_geo_feature_model_list_serializer(serializer)	×
150
151	if isinstance(serializer, GeoFeatureModelSerializer):	10✔
152	return self._map_geo_feature_model_serializer(serializer)	10✔
153
154	return super().map_serializer(serializer)	10✔

openwisp / django-rest-framework-gis / 625

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous