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

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

@@ -2,6 +2,16 @@
 Change history
 ==============
 
+2.6.2 (2025-04-16)
+------------------
+
+* [maykinmedia/open-klant#341] Fix ``help_text`` field in FilterSet
+
+2.6.1 (2025-04-14)
+------------------
+
+* [open-zaak/open-zaak#1799] Fix ``DurationField`` to consistently support negative durations.
+
 2.6.0 (2025-04-07)
 ------------------
 

{commonground_api_common-2.6.0/commonground_api_common.egg-info → commonground_api_common-2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.6.0
+Version: 2.6.2
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -28,7 +28,6 @@ Requires-Dist: django-rest-framework-condition
 Requires-Dist: drf-nested-routers>=0.94.1
 Requires-Dist: drf-spectacular
 Requires-Dist: iso-639
-Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml

{commonground_api_common-2.6.0 → commonground_api_common-2.6.2/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.6.0
+Version: 2.6.2
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -28,7 +28,6 @@ Requires-Dist: django-rest-framework-condition
 Requires-Dist: drf-nested-routers>=0.94.1
 Requires-Dist: drf-spectacular
 Requires-Dist: iso-639
-Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml

{commonground_api_common-2.6.0 → commonground_api_common-2.6.2}/commonground_api_common.egg-info/SOURCES.txt

@@ -34,6 +34,7 @@ tests/test_permissions.py
 tests/test_publish_validators.py
 tests/test_schema.py
 tests/test_serializer_extensions.py
+tests/test_serializer_fields.py
 tests/test_server_errors.py
 tests/test_utils.py
 tests/test_validators.py

{commonground_api_common-2.6.0 → commonground_api_common-2.6.2}/commonground_api_common.egg-info/requires.txt

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

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

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

{commonground_api_common-2.6.0 → commonground_api_common-2.6.2}/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.2/tests/test_serializer_fields.py

@@ -0,0 +1,58 @@
+from dateutil.relativedelta import relativedelta
+from rest_framework import serializers, viewsets
+
+from vng_api_common.serializers import DurationField
+
+VALID_DURATION_OPTIONS = [
+    ("P10D", relativedelta(days=10)),
+    ("P1M10D", relativedelta(months=1, days=10)),
+    ("P1Y1M10D", relativedelta(years=1, months=1, days=10)),
+    ("P-10D", relativedelta(days=-10)),
+    ("P-1M-10D", relativedelta(months=-1, days=-10)),
+    ("P-1Y-1M-10D", relativedelta(years=-1, months=-1, days=-10)),
+    ("P1Y-1M10D", relativedelta(years=+1, months=-1, days=+10)),
+]
+
+
+class DurationSerializer(serializers.Serializer):
+    duration = DurationField()
+
+
+class DurationView(viewsets.ModelViewSet):
+    serializer_class = DurationSerializer
+
+
+def test_duration_field_valid_serialization():
+    data = {"duration": ""}
+    for duration in VALID_DURATION_OPTIONS:
+        data["duration"] = duration[0]
+        serializer = DurationSerializer(data=data)
+        assert serializer.is_valid()
+        assert serializer.to_representation({"duration": duration[1]}) == data
+
+
+def test_duration_field_valid_deserialization():
+    data = {"duration": ""}
+    for duration in VALID_DURATION_OPTIONS:
+        data["duration"] = duration[0]
+        serializer = DurationSerializer(data=data)
+        assert serializer.is_valid()
+        assert serializer.to_internal_value(data) == {"duration": duration[1]}
+
+
+def test_duration_field_invalid_deserialization():
+    duration_options = [
+        "test",
+        "10D",
+        "-P10D",
+        "-P-10D",
+    ]
+    data = {"duration": ""}
+    for d in duration_options:
+        data["duration"] = d
+        serializer = DurationSerializer(data=data)
+        assert not serializer.is_valid()
+        assert (
+            serializer.errors["duration"][0]
+            == "Duration has wrong format. Use one of these formats instead: P(n)Y(n)M(n)D."
+        )

commonground_api_common-2.6.2/vng_api_common/__init__.py

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

{commonground_api_common-2.6.0 → commonground_api_common-2.6.2}/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.0 → commonground_api_common-2.6.2}/vng_api_common/serializers.py

@@ -1,4 +1,3 @@
-import datetime
 import inspect
 from collections import OrderedDict
 from functools import reduce
@@ -8,7 +7,7 @@ from django.db import models, transaction
 from django.db.models import Model
 from django.utils.translation import gettext_lazy as _
 
-import isodate
+from dateutil.relativedelta import relativedelta
 from rest_framework import fields, serializers
 from rest_framework.request import Request
 from rest_framework_nested.relations import NestedHyperlinkedRelatedField
@@ -18,41 +17,29 @@ from .descriptors import GegevensGroepType
 
 try:
     # 1.1.x
-    from relativedeltafield.utils import format_relativedelta, relativedelta
+    from relativedeltafield.utils import format_relativedelta, parse_relativedelta
 except ImportError:
     try:
         # 1.0.x
-        from relativedeltafield import format_relativedelta, relativedelta
+        from relativedeltafield import format_relativedelta, parse_relativedelta
     except ImportError:
         format_relativedelta = None
-        relativedelta = None
+        parse_relativedelta = None
 
 
 class DurationField(fields.DurationField):
     def to_internal_value(self, value):
-        if isinstance(value, datetime.timedelta):
+        if isinstance(value, relativedelta):
             return value
         try:
-            parsed = isodate.parse_duration(str(value))
-        except isodate.ISO8601Error:
+            return parse_relativedelta(str(value))
+        except ValueError:
             self.fail("invalid", format="P(n)Y(n)M(n)D")
-        else:
-            if isinstance(parsed, isodate.Duration):
-                # TODO: start should probably be a proper object, but we should
-                # really switch to relativedeltafield
-                parsed = parsed.totimedelta(start=datetime.datetime.now())
-            assert isinstance(parsed, datetime.timedelta)
-            return parsed
 
     def to_representation(self, value) -> Optional[str]:
-        if relativedelta and isinstance(value, relativedelta):
-            # relativedeltafield 1.1.2 returns a relativedelta() object with no duration,
-            # to keep behaviour consistent with older versions, change that to `None`
-            if not value:
-                return None
+        if isinstance(value, relativedelta):
             return format_relativedelta(value)
-
-        return isodate.duration_isoformat(value)
+        return None
 
 
 class FieldValidationErrorSerializer(serializers.Serializer):

commonground_api_common-2.6.0/vng_api_common/__init__.py

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