django-pfx 1.7.6.dev41__tar.gz → 1.7.6.dev45__tar.gz

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev41
+Version: 1.7.6.dev45
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev41
+Version: 1.7.6.dev45
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/django_pfx.egg-info/SOURCES.txt

@@ -236,6 +236,8 @@ tests/tests/test_fields_choices.py
 tests/tests/test_fields_date.py
 tests/tests/test_fields_decimal.py
 tests/tests/test_fields_help_text.py
+tests/tests/test_fields_media_local.py
+tests/tests/test_fields_media_s3.py
 tests/tests/test_fields_minutes_duration.py
 tests/tests/test_fields_one2many.py
 tests/tests/test_fields_rich_text.py

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/django_pfx.egg-info/scm_file_list.json

@@ -226,6 +226,8 @@
     "tests/tests/test_fields_date.py",
     "tests/tests/test_fields_decimal.py",
     "tests/tests/test_fields_help_text.py",
+    "tests/tests/test_fields_media_local.py",
+    "tests/tests/test_fields_media_s3.py",
     "tests/tests/test_fields_minutes_duration.py",
     "tests/tests/test_fields_one2many.py",
     "tests/tests/test_fields_rich_text.py",

django_pfx-1.7.6.dev45/django_pfx.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.7.5",
+  "distance": 45,
+  "node": "g8845c1a04b6c6ac983aab0c8fe02537313956a5f",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-28"
+}

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/doc/source/api.views.rst

@@ -32,6 +32,9 @@ API Reference
     :undoc-members:
     :show-inheritance:
 
+.. autoclass:: pfx.pfxcore.models.UniqueConstraint
+    :show-inheritance:
+
 .. autoclass:: pfx.pfxcore.models.AbstractPFXBaseUser
     :members:
     :show-inheritance:

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/doc/source/model.md

@@ -102,6 +102,52 @@ Which give the following result on the book service :
 }
 ```
 
+## UniqueConstraint
+
+`pfx.pfxcore.models.UniqueConstraint` extends the Django constraint
+to give a better validation error to the [PFX views](./pfx_views.md),
+which return it in their `422` response. It takes two optional
+parameters:
+
+* `message`: the error message, formatted with the values of the
+  constraint fields. It requires a model inheriting `PFXModelMixin`
+  and applies to a constraint on `fields` only.
+* `violation_error_field`: the field to report the error under.
+  Without it, Django reports the error globally (`__all__`) as soon as
+  the constraint is made of several fields or of expressions.
+
+```python
+from django.db import models
+from django.db.models.functions import Lower
+from pfx.pfxcore.models import PFXModelMixin, UniqueConstraint
+
+class Book(PFXModelMixin, models.Model):
+    name = models.CharField("Name", max_length=100)
+    author = models.ForeignKey(
+        'tests.Author', on_delete=models.RESTRICT,
+        related_name='books', verbose_name="Author")
+
+    class Meta:
+        constraints = [
+            UniqueConstraint(
+                'author', Lower('name'),
+                name='book_unique_author_and_name',
+                violation_error_message=(
+                    "This name is already used for this author."),
+                violation_error_field='name')]
+```
+
+A duplicate name then returns:
+```python
+{
+    "name": ["This name is already used for this author."]
+}
+```
+
+`violation_error_field` changes the validation only: from Django 5.2,
+changing it generates an `AlterConstraint` migration, without any
+change to the database.
+
 ## Not null char fields
 
 To avoid storing a mixture of empty strings and `null` values, while automatically

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/pfx/pfxcore/fields/media_field.py

@@ -6,8 +6,8 @@ from importlib import import_module
 from urllib.parse import unquote_to_bytes
 
 from django.core.exceptions import ValidationError
-from django.db import models
-from django.db.models.signals import post_delete, post_init, post_save
+from django.db import models, transaction
+from django.db.models.signals import post_init, post_save, pre_delete
 from django.dispatch import receiver
 
 from pfx.pfxcore.shortcuts import settings
@@ -104,6 +104,12 @@ class MediaField(models.JSONField):
             setattr(obj, self.name, self.upload(obj, file, name))
             obj.save(update_fields={self.name})
 
+        def delete_file(value):
+            transaction.on_commit(
+                lambda value=value: self.delete(value),
+                robust=True,
+            )
+
         after_save = []
         value = self.value_from_object(obj)
         if isinstance(value, dict):
@@ -112,10 +118,10 @@ class MediaField(models.JSONField):
         else:
             b64 = None
 
-        db_value = obj._media_db_values.get(self.name)
+        db_value = getattr(obj, f'_db_{self.name}')
         if db_value and (b64 or not value):
-            after_save.append(lambda: self.delete(db_value))
             setattr(obj, self.name, None)
+            after_save.append(lambda: delete_file(db_value))
         if b64:
             try:
                 file = decode_data_uri(b64)
@@ -160,21 +166,28 @@ class MediaField(models.JSONField):
         return self.storage.delete(value)
 
 
-# Kept on the instance: the field is shared by every instance of the model.
 @receiver(post_init)
 @receiver(post_save)
-def store_media_db_values(sender, instance, update_fields=None, **kwargs):
+def init_db_value(sender, instance, update_fields=None, **kwargs):
+    """Set the current db value in _db_{field_name} to track changes.
+
+    _db_{field_name} is the standard naming convention in PFX to track
+    current db value (normally done in `__init__()`).
+    """
     for field in sender._meta.fields:
         if isinstance(field, MediaField) and (
                 update_fields is None or field.name in update_fields):
-            if not hasattr(instance, '_media_db_values'):
-                instance._media_db_values = {}
-            instance._media_db_values[field.name] = (
+            setattr(
+                instance, f'_db_{field.name}',
                 field.value_from_object(instance))
 
 
-@receiver(post_delete)
-def post_delete_media(sender, instance, **kwargs):
+@receiver(pre_delete)
+def pre_delete_media(sender, instance, **kwargs):
     for field in sender._meta.fields:
         if isinstance(field, MediaField) and field.auto_delete:
-            field.storage.delete(field.value_from_object(instance))
+            value = field.value_from_object(instance)
+            transaction.on_commit(
+                lambda field=field, value=value: field.storage.delete(value),
+                robust=True,
+            )

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2026-10-05 17:02+0200\n"
+"POT-Creation-Date: 2026-10-28 14:02+0100\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -175,7 +175,7 @@ msgstr "MFA forcé"
 msgid "sequence"
 msgstr "séquence"
 
-#: models/pfx_models.py:14
+#: models/pfx_models.py:26
 #, python-format
 msgid "%(model_name)s with this %(field_labels)s already exists."
 msgstr "%(model_name)s avec ce/cette %(field_labels)s existe déjà."

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/pfx/pfxcore/models/pfx_models.py

@@ -1,7 +1,7 @@
 
 import logging
 
-from django.core.exceptions import NON_FIELD_ERRORS, ValidationError
+from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
@@ -9,14 +9,42 @@ logger = logging.getLogger(__name__)
 
 
 class UniqueConstraint(models.UniqueConstraint):
-    def __init__(self, *args, message=None, **kwargs):
+    """A unique constraint with a richer validation error.
+
+    :param message: The error message, formatted with the values of the
+        constraint fields (``%(name)s already exists``)
+    :param violation_error_field: The field to report the error under,
+        instead of the global errors (``__all__``)
+    """
+    non_db_attrs = (
+        *getattr(models.UniqueConstraint, 'non_db_attrs', ()),
+        'violation_error_field')
+
+    def __init__(
+            self, *args, message=None, violation_error_field=None, **kwargs):
         self.message = message or _(
             "%(model_name)s with this %(field_labels)s already exists.")
+        self.violation_error_field = violation_error_field
         super().__init__(*args, **kwargs)
 
+    def validate(self, *args, **kwargs):
+        try:
+            super().validate(*args, **kwargs)
+        except ValidationError as e:
+            if not self.violation_error_field:
+                raise
+            raise ValidationError({self.violation_error_field: e})
+
+    def __eq__(self, other):
+        return super().__eq__(other) and (
+            self.violation_error_field ==
+            getattr(other, 'violation_error_field', None))
+
     def deconstruct(self):
         path, args, kwargs = super().deconstruct()
         kwargs['message'] = self.message
+        if self.violation_error_field:
+            kwargs['violation_error_field'] = self.violation_error_field
         return path, args, kwargs
 
 
@@ -85,8 +113,9 @@ class ErrorMessageMixin():
     """A model mixin to improve mode validation errors."""
 
     def validate_constraints(self, exclude=None):
-        """Override validate_unique to allow to customize error message
-        for :class:`UniqueConstraint`.
+        """Override validate_constraints to apply the custom message
+        of a :class:`UniqueConstraint`, whatever the field its error is
+        reported under.
         """
         def objgetattr(obj, f):
             v = getattr(obj, f)
@@ -99,11 +128,11 @@ class ErrorMessageMixin():
         try:
             return super().validate_constraints(exclude=exclude)
         except ValidationError as e:
-            errors = e.update_error_dict({})
-            non_field_errors = []
-            for error in errors.get(NON_FIELD_ERRORS, []):
-                if isinstance(error, ValidationError):
-                    if error.code in ('unique', 'unique_together'):
+            errors = {}
+            for key, field_errors in e.update_error_dict({}).items():
+                for error in field_errors:
+                    if (isinstance(error, ValidationError) and
+                            error.code in ('unique', 'unique_together')):
                         model = error.params['model_class']
                         unique_check = error.params['unique_check']
                         unique = next(filter(
@@ -114,13 +143,11 @@ class ErrorMessageMixin():
                             params = dict(error.params)
                             params.update({
                                 f: objgetattr(self, f) for f in unique_check})
-                            non_field_errors.append(ValidationError(
+                            error = ValidationError(
                                 message=unique.message,
                                 code=error.code,
-                                params=params))
-                            continue
-                non_field_errors.append(error)
-            errors[NON_FIELD_ERRORS] = non_field_errors
+                                params=params)
+                    errors.setdefault(key, []).append(error)
             raise ValidationError(errors)
 
 

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/pfx/pfxcore/test.py

@@ -1,3 +1,4 @@
+import base64
 import copy
 import csv
 import io
@@ -218,7 +219,6 @@ class APIClient(DjangoClient):
 
 
 class TestAssertMixin:
-
     # assert response status code
     def assertRC(self, response, code, msg=None):
         msg = '\n'.join([msg or '', response.formatted()])
@@ -291,6 +291,21 @@ class TestAssertMixin:
         return self.assertNotIn(
             element, self.get_val(src, key, msg=msg), msg=msg)
 
+    def as_data_url(self, content="Test content"):
+        if isinstance(content, str):
+            content = content.encode()
+        b64 = base64.b64encode(content).decode('ascii')
+        return f"data:text/plain;charset=utf-8;base64,{b64}"
+
+    @classmethod
+    def upload_file(
+            cls, obj, field='file', file_name='test.txt',
+            content="A test file content.", **kw):
+        if isinstance(content, str):
+            content = content.encode()
+        return obj.__class__._meta.get_field(field).upload(
+            obj, content, file_name)
+
 
 class TestPermsAssertMixin(TestAssertMixin):
     USER_TESTS = {}

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/tests/locale/fr/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2026-07-30 09:12+0200\n"
+"POT-Creation-Date: 2026-10-28 14:02+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -18,11 +18,11 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n > 1);\n"
 
-#: models.py:57
+#: models.py:58
 msgid "First Name"
 msgstr "Prénom"
 
-#: models.py:58
+#: models.py:59
 msgid "Last Name"
 msgstr "Nom"
 

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/tests/migrations/0001_initial.py

@@ -3,6 +3,7 @@
 
 import django.contrib.auth.validators
 import django.db.models.deletion
+import django.db.models.functions.text
 import django.utils.timezone
 from django.db import migrations, models
 
@@ -128,4 +129,12 @@ class Migration(migrations.Migration):
             model_name='book',
             constraint=pfx.pfxcore.models.pfx_models.UniqueConstraint(fields=('author', 'name'), message='%(name)s already exists for %(author)s', name='book_unique_author_and_name'),
         ),
+        migrations.AddConstraint(
+            model_name='book',
+            constraint=pfx.pfxcore.models.pfx_models.UniqueConstraint(models.F('author'), django.db.models.functions.text.Lower('name'), message='%(model_name)s with this %(field_labels)s already exists.', name='book_unique_author_and_lower_name', violation_error_field='name', violation_error_message='This name is already used for this author.'),
+        ),
+        migrations.AddConstraint(
+            model_name='book',
+            constraint=pfx.pfxcore.models.pfx_models.UniqueConstraint(fields=('author', 'pages'), message='A book of %(pages)s pages exists for %(author)s', name='book_unique_author_and_pages', violation_error_field='pages'),
+        ),
     ]

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/tests/models.py

@@ -1,5 +1,6 @@
 from django.db import models
 from django.db.models import Q
+from django.db.models.functions import Lower
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
 
@@ -151,7 +152,18 @@ class Book(CacheDependsMixin, PFXModelMixin, models.Model):
             UniqueConstraint(
                 fields=['author', 'name'],
                 name='book_unique_author_and_name',
-                message="%(name)s already exists for %(author)s")]
+                message="%(name)s already exists for %(author)s"),
+            UniqueConstraint(
+                'author', Lower('name'),
+                name='book_unique_author_and_lower_name',
+                violation_error_message=(
+                    "This name is already used for this author."),
+                violation_error_field='name'),
+            UniqueConstraint(
+                fields=['author', 'pages'],
+                name='book_unique_author_and_pages',
+                message="A book of %(pages)s pages exists for %(author)s",
+                violation_error_field='pages')]
 
     def __str__(self):
         return f"{self.name}"

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/tests/tests/__init__.py

@@ -17,6 +17,8 @@ from .test_emails_test_tools import (
 from .test_fields_choices import TestFieldsChoices
 from .test_fields_date import TestFieldsDate
 from .test_fields_decimal import TestFieldsDecimal
+from .test_fields_media_local import TestFieldsMediaLocal
+from .test_fields_media_s3 import TestFieldsMediaS3
 from .test_fields_minutes_duration import TestFieldsMinutesDuration
 from .test_fields_one2many import TestFieldsOne2Many
 from .test_fields_rich_text import TestFieldsRichText

{django_pfx-1.7.6.dev41 → django_pfx-1.7.6.dev45}/tests/tests/basic_api_test.py

@@ -828,11 +828,12 @@ class BasicAPITest(TestAssertMixin, TestCase):
         self.assertTrue(Path(f'/tmp/django-pfx-filestore/{key1}').exists())
 
         # Replace file
-        response = self.client.put(f'/api/books/{book_pk}', dict(
-            local_file=dict(
-                name='test2.txt',
-                base64='data:text/plain;charset=utf-8;'
-                'base64,TmV3IGNvbnRlbnQ=')))
+        with self.captureOnCommitCallbacks(execute=True):
+            response = self.client.put(f'/api/books/{book_pk}', dict(
+                local_file=dict(
+                    name='test2.txt',
+                    base64='data:text/plain;charset=utf-8;'
+                    'base64,TmV3IGNvbnRlbnQ=')))
         self.assertRC(response, 200)
         self.assertNJE(response, 'local_file.key', key1)
         self.assertJE(response, 'local_file.name', 'test2.txt')
@@ -841,8 +842,9 @@ class BasicAPITest(TestAssertMixin, TestCase):
         self.assertTrue(Path(f'/tmp/django-pfx-filestore/{key2}').exists())
 
         # Delete file
-        response = self.client.put(f'/api/books/{book_pk}', dict(
-            local_file=None))
+        with self.captureOnCommitCallbacks(execute=True):
+            response = self.client.put(f'/api/books/{book_pk}', dict(
+                local_file=None))
         self.assertRC(response, 200)
         self.assertJE(response, 'local_file', None)
         self.assertFalse(Path(f'/tmp/django-pfx-filestore/{key2}').exists())
@@ -865,10 +867,11 @@ class BasicAPITest(TestAssertMixin, TestCase):
         book.local_file = dict(
             name='new.txt',
             base64='data:text/plain;charset=utf-8;base64,TmV3IGNvbnRlbnQ=')
-        funcs = Book._meta.get_field('local_file').media_pre_save(book)
-        book.save()
-        for func in funcs:
-            func()
+        with self.captureOnCommitCallbacks(execute=True):
+            funcs = Book._meta.get_field('local_file').media_pre_save(book)
+            book.save()
+            for func in funcs:
+                func()
         return book.local_file['key']
 
     def test_replace_file_after_loading_another_object(self):
@@ -1052,6 +1055,34 @@ class BasicAPITest(TestAssertMixin, TestCase):
             response, '__all__.@0',
             'The Hobbit already exists for John Ronald Reuel Tolkien')
 
+    def test_create_unique_error_field(self):
+        """A constraint on an expression reports its error globally in
+        Django: `violation_error_field` puts it under the field."""
+        response = self.client.post(
+            '/api/books', dict(
+                name="the hobbit",
+                author=self.author1.pk,
+                pub_date="1937-09-21"))
+        self.assertRC(response, 422)
+        self.assertJE(
+            response, 'name.@0', "This name is already used for this author.")
+        self.assertJENotExists(response, '__all__')
+
+    def test_create_unique_custom_message_error_field(self):
+        """The custom message still applies to an error reported under a
+        field."""
+        response = self.client.post(
+            '/api/books', dict(
+                name="The End of Eternity",
+                author=self.author3.pk,
+                pub_date="1955-01-01",
+                pages=224))
+        self.assertRC(response, 422)
+        self.assertJE(
+            response, 'pages.@0',
+            'A book of 224 pages exists for Isaac Asimov')
+        self.assertJENotExists(response, '__all__')
+
     def test_create_invalid_date(self):
         response = self.client.post(
             '/api/books', dict(
@@ -1426,14 +1457,15 @@ class BasicAPITest(TestAssertMixin, TestCase):
             response, f"http://dragonfly.fake/{key}",
             fetch_redirect_response=False)
 
-        with patch.object(
+        with (patch.object(
                 MockBoto3Client, 'delete_object',
-                return_value=None) as mock_delete:
+                return_value=None) as mock_delete,
+                self.captureOnCommitCallbacks(execute=True)):
             response = self.client.delete(
                 f'/api/books/{self.author1_book1.pk}')
-            mock_delete.assert_called_with(
-                Bucket='dragonfly.fake',
-                Key=key)
+        mock_delete.assert_called_with(
+            Bucket='dragonfly.fake',
+            Key=key)
 
     def test_annotate_meta_service(self):
         response = self.client.get('/api/authors-annotate/meta')