commonground-api-common 2.6.3__tar.gz → 2.6.4__tar.gz

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4}/CHANGELOG.rst

@@ -2,6 +2,12 @@
 Change history
 ==============
 
+2.6.4 (2025-05-16)
+------------------
+
+* [maykinmedia/open-klant#414] Move ``vng_api_common.filters.Backend`` -> ``vng_api_common.filters_backend.Backend``
+* [maykinmedia/open-klant#414] Fix help texts not showing in generated OAS for ``vng_api_common.filters_backend.Backend``
+
 2.6.3 (2025-05-12)
 ------------------
 

{commonground_api_common-2.6.3/commonground_api_common.egg-info → commonground_api_common-2.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.6.3
+Version: 2.6.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.6.3
+Version: 2.6.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4}/commonground_api_common.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ vng_api_common/exception_handling.py
 vng_api_common/exceptions.py
 vng_api_common/fields.py
 vng_api_common/filters.py
+vng_api_common/filters_backend.py
 vng_api_common/filtersets.py
 vng_api_common/generators.py
 vng_api_common/geo.py

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.6.3
+version = 2.6.4
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common

commonground_api_common-2.6.4/vng_api_common/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.6.4"

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4}/vng_api_common/conf/api.py

@@ -33,7 +33,7 @@ BASE_REST_FRAMEWORK = {
     # of applications
     "DEFAULT_AUTHENTICATION_CLASSES": (),
     "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.URLPathVersioning",
-    "DEFAULT_FILTER_BACKENDS": ("vng_api_common.filters.Backend",),
+    "DEFAULT_FILTER_BACKENDS": ("vng_api_common.filters_backend.Backend",),
     #
     # # Filtering
     "ORDERING_PARAM": "ordering",  # 'ordering',

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4}/vng_api_common/filters.py

@@ -5,67 +5,18 @@ from django.core.exceptions import ValidationError
 from django.core.validators import URLValidator
 from django.db import models
 from django.forms.widgets import URLInput
-from django.http import QueryDict
 from django.utils.translation import gettext_lazy as _
 
 from django_filters import fields, filters
 from django_filters.constants import EMPTY_VALUES
-from django_filters.rest_framework import DjangoFilterBackend
-from djangorestframework_camel_case.parser import CamelCaseJSONParser
-from djangorestframework_camel_case.render import CamelCaseJSONRenderer
-from djangorestframework_camel_case.util import underscoreize
-from rest_framework.request import Request
-from rest_framework.views import APIView
 
 from .constants import FILTER_URL_DID_NOT_RESOLVE
-from .search import is_search_view
 from .utils import NotAViewSet, get_resource_for_path
 from .validators import validate_rsin
 
 logger = logging.getLogger(__name__)
 
 
-class Backend(DjangoFilterBackend):
-    def _is_camel_case(self, view):
-        return any(
-            issubclass(parser, CamelCaseJSONParser) for parser in view.parser_classes
-        ) or any(
-            issubclass(renderer, CamelCaseJSONRenderer)
-            for renderer in view.renderer_classes
-        )
-
-    def _transform_query_params(self, view, query_params: QueryDict) -> QueryDict:
-        if not self._is_camel_case(view):
-            return query_params
-
-        # data can be a regular dict if it's coming from a serializer
-        if hasattr(query_params, "lists"):
-            data = dict(query_params.lists())
-        else:
-            data = query_params
-
-        transformed = underscoreize(data)
-
-        return QueryDict(urlencode(transformed, doseq=True))
-
-    def get_filterset_kwargs(
-        self, request: Request, queryset: models.QuerySet, view: APIView
-    ):
-        """
-        Get the initialization parameters for the filterset.
-
-        * filter on request.data if request.query_params is empty
-        * do the camelCase transformation of filter parameters
-        """
-        kwargs = super().get_filterset_kwargs(request, queryset, view)
-        filter_parameters = (
-            request.query_params if not is_search_view(view) else request.data
-        )
-        query_params = self._transform_query_params(view, filter_parameters)
-        kwargs["data"] = query_params
-        return kwargs
-
-
 class URLModelChoiceField(fields.ModelChoiceField):
     widget = URLInput
 

commonground_api_common-2.6.4/vng_api_common/filters_backend.py

@@ -0,0 +1,61 @@
+import logging
+from urllib.parse import urlencode
+
+from django.db import models
+from django.http import QueryDict
+from django.utils.translation import gettext_lazy as _
+
+from django_filters.rest_framework import DjangoFilterBackend
+from djangorestframework_camel_case.parser import CamelCaseJSONParser
+from djangorestframework_camel_case.render import CamelCaseJSONRenderer
+from djangorestframework_camel_case.util import underscoreize
+from rest_framework.request import Request
+from rest_framework.views import APIView
+
+from .filtersets import FilterSet
+from .search import is_search_view
+
+logger = logging.getLogger(__name__)
+
+
+class Backend(DjangoFilterBackend):
+    filterset_base = FilterSet
+
+    def _is_camel_case(self, view):
+        return any(
+            issubclass(parser, CamelCaseJSONParser) for parser in view.parser_classes
+        ) or any(
+            issubclass(renderer, CamelCaseJSONRenderer)
+            for renderer in view.renderer_classes
+        )
+
+    def _transform_query_params(self, view, query_params: QueryDict) -> QueryDict:
+        if not self._is_camel_case(view):
+            return query_params
+
+        # data can be a regular dict if it's coming from a serializer
+        if hasattr(query_params, "lists"):
+            data = dict(query_params.lists())
+        else:
+            data = query_params
+
+        transformed = underscoreize(data)
+
+        return QueryDict(urlencode(transformed, doseq=True))
+
+    def get_filterset_kwargs(
+        self, request: Request, queryset: models.QuerySet, view: APIView
+    ):
+        """
+        Get the initialization parameters for the filterset.
+
+        * filter on request.data if request.query_params is empty
+        * do the camelCase transformation of filter parameters
+        """
+        kwargs = super().get_filterset_kwargs(request, queryset, view)
+        filter_parameters = (
+            request.query_params if not is_search_view(view) else request.data
+        )
+        query_params = self._transform_query_params(view, filter_parameters)
+        kwargs["data"] = query_params
+        return kwargs

{commonground_api_common-2.6.3 → commonground_api_common-2.6.4}/vng_api_common/viewsets.py

@@ -6,7 +6,7 @@ from rest_framework.pagination import PageNumberPagination
 from rest_framework.settings import api_settings
 from rest_framework_nested.viewsets import NestedViewSetMixin  # noqa
 
-from .filters import Backend
+from .filters_backend import Backend
 from .utils import underscore_to_camel
 
 

commonground_api_common-2.6.3/vng_api_common/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.6.3"