django-pfx 1.4.dev110__tar.gz → 1.4.dev114__tar.gz

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev110
+Version: 1.4.dev114
 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.4.dev110 → django_pfx-1.4.dev114}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev110
+Version: 1.4.dev114
 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.4.dev110 → django_pfx-1.4.dev114}/django_pfx.egg-info/SOURCES.txt

@@ -48,6 +48,7 @@ pfx/pfxcore/apidoc/tags.py
 pfx/pfxcore/decorator/__init__.py
 pfx/pfxcore/decorator/rest.py
 pfx/pfxcore/fields/__init__.py
+pfx/pfxcore/fields/decimal_field.py
 pfx/pfxcore/fields/media_field.py
 pfx/pfxcore/fields/minutes_duration_field.py
 pfx/pfxcore/fields/nh3_field.py
@@ -126,6 +127,8 @@ tests/urls.py
 tests/views.py
 tests/locale/fr/LC_MESSAGES/django.po
 tests/migrations/0001_initial.py
+tests/migrations/0002_alter_book_cover.py
+tests/migrations/0003_book_local_file.py
 tests/migrations/__init__.py
 tests/settings/__init__.py
 tests/settings/ci.py
@@ -143,6 +146,7 @@ tests/tests/test_body_mixin.py
 tests/tests/test_cache.py
 tests/tests/test_client.py
 tests/tests/test_fields_choices.py
+tests/tests/test_fields_decimal.py
 tests/tests/test_fields_minutes_duration.py
 tests/tests/test_fields_nh3.py
 tests/tests/test_filters.py

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/decorator/rest.py

@@ -65,6 +65,7 @@ def rest_property(string=None, type="CharField"):
 def rest_view(path):
     def decorator(cls):
         cls.rest_view_path[cls] = path
+        cls._rest_view_path = path
         return cls
     return decorator
 

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/fields/__init__.py

@@ -1,3 +1,4 @@
+from .decimal_field import DecimalField
 from .media_field import MediaField
 from .minutes_duration_field import MinutesDurationField
 from .nh3_field import NH3Field

django_pfx-1.4.dev114/pfx/pfxcore/fields/decimal_field.py

@@ -0,0 +1,15 @@
+from decimal import Decimal
+
+from django.db import models
+
+
+class DecimalField(models.DecimalField):
+    def __init__(self, *args, json_decimal_places=None, **kw):
+        super().__init__(*args, **kw)
+        self.json_quantize = Decimal(10) ** -(
+            json_decimal_places or self.decimal_places)
+
+    def to_json(self, value):
+        if value is None:
+            return None
+        return value.quantize(self.json_quantize)

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/fields/media_field.py

@@ -1,5 +1,6 @@
 import logging
 from importlib import import_module
+from urllib.request import urlopen
 
 from django.db import models
 from django.db.models.signals import post_delete
@@ -27,15 +28,31 @@ class MediaField(models.JSONField):
         self.storage = storage or get_storage_class(settings.STORAGE_DEFAULT)
         self.auto_delete = auto_delete
         super().__init__(
-            *args, max_length=max_length,
-            default=kwargs.pop('default', dict),
-            blank=kwargs.pop('blank', True),
-            **kwargs)
+            *args, max_length=max_length, **kwargs)
 
     @staticmethod
     def get_default_key(obj, filename):
         return f"{type(obj).__name__}/{obj.pk}/{filename}"
 
+    def clean(self, value, obj):
+        def save_file(obj, file, name):
+            setattr(obj, self.name, self.upload(obj, file, name))
+            obj.save(update_fields={self.name})
+
+        if isinstance(value, dict):
+            toDelete = value.pop('toDelete', None)
+            b64 = value.pop('base64', None)
+            name = value.get('name')
+            if toDelete:
+                obj._after_save.append(lambda: self.delete(toDelete))
+                value = None
+            if b64:
+                with urlopen(b64) as response:
+                    file = response.read()
+                value = dict(key=self.get_key(obj, file))
+                obj._after_save.append(lambda: save_file(obj, file, name))
+        return super().clean(value, obj)
+
     def to_python(self, value):
         return super().to_python(self.storage.to_python(value))
 
@@ -52,6 +69,9 @@ class MediaField(models.JSONField):
         key = self.get_key(obj, filename)
         return self.to_python(self.storage.upload(key, file, **kwargs))
 
+    def delete(self, value):
+        return self.storage.delete(value)
+
 
 @receiver(post_delete)
 def post_delete_media(sender, instance, **kwargs):

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/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: 2025-04-01 13:31+0200\n"
+"POT-Creation-Date: 2025-04-08 13:56+0200\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -297,7 +297,7 @@ msgstr "{model} {obj} créé."
 msgid "{model} {obj} updated."
 msgstr "{model} {obj} modifié."
 
-#: views/rest_views.py:1165
+#: views/rest_views.py:1169
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/models/pfx_models.py

@@ -26,6 +26,10 @@ class JSONReprMixin():
     url = None
     apidoc = {}
 
+    def __init__(self, *args, **kw):
+        super().__init__(*args, **kw)
+        self._after_save = []
+
     def get_url(self):
         return self.url
 

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/storage/local_storage.py

@@ -40,7 +40,7 @@ class LocalStorage:
             }
 
     def delete(self, value):
-        if 'key' not in value:
+        if not value or 'key' not in value:
             return value  # pragma: no cover
         path = Path(settings.STORAGE_LOCAL_ROOT, value['key'])
         path.unlink(missing_ok=True)
@@ -48,6 +48,8 @@ class LocalStorage:
             path = path.parent
             if path == Path(settings.STORAGE_LOCAL_ROOT):
                 break
+            if not path.exists():
+                break
             if any(path.iterdir()):
                 break
             try:

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/views/fields.py

@@ -43,6 +43,8 @@ class FieldType:
 
     MODEL_FIELD_BINDING = [
         (pfx_fields.MinutesDurationField, MinutesDurationField),
+        (pfx_fields.MediaField, MediaField),
+        (pfx_fields.DecimalField, DecimalField),
         (models.BooleanField, BooleanField),
         (models.IntegerField, IntegerField),
         (models.FloatField, FloatField),
@@ -143,14 +145,24 @@ class ViewField:
             return self.json_repr(value)
         return value.json_repr()
 
-    def to_json(self, obj):
+    def to_json(self, view, obj):
         value = self.get_value(obj)
-        if self.field_type == FieldType.MinutesDurationField:
-            return pfx_fields.MinutesDurationField.to_json(value)
+
         if self.field_type == FieldType.ModelObject:
             return self._json_repr(value)
         if self.field_type == FieldType.ModelObjectList:
             return [self._json_repr(o) for o in value.all()]
+
+        if self.json_repr:
+            return self.json_repr(value)
+
+        if self.field_type == FieldType.MediaField:
+            if value:
+                api_url = view._rest_view_path
+                value['url'] = f'{api_url}/{obj.pk}/{self.name}'
+                return value
+            else:
+                return None
         if self.choices:
             if value in self.choices:
                 return dict(value=value, label=str(self.choices[value]))
@@ -295,6 +307,8 @@ class ViewModelField(ViewField):
             self, name, model_field=None, **kwargs):
         super().__init__(name, **kwargs)
         self.model_field = model_field
+        if hasattr(model_field, 'to_json'):
+            self.json_repr = model_field.to_json
         if (hasattr(self.model_field, 'related_model') and
                 self.model_field.related_model and not self.related_model):
             self.related_model = self.model_field.related_model

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/pfx/pfxcore/views/rest_views.py

@@ -291,7 +291,7 @@ class ModelResponseMixin(ModelMixin):
         :rtype: :class:`JsonResponse`
         """
         return JsonResponse(self.serialize_object(o, **{
-            _f.alias: _f.to_json(o)
+            _f.alias: _f.to_json(self, o)
             for _f in self.get_fields().values()}, meta=meta))
 
     def validate(self, obj, rel_data=None, created=False, **kwargs):
@@ -339,11 +339,15 @@ class ModelResponseMixin(ModelMixin):
         :returns: The JSON response
         :rtype: :class:`JsonResponse`
         """
-        if rel_data:
+        if rel_data or obj._after_save:
             with transaction.atomic():
                 obj.save()
-                for k, v in rel_data.items():
-                    getattr(obj, k).set(v)
+                if rel_data:
+                    for k, v in rel_data.items():
+                        getattr(obj, k).set(v)
+                for callback in obj._after_save:
+                    callback()
+                obj._after_save = []
         else:
             obj.save()
         obj = self.get_object(pk=obj.pk)
@@ -754,7 +758,7 @@ class ListRestViewMixin(ModelResponseMixin):
             *self.get_list_fields_prefetch_related())
         for o in qs:
             yield self.serialize_object(o, **{
-                _f.alias: _f.to_json(o)
+                _f.alias: _f.to_json(self, o)
                 for _f in self.get_list_fields().values()})
 
     def get_short_list_result(self, qs):

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/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: 2025-02-17 12:19+0100\n"
+"POT-Creation-Date: 2025-04-08 13:56+0200\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:68
+#: models.py:69
 msgid "First Name"
 msgstr "Prénom"
 
-#: models.py:69
+#: models.py:70
 msgid "Last Name"
 msgstr "Nom"
 

django_pfx-1.4.dev114/tests/migrations/0002_alter_book_cover.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.17 on 2025-04-08 05:19
+# flake8: noqa
+
+from django.db import migrations
+
+import pfx.pfxcore.fields.media_field
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='book',
+            name='cover',
+            field=pfx.pfxcore.fields.media_field.MediaField(blank=True, max_length=255, null=True, verbose_name='Cover'),
+        ),
+    ]

django_pfx-1.4.dev114/tests/migrations/0003_book_local_file.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.17 on 2025-04-08 06:36
+# flake8: noqa
+
+from django.db import migrations
+
+import pfx.pfxcore.fields.media_field
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0002_alter_book_cover'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='book',
+            name='local_file',
+            field=pfx.pfxcore.fields.media_field.MediaField(blank=True, max_length=255, null=True, verbose_name='Cover'),
+        ),
+    ]

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/tests/models.py

@@ -18,6 +18,7 @@ from pfx.pfxcore.models import (
     UniqueConstraint,
     UserFilteredQuerySetMixin,
 )
+from pfx.pfxcore.storage import LocalStorage
 
 
 class User(CacheableMixin, OtpUserMixin, AbstractPFXUser):
@@ -145,7 +146,11 @@ class Book(CacheDependsMixin, PFXModelMixin, models.Model):
     rating = models.FloatField("Rating", null=True, blank=True)
     reference = models.CharField(
         "Reference", max_length=30, null=True, blank=True)
-    cover = MediaField("Cover", auto_delete=True)
+    cover = MediaField(
+        "Cover", auto_delete=True, blank=True, null=True)
+    local_file = MediaField(
+        "Cover", auto_delete=True, blank=True, null=True,
+        storage=LocalStorage())
     read_time = MinutesDurationField("Read Time", null=True, blank=True)
 
     class Meta:

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/tests/tests/__init__.py

@@ -7,6 +7,7 @@ from .test_body_mixin import TestBodyMixin
 from .test_cache import TestCache
 from .test_client import TestApiClient
 from .test_fields_choices import TestFieldsChoices
+from .test_fields_decimal import TestFieldsDecimal
 from .test_fields_minutes_duration import TestFieldsMinutesDuration
 from .test_fields_nh3 import TestFieldsNh3
 from .test_filters import FiltersTest

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/tests/tests/basic_api_test.py

@@ -1,4 +1,5 @@
 from datetime import date
+from pathlib import Path
 from unittest.mock import MagicMock, patch
 
 from django.db import connection
@@ -8,6 +9,9 @@ from pfx.pfxcore.test import APIClient, MockBoto3Client, TestAssertMixin
 from tests.models import Author, Book, BookType
 
 
+@override_settings(
+    STORAGE_LOCAL_ROOT='/tmp/django-pfx-filestore',
+    STORAGE_LOCAL_X_ACCEL_REDIRECT=False)
 class BasicAPITest(TestAssertMixin, TestCase):
 
     def setUp(self):
@@ -704,6 +708,59 @@ class BasicAPITest(TestAssertMixin, TestCase):
         self.assertJE(response, 'types.@0.pk', self.type_sf.pk)
         self.assertJE(response, 'types.@1.pk', self.type_fantastique.pk)
 
+    def test_create_file(self):
+        response = self.client.post('/api/books', dict(
+            name="Test Book",
+            author=self.author1.pk,
+            pub_date='2000-01-01',
+            local_file=dict(
+                name='test.txt',
+                base64='data:text/plain;charset=utf-8;'
+                'base64,VGVzdCBjb250ZW50')))
+        book_pk = self.get_val(response, 'pk')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'local_file.content-length', '12')
+        self.assertJE(response, 'local_file.content-type', 'text/plain')
+        self.assertJE(
+            response, 'local_file.key',
+            f"Book/{book_pk}/bca20547e94049e1ffea27223581c567022a5774.txt")
+        self.assertJE(response, 'local_file.name', 'test.txt')
+        self.assertJE(
+            response, 'local_file.url', f"/books/{book_pk}/local_file")
+        self.assertTrue(Path(
+            f'/tmp/django-pfx-filestore/Book/{book_pk}/'
+            'bca20547e94049e1ffea27223581c567022a5774.txt').exists())
+
+        # Replace file
+        old_file = self.get_val(response, 'local_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=',
+                toDelete=old_file)))
+        self.assertRC(response, 200)
+        self.assertJE(
+            response, 'local_file.key',
+            f"Book/{book_pk}/af9f06b2b3b1546ac44f4a02994d0ef09e074b91.txt")
+        self.assertJE(response, 'local_file.name', 'test2.txt')
+        self.assertFalse(Path(
+            f'/tmp/django-pfx-filestore/Book/{book_pk}/'
+            'bca20547e94049e1ffea27223581c567022a5774.txt').exists())
+        self.assertTrue(Path(
+            f'/tmp/django-pfx-filestore/Book/{book_pk}/'
+            'af9f06b2b3b1546ac44f4a02994d0ef09e074b91.txt').exists())
+
+        # Delete file
+        old_file = self.get_val(response, 'local_file')
+        response = self.client.put(f'/api/books/{book_pk}', dict(
+            local_file=dict(toDelete=old_file)))
+        self.assertRC(response, 200)
+        self.assertJE(response, 'local_file', None)
+        self.assertFalse(Path(
+            f'/tmp/django-pfx-filestore/Book/{book_pk}/'
+            'af9f06b2b3b1546ac44f4a02994d0ef09e074b91.txt').exists())
+
     def test_create_null_values(self):
         response = self.client.post(
             '/api/books', dict(

django_pfx-1.4.dev114/tests/tests/test_fields_decimal.py

@@ -0,0 +1,59 @@
+from decimal import Decimal
+
+from django.db import connection, models
+from django.test import TestCase
+from django.test.utils import override_settings
+from django.urls import include, path
+
+from pfx.pfxcore import register_views
+from pfx.pfxcore.decorator import rest_view
+from pfx.pfxcore.fields import DecimalField
+from pfx.pfxcore.models import JSONReprMixin
+from pfx.pfxcore.test import APIClient, TestAssertMixin
+from pfx.pfxcore.views import RestView
+from tests.views import FakeViewMixin
+
+
+class TestDecimalModel(JSONReprMixin, models.Model):
+    decimal = DecimalField(
+        max_digits=10, decimal_places=5, json_decimal_places=2)
+
+    class Meta:
+        verbose_name = "TestModel"
+        verbose_name_plural = "TestModels"
+        ordering = ['pk']
+
+
+@rest_view("/test-decimal-model")
+class DecimalModelRestView(FakeViewMixin, RestView):
+    default_public = True
+    model = TestDecimalModel
+    fields = ['decimal']
+
+
+urlpatterns = [
+    path('api/', include(register_views(DecimalModelRestView))),
+    path('api/', include('pfx.pfxcore.urls'))
+]
+
+
+@override_settings(ROOT_URLCONF=__name__)
+class TestFieldsDecimal(TestAssertMixin, TestCase):
+
+    def setUp(self):
+        self.client = APIClient(default_locale='en')
+
+    @classmethod
+    def setUpTestData(cls):
+        with connection.schema_editor() as schema_editor:
+            schema_editor.create_model(TestDecimalModel)
+
+    def test_decimal(self):
+        t = TestDecimalModel.objects.create(decimal=3.14)
+        t.save()
+        t.refresh_from_db()
+        self.assertEqual(t.decimal, Decimal('3.14000'))
+
+        response = self.client.get(f'/api/test-decimal-model/{t.pk}')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'decimal', "3.14")

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/tests/tests/test_view_fields.py

@@ -88,7 +88,7 @@ class ViewFieldTest(TestAssertMixin, TestCase):
             FieldType.MinutesDurationField)
         self.assertEqual(
             FieldType.from_model_field(pfx_fields.MediaField),
-            FieldType.JsonObject)
+            FieldType.MediaField)
 
     def test_field_by_name(self):
         field = ViewField.from_name(Book, 'name')

{django_pfx-1.4.dev110 → django_pfx-1.4.dev114}/tests/views.py

@@ -218,7 +218,7 @@ class BookRestViewMixin():
     model = Book
     fields = [
         'name', 'author', 'pub_date', VF('created_at', readonly=True),
-        'type', 'cover', 'pages', 'rating', 'author__last_name',
+        'type', 'cover', 'local_file', 'pages', 'rating', 'author__last_name',
         'read_time']
     filters = [
         FilterGroup('custom', _("Custom"), [