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

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

@@ -2,6 +2,18 @@
 Change history
 ==============
 
+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)
+------------------
+
+* [maykinmedia/open-klant#341] Fix ``help_text`` field in FilterSet
+
 2.6.1 (2025-04-14)
 ------------------
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.6.1
+Version: 2.6.3
 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.1 → commonground_api_common-2.6.3/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.6.1
+Version: 2.6.3
 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.1 → commonground_api_common-2.6.3}/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.1 → commonground_api_common-2.6.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.6.1
+version = 2.6.3
 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.1 → commonground_api_common-2.6.3}/tests/test_filter_extension.py

@@ -7,6 +7,7 @@ from testapp.models import FkModel
 from testapp.serializers import PolySerializer
 from tests import generate_schema
 from vng_api_common import routers
+from vng_api_common.filtersets import FilterSet
 
 
 class FkModelSerializer(serializers.ModelSerializer):
@@ -33,6 +34,12 @@ class FkModelViewSet(viewsets.ModelViewSet):
     ]
 
 
+class FkModelFilterSet(FilterSet):
+    class Meta:
+        model = FkModel
+        fields = ["name"]
+
+
 app_name = "filter_extensions"
 
 router = routers.DefaultRouter(trailing_slash=False)
@@ -51,3 +58,9 @@ def test_camilize():
     assert parameters[0]["name"] == "fieldWithUnderscores"
     assert parameters[1]["name"] == "name"
     assert parameters[2]["name"] == "poly__name"
+
+
+def test_help_text_from_model():
+    filter_set = FkModelFilterSet()
+    field = filter_set.filters["name"]
+    assert field.extra["help_text"] == "FkModel simple name help_text"

{commonground_api_common-2.6.1 → commonground_api_common-2.6.3}/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.3/vng_api_common/__init__.py

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

{commonground_api_common-2.6.1 → commonground_api_common-2.6.3}/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.1 → commonground_api_common-2.6.3}/vng_api_common/filtersets.py

@@ -25,3 +25,13 @@ class FilterSet(filterset.FilterSet):
     """
 
     FILTER_DEFAULTS = FILTER_FOR_DBFIELD_DEFAULTS
+
+    @classmethod
+    def filter_for_field(cls, field, field_name, lookup_expr=None):
+        """
+        Add help texts for model field filters
+        """
+        filter_set = super().filter_for_field(field, field_name, lookup_expr)
+        if not filter_set.extra.get("help_text"):
+            filter_set.extra["help_text"] = getattr(field, "help_text", None)
+        return filter_set

{commonground_api_common-2.6.1 → commonground_api_common-2.6.3}/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.1/vng_api_common/__init__.py

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