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

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

@@ -2,6 +2,19 @@
 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)
+------------------
+
+* Fix BSNField validator to mention BSN instead of RSIN in validation error message
+* Migrate from ``iso639`` to ``iso639-lang``
+* [maykinmedia/open-klant#249] Add default to the help_text of the ``pageSize`` attribute
+
 2.6.2 (2025-04-16)
 ------------------
 

{commonground_api_common-2.6.2/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.2
+Version: 2.6.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -27,7 +27,7 @@ Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
 Requires-Dist: drf-nested-routers>=0.94.1
 Requires-Dist: drf-spectacular
-Requires-Dist: iso-639
+Requires-Dist: iso639-lang
 Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml

{commonground_api_common-2.6.2 → 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.2
+Version: 2.6.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -27,7 +27,7 @@ Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
 Requires-Dist: drf-nested-routers>=0.94.1
 Requires-Dist: drf-spectacular
-Requires-Dist: iso-639
+Requires-Dist: iso639-lang
 Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml

{commonground_api_common-2.6.2 → 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.2 → commonground_api_common-2.6.4}/commonground_api_common.egg-info/requires.txt

@@ -6,7 +6,7 @@ djangorestframework_camel_case>=1.2.0
 django-rest-framework-condition
 drf-nested-routers>=0.94.1
 drf-spectacular
-iso-639
+iso639-lang
 notifications-api-common>=0.3.1
 zgw-consumers>=0.35.1
 oyaml

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

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.6.2
+version = 2.6.4
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -37,7 +37,7 @@ install_requires =
 	django-rest-framework-condition
 	drf-nested-routers>=0.94.1
 	drf-spectacular
-	iso-639
+	iso639-lang
 	notifications-api-common>=0.3.1
 	zgw-consumers>=0.35.1
 	oyaml

{commonground_api_common-2.6.2 → commonground_api_common-2.6.4}/tests/test_pagination.py

@@ -3,6 +3,7 @@ from rest_framework import status
 from rest_framework.reverse import reverse
 
 from testapp.factories import HobbyFactory
+from vng_api_common.pagination import DynamicPageSizeMixin
 
 
 @pytest.mark.django_db
@@ -33,3 +34,15 @@ def test_list_with_page_size_in_query(api_client):
     assert data["count"] == 10
     assert len(data["results"]) == 5
     assert data["next"] == f"http://testserver{path}?page=2&pageSize=5"
+
+
+def test_page_size_query_description_property():
+
+    class DummyPagination(DynamicPageSizeMixin):
+        page_size = 42
+
+    pagination = DummyPagination()
+    assert (
+        pagination.page_size_query_description
+        == "Het aantal resultaten terug te geven per pagina. (default: 42)."
+    )

commonground_api_common-2.6.4/vng_api_common/__init__.py

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

{commonground_api_common-2.6.2 → 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.2 → commonground_api_common-2.6.4}/vng_api_common/fields.py

@@ -5,16 +5,12 @@ from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models
 from django.utils.translation import gettext, gettext_lazy as _
 
-from iso639 import languages
+from iso639 import iter_langs
 
 from .constants import BSN_LENGTH, RSIN_LENGTH, VertrouwelijkheidsAanduiding
-from .validators import validate_rsin
+from .validators import validate_bsn, validate_rsin
 
-ISO_639_2B = languages.part2b
-
-LANGUAGE_CHOICES = tuple(
-    [(code, language.name) for code, language in ISO_639_2B.items()]
-)
+LANGUAGE_CHOICES = tuple([(lg.pt2b, lg.name) for lg in iter_langs() if lg.pt2b])
 
 
 class RSINField(models.CharField):
@@ -43,7 +39,7 @@ class RSINField(models.CharField):
 
 
 class BSNField(models.CharField):
-    default_validators = [validate_rsin]
+    default_validators = [validate_bsn]
     description = _("BSN")
 
     def __init__(self, *args, **kwargs):

{commonground_api_common-2.6.2 → 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.2 → commonground_api_common-2.6.4}/vng_api_common/pagination.py

@@ -14,5 +14,11 @@ class DynamicPageSizeMixin:
     page_size_query_param = "pageSize"
     max_page_size = 500
 
+    @property
+    def page_size_query_description(self):
+        return _(
+            "Het aantal resultaten terug te geven per pagina. (default: {page_size})."
+        ).format(page_size=self.page_size)
+
 
 class DynamicPageSizePagination(DynamicPageSizeMixin, PageNumberPagination): ...

{commonground_api_common-2.6.2 → 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.2/vng_api_common/__init__.py

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