Merge pull request #30 from uptick/date-format

feat: format dates when getting extrafields for display

Author: chengyin-uptick

example/library/tests.py

@@ -27,7 +27,7 @@ def test_create_field(self):
         )
         field.save()
         self.assertIsNotNone(field.id)
-        self.assertEqual(str(field), "library | book published")
+        self.assertEqual(str(field), "Library | book published")
 
     def test_metadata(self):
         from .models import Book
@@ -188,3 +188,100 @@ def test_relational_conditions(self):
         metadata = book2.get_metadata_fieldlist()
         fields = {x[1]: x for x in metadata}
         self.assertIn("dewey_decimal", fields)
+
+    def test_localisation_dependent_formatting(self):
+        from .models import Book
+        from django.utils import translation
+        from django.test import override_settings
+
+        field = ExtraField(
+            content_type=self.book_type,
+            label="Publication Date",
+            name="pub_date",
+            widget="date",
+        )
+        field.save()
+
+        book = Book(
+            name="Test Book",
+            metadata={"pub_date": "2026-02-03"},
+        )
+        book.save()
+
+        # Set DJANGO_USER_DEFINED_FIELD_DATE_FORMAT to None to enable locale-aware formatting.
+        # When None, date_format() respects the active locale's DATE_FORMAT setting.
+        with override_settings(DJANGO_USER_DEFINED_FIELD_DATE_FORMAT=None):
+            # https://github.com/django/django/blob/main/django/conf/locale/en_AU/formats.py
+            with translation.override("en-au"):
+                metadata = book.get_metadata_fieldlist()
+                fields = {x[1]: x for x in metadata}
+                self.assertEqual(fields["pub_date"][3], "3 Feb 2026")
+            
+            # https://github.com/django/django/blob/main/django/conf/locale/en/formats.py
+            with translation.override("en-us"):
+                metadata = book.get_metadata_fieldlist()
+                fields = {x[1]: x for x in metadata}
+                self.assertEqual(fields["pub_date"][3], "Feb. 3, 2026")
+
+    def test_date_formatting(self):
+        from .models import Book
+        from django.test import override_settings
+
+        field = ExtraField(
+            content_type=self.book_type,
+            label="Publication Date",
+            name="pub_date",
+            widget="date",
+        )
+        field.save()
+
+        book = Book(
+            name="Test Book",
+            metadata={"pub_date": "2026-02-03"},
+        )
+        book.save()
+
+        with override_settings(DJANGO_USER_DEFINED_FIELD_DATE_FORMAT="d/m/Y"):
+            metadata = book.get_metadata_fieldlist()
+            fields = {x[1]: x for x in metadata}
+            self.assertEqual(fields["pub_date"][3], "03/02/2026")
+
+        with override_settings(DJANGO_USER_DEFINED_FIELD_DATE_FORMAT="Y-m-d"):
+            metadata = book.get_metadata_fieldlist()
+            fields = {x[1]: x for x in metadata}
+            self.assertEqual(fields["pub_date"][3], "2026-02-03")
+
+    def test_date_formatting_invalid_date(self):
+        from .models import Book
+
+        field = ExtraField(
+            content_type=self.book_type,
+            label="Publication Date",
+            name="pub_date",
+            widget="date",
+        )
+        field.save()
+
+        # book with string date value, 
+        book = Book(
+            name="Test Book",
+            metadata={"pub_date": "not-a-valid-date"},
+        )
+        book.save()
+
+        # Test that invalid date is kept
+        metadata = book.get_metadata_fieldlist()
+        fields = {x[1]: x for x in metadata}
+        self.assertEqual(fields["pub_date"][3], "not-a-valid-date")
+
+        # book with int date value
+        book = Book(
+            name="Test Book",
+            metadata={"pub_date": 1234567890},
+        )
+        book.save()
+
+        # Test that invalid date is kept
+        metadata = book.get_metadata_fieldlist()
+        fields = {x[1]: x for x in metadata}
+        self.assertEqual(fields["pub_date"][3], 1234567890)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-user-defined-fields"
-version = "0.0.23"
+version = "0.0.24"
 description = "A Django app for user defined fields"
 authors = ["Aidan Lister <aidan@uptickhq.com>"]
 license = "MIT"

userdefinedfields/fields.py

@@ -1,10 +1,13 @@
+from datetime import datetime
 from functools import partialmethod
 
+from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
 from django.core.exceptions import FieldDoesNotExist
 from django.db.models import JSONField
 from django.db.models.fields.related import ForeignKey
+from django.utils.formats import date_format
 
 from .models import ExtraField
 
@@ -23,7 +26,6 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def _get_EXTRAFIELD_fieldlist(self, obj, field, use_cache=False):
-
         # grab the relevant extrafields for this content type
         # Cache the results, if using the cache
         if use_cache:
@@ -100,7 +102,9 @@ def _get_EXTRAFIELD_fieldlist(self, obj, field, use_cache=False):
                         break
 
                 # Check to see whether the condition is satisfied.
-                if str(getattr(target_obj, f"{dc_field.name}_id")) not in dc.values.split(","):
+                if str(
+                    getattr(target_obj, f"{dc_field.name}_id")
+                ) not in dc.values.split(","):
                     # Don't add the field if the id is not on the object
                     break
             else:
@@ -113,6 +117,16 @@ def _get_EXTRAFIELD_fieldlist(self, obj, field, use_cache=False):
         for f in filtered_fields:
             val = data.get(f.name, None)
 
+            if f.widget == "date" and val:
+                try:
+                    date_obj = datetime.strptime(val, "%Y-%m-%d").date()
+                    date_format_str = getattr(
+                        settings, "DJANGO_USER_DEFINED_FIELD_DATE_FORMAT", "Y-m-d"
+                    )
+                    val = date_format(date_obj, date_format_str)
+                except (ValueError, TypeError):
+                    pass
+
             # overwrite val with the pretty value if it's a choice field
             if "choices" in f.field_settings:
                 choices = {
@@ -147,11 +161,15 @@ def contribute_to_class(self, cls, name, **kwargs):
         setattr(
             cls,
             f"get_cached_{name}_display",
-            partialmethod_with_self(self._get_EXTRAFIELD_display, field=self, use_cache=True),
+            partialmethod_with_self(
+                self._get_EXTRAFIELD_display, field=self, use_cache=True
+            ),
         )
         setattr(
             cls,
             f"get_cached_{name}_fieldlist",
-            partialmethod_with_self(self._get_EXTRAFIELD_fieldlist, field=self, use_cache=True),
+            partialmethod_with_self(
+                self._get_EXTRAFIELD_fieldlist, field=self, use_cache=True
+            ),
         )
         super().contribute_to_class(cls, name)