commonground-api-common 2.2.0__py3-none-any.whl → 2.3.0__py3-none-any.whl

vng_api_common/inspectors/polymorphic.py

@@ -1,72 +0,0 @@
-"""
-Introspect polymorphic resources
-
-Bulk of the code taken from https://github.com/axnsan12/drf-yasg/issues/100
-"""
-
-from drf_yasg import openapi
-from drf_yasg.errors import SwaggerGenerationError
-from drf_yasg.inspectors.base import NotHandled
-from drf_yasg.inspectors.field import (
-    CamelCaseJSONFilter,
-    ReferencingSerializerInspector,
-)
-
-from ..polymorphism import PolymorphicSerializer
-from ..utils import underscore_to_camel
-
-
-class PolymorphicSerializerInspector(
-    CamelCaseJSONFilter, ReferencingSerializerInspector
-):
-    def field_to_swagger_object(
-        self, field, swagger_object_type, use_references, **kwargs
-    ):
-        SwaggerType, ChildSwaggerType = self._get_partial_types(
-            field, swagger_object_type, use_references, **kwargs
-        )
-
-        if not isinstance(field, PolymorphicSerializer):
-            return NotHandled
-
-        if not getattr(field, "discriminator", None):
-            raise SwaggerGenerationError(
-                "'PolymorphicSerializer' derived serializers need to have 'discriminator' set"
-            )
-
-        base_schema_ref = super().field_to_swagger_object(
-            field, swagger_object_type, use_references, **kwargs
-        )
-        if not isinstance(base_schema_ref, openapi.SchemaRef):
-            raise SwaggerGenerationError(
-                "discriminator inheritance requires model references"
-            )
-
-        base_schema = base_schema_ref.resolve(self.components)  # type: openapi.Schema
-        base_schema.discriminator = underscore_to_camel(
-            field.discriminator.discriminator_field
-        )
-
-        for value, serializer in field.discriminator.mapping.items():
-            if serializer is None:
-                allof_derived = openapi.Schema(
-                    type=openapi.TYPE_OBJECT, all_of=[base_schema_ref]
-                )
-            else:
-                derived_ref = self.probe_field_inspectors(
-                    serializer, openapi.Schema, use_references=True
-                )
-                if not isinstance(derived_ref, openapi.SchemaRef):
-                    raise SwaggerGenerationError(
-                        "discriminator inheritance requies model references"
-                    )
-
-                allof_derived = openapi.Schema(
-                    type=openapi.TYPE_OBJECT, all_of=[base_schema_ref, derived_ref]
-                )
-            if not self.components.has(value, scope=openapi.SCHEMA_DEFINITIONS):
-                self.components.set(
-                    value, allof_derived, scope=openapi.SCHEMA_DEFINITIONS
-                )
-
-        return base_schema_ref

vng_api_common/inspectors/query.py

@@ -1,91 +0,0 @@
-from django.db import models
-from django.utils.encoding import force_str
-from django.utils.translation import gettext as _
-
-from django_filters.filters import BaseCSVFilter, ChoiceFilter
-from drf_yasg import openapi
-from drf_yasg.inspectors.query import CoreAPICompatInspector
-from rest_framework.filters import OrderingFilter
-
-from ..filters import URLModelChoiceFilter
-from ..utils import underscore_to_camel
-from .utils import get_target_field
-
-
-class FilterInspector(CoreAPICompatInspector):
-    """
-    Filter inspector that specifies the format of URL-based fields and lists
-    enum options.
-    """
-
-    def get_filter_parameters(self, filter_backend):
-        fields = super().get_filter_parameters(filter_backend)
-        if isinstance(filter_backend, OrderingFilter):
-            return fields
-
-        if fields:
-            queryset = self.view.get_queryset()
-            filter_class = filter_backend.get_filterset_class(self.view, queryset)
-
-            for parameter in fields:
-                filter_field = filter_class.base_filters[parameter.name]
-                model_field = get_target_field(queryset.model, parameter.name)
-                parameter._filter_field = filter_field
-
-                help_text = filter_field.extra.get(
-                    "help_text",
-                    getattr(model_field, "help_text", "") if model_field else "",
-                )
-
-                if isinstance(filter_field, BaseCSVFilter):
-                    if "choices" in filter_field.extra:
-                        schema = openapi.Schema(
-                            type=openapi.TYPE_ARRAY,
-                            items=openapi.Schema(
-                                type=openapi.TYPE_STRING,
-                                enum=[
-                                    choice[0]
-                                    for choice in filter_field.extra["choices"]
-                                ],
-                            ),
-                        )
-                    else:
-                        schema = openapi.Schema(
-                            type=openapi.TYPE_ARRAY,
-                            items=openapi.Schema(type=openapi.TYPE_STRING),
-                        )
-                    parameter["type"] = openapi.TYPE_ARRAY
-                    parameter["schema"] = schema
-                    parameter["style"] = "form"
-                    parameter["explode"] = False
-                elif isinstance(filter_field, URLModelChoiceFilter):
-                    description = _("URL to the related {resource}").format(
-                        resource=parameter.name
-                    )
-                    parameter.description = help_text or description
-                    parameter.format = openapi.FORMAT_URI
-                elif isinstance(filter_field, ChoiceFilter):
-                    parameter.enum = [
-                        choice[0] for choice in filter_field.extra["choices"]
-                    ]
-                elif model_field and isinstance(model_field, models.URLField):
-                    parameter.format = openapi.FORMAT_URI
-
-                if not parameter.description and help_text:
-                    parameter.description = force_str(help_text)
-
-                if "max_length" in filter_field.extra:
-                    parameter.max_length = filter_field.extra["max_length"]
-                if "min_length" in filter_field.extra:
-                    parameter.min_length = filter_field.extra["min_length"]
-
-        return fields
-
-    def process_result(self, result, method_name, obj, **kwargs):
-        """
-        Convert snake-case to camelCase.
-        """
-        if result and type(result) is list:
-            for parameter in result:
-                parameter.name = underscore_to_camel(parameter.name)
-        return result

vng_api_common/inspectors/utils.py

@@ -1,40 +0,0 @@
-from typing import Optional, Type
-
-from django.db import models
-
-from rest_framework.utils.model_meta import get_field_info
-
-
-def get_target_field(model: Type[models.Model], field: str) -> Optional[models.Field]:
-    """
-    Retrieve the end-target that ``field`` points to.
-
-    :param field: A string containing a lookup, potentially spanning relations. E.g.:
-      foo__bar__lte.
-    :return: A Django model field instance or `None`
-    """
-
-    start, *remaining = field.split("__")
-    field_info = get_field_info(model)
-
-    # simple, non relational field?
-    if start in field_info.fields:
-        return field_info.fields[start]
-
-    # simple relational field?
-    if start in field_info.forward_relations:
-        relation_info = field_info.forward_relations[start]
-        if not remaining:
-            return relation_info.model_field
-        else:
-            return get_target_field(relation_info.related_model, "__".join(remaining))
-
-    # check the reverse relations - note that the model name is used instead of model_name_set
-    # in the queries -> we can't just test for containment in field_info.reverse_relations
-    for relation_info in field_info.reverse_relations.values():
-        # not sure about this - what if there are more relations with different related names?
-        if relation_info.related_model._meta.model_name != start:
-            continue
-        return get_target_field(relation_info.related_model, "__".join(remaining))
-
-    return None