django-pfx 1.4.dev52__tar.gz → 1.4.dev56__tar.gz

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.4.dev52
+Version: 1.4.dev56
 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.dev52 → django_pfx-1.4.dev56}/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: 2024-05-21 15:30+0200\n"
+"POT-Creation-Date: 2024-12-10 13:34+0100\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -254,7 +254,7 @@ msgstr ""
 msgid "A new authentication code has been sent by email."
 msgstr "Un nouveau code d'authentification a été envoyé par e-mail."
 
-#: views/filters_views.py:79
+#: views/filters_views.py:81
 #, python-brace-format
 msgid "Invalid value for {filter} filter"
 msgstr "Valeur invalide pour le filtre {filter}"
@@ -275,11 +275,11 @@ msgstr "{model} {obj} créé."
 msgid "{model} {obj} updated."
 msgstr "{model} {obj} modifié."
 
-#: views/rest_views.py:1077
+#: views/rest_views.py:1086
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."
 
-#: views/rest_views.py:1139 views/rest_views.py:1167
+#: views/rest_views.py:1178 views/rest_views.py:1218
 msgid "Unexpected storage error"
 msgstr "Erreur de stockage inattendue"

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/pfx/pfxcore/models/pfx_models.py

@@ -22,6 +22,7 @@ class UniqueConstraint(models.UniqueConstraint):
 
 class JSONReprMixin():
     """A model mixin to manage JSON representation."""
+    api = None
     apidoc = {}
 
     def json_repr(self, **values):

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/pfx/pfxcore/views/filters_views.py

@@ -34,8 +34,8 @@ class Filter():
     def __init__(
             self, name, label, type=None, filter_func=None,
             filter_func_and=False, filter_func_list=False, choices=None,
-            related_model=None, technical=False, defaults=None,
-            empty_value=True):
+            related_model=None, related_model_api=None,
+            technical=False, defaults=None, empty_value=True):
         self.name = name
         self.label = label
         self.type = type
@@ -44,6 +44,7 @@ class Filter():
         self.filter_func_list = filter_func_list
         self.choices = choices
         self.related_model = related_model
+        self.related_model_api = related_model_api
         self.technical = technical
         self.defaults = defaults or []
         self.empty_value = empty_value
@@ -62,6 +63,7 @@ class Filter():
                 dict(label=_(v), value=k) for k, v in self.choices]
         if self.related_model:
             res['related_model'] = str(self.related_model.__name__)
+            res['api'] = self.related_model_api
         return res
 
     def _parse_value(self, value):
@@ -99,8 +101,8 @@ class ModelFilter(Filter):
     def __init__(
             self, model, name, label=None, type=None,
             filter_func=None, filter_func_and=False, filter_func_list=False,
-            choices=None, related_model=None, technical=False, defaults=None,
-            empty_value=None):
+            choices=None, related_model=None, related_model_api=None,
+            technical=False, defaults=None, empty_value=None):
         self.model = model
         self.field = model._meta.get_field(name)
         if empty_value is None:
@@ -113,6 +115,11 @@ class ModelFilter(Filter):
             related_model or (
                 self.field.remote_field and
                 self.field.remote_field.model),
+            related_model_api or (
+                self.field.remote_field and
+                self.field.remote_field.model and
+                hasattr(self.field.remote_field.model, 'api') and
+                self.field.remote_field.model.api),
             technical=technical, defaults=defaults, empty_value=empty_value)
 
     @property

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/pfx/pfxcore/views/rest_views.py

@@ -143,8 +143,8 @@ class ModelMixin():
     def _process_fields(cls, fields):
         if not fields:
             return {
-                f.name: ViewField.from_model_field(f.name, f)
-                for f in cls.model._meta.fields}
+                _f.name: ViewField.from_model_field(_f.name, _f)
+                for _f in cls.model._meta.fields}
 
         def _field(e):
             if isinstance(e, ViewField):
@@ -178,8 +178,8 @@ class ModelMixin():
         return cache.get_or_set(
             class_key(cls, 'fields', 'select_related'),
             lambda: set([
-                f for field in cls.get_fields().values()
-                for f in field.select_related]),
+                _f for field in cls.get_fields().values()
+                for _f in field.select_related]),
             None)
 
     @classmethod
@@ -188,8 +188,8 @@ class ModelMixin():
         return cache.get_or_set(
             class_key(cls, 'fields', 'prefetch_related'),
             lambda: set([
-                f for field in cls.get_fields().values()
-                for f in field.prefetch_related]),
+                _f for field in cls.get_fields().values()
+                for _f in field.prefetch_related]),
             None)
 
     @property
@@ -286,8 +286,8 @@ class ModelResponseMixin(ModelMixin):
         :rtype: :class:`JsonResponse`
         """
         return JsonResponse(self.serialize_object(o, **{
-            f.alias: f.to_json(o, self.format_date)
-            for f in self.get_fields().values()}, meta=meta))
+            _f.alias: _f.to_json(o, self.format_date)
+            for _f in self.get_fields().values()}, meta=meta))
 
     def validate(self, obj, created=False, **kwargs):
         """Validate an object instance.
@@ -434,8 +434,8 @@ class BodyMixin:
         """
         if fields is None:
             fields = [
-                f.name for f in model._meta.get_fields()
-                if not isinstance(f, AutoFieldMixin)]
+                _f.name for _f in model._meta.get_fields()
+                if not isinstance(_f, AutoFieldMixin)]
         obj = model(**{
             k: v for k, v in self.deserialize_body().items() if k in fields})
         if validate:
@@ -531,6 +531,15 @@ class ListRestViewMixin(ModelResponseMixin):
                     self.list_fields or self.fields)), None))
         return self._list_fields
 
+    def get_list_meta_filters(self):
+        """Return the filters metadata for lists.
+
+        :returns: The filters metadata generator
+        :rtype: :class:`generator`
+        """
+        for _f in self.filters:
+            yield _f.meta
+
     def search_filter(self, search):  # pragma: no cover
         """Return the django filters for the default text search.
 
@@ -577,7 +586,7 @@ class ListRestViewMixin(ModelResponseMixin):
         if get_bool(self.request.GET, 'filters', default_all):
             meta['filters'] = cache.get_or_set(
                 class_key(self.__class__, 'meta', 'filters'),
-                lambda: [f.meta for f in self.filters],
+                lambda: [_f.meta for _f in self.filters],
                 None)
         if get_bool(self.request.GET, 'orders', default_all):
             meta['orders'] = cache.get_or_set(
@@ -681,8 +690,8 @@ class ListRestViewMixin(ModelResponseMixin):
         return cache.get_or_set(
             class_key(self.__class__, 'list_fields', 'select_related'),
             lambda: set([
-                f for field in self.get_list_fields().values()
-                for f in field.select_related]),
+                _f for field in self.get_list_fields().values()
+                for _f in field.select_related]),
             None)
 
     def get_list_fields_prefetch_related(self):
@@ -690,8 +699,8 @@ class ListRestViewMixin(ModelResponseMixin):
         return cache.get_or_set(
             class_key(self.__class__, 'list_fields', 'prefetch_related'),
             lambda: set([
-                f for field in self.get_list_fields().values()
-                for f in field.prefetch_related]),
+                _f for field in self.get_list_fields().values()
+                for _f in field.prefetch_related]),
             None)
 
     def get_list_result(self, qs):
@@ -708,8 +717,8 @@ class ListRestViewMixin(ModelResponseMixin):
             *self.get_list_fields_prefetch_related())
         for o in qs:
             yield self.serialize_object(o, **{
-                f.alias: f.to_json(o, self.format_date)
-                for f in self.get_list_fields().values()})
+                _f.alias: _f.to_json(o, self.format_date)
+                for _f in self.get_list_fields().values()})
 
     def get_short_list_result(self, qs):
         """Get a generator to serialize each result in a queryset.
@@ -1124,11 +1133,41 @@ class MediaRestViewMixin(ModelMixin):
         ---
         get:
             summary: Get upload URL
-            description: Get upload URL for a file field.
+            description: |
+                Get upload URL for a `MediaField` field.
+
+                You can upload a file ont the received URL. When the upload
+                query is done, you have to confirm the process with an
+                update request (`PUT`) on {model}. The body of this request
+                must contain the name of the `MediaField` with the contents
+                of the `file` value in the response of this request.
+
+                1. `GET /<int:pk>/<str:field>/upload-url/<str:filename>`
+                    → `data`
+                2. `PUT data.url aFile Content-Type: aFile.type`
+                3. `PUT /<int:pk> {{field: data.file}}`
             parameters extras:
-                pk: the {model} pk
-                field: the {model} field name
-                filename: the desired filename
+                pk: The {model} pk.
+                field: The {model} field name. Must be the name of
+                    a `MediaField` field.
+                filename: The desired filename.
+            responses:
+                200:
+                    description: The upload URL
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    url:
+                                        type: string
+                                        format: uri
+                                    file:
+                                        type: object
+                                        properties:
+                                            name:
+                                                type: string
+                                            key:
+                                                type: string
         """
         obj = self.get_object(pk=pk)
         try:
@@ -1158,6 +1197,18 @@ class MediaRestViewMixin(ModelMixin):
             parameters extras:
                 pk: the {model} pk
                 field: the {model} field name
+            responses:
+                200:
+                    description: The file URL, if `redirect` is `false`.
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    url:
+                                        type: string
+                                        format: uri
+                302:
+                    description: The redirect, if `redirect` is `true`.
         """
         obj = self.get_object(pk=pk)
         try:

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/tests/models.py

@@ -109,6 +109,7 @@ class UserAuthorQuerySet(UserFilteredQuerySetMixin, models.QuerySet):
 
 class Author(CacheableMixin, JSONReprMixin, models.Model):
     CACHED_PROPERTIES = ['books_count']
+    api = '/authors'
 
     first_name = models.CharField(_("First Name"), max_length=30)
     last_name = models.CharField(_("Last Name"), max_length=30)

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/tests/tests/basic_api_errors.py

@@ -59,7 +59,8 @@ class BasicAPIErrorTest(TestAssertMixin, TestCase):
                 "new_password": "Wrong stuffs",
                 }''')
         self.assertRC(response, 422)
-        self.assertJE(
-            response, 'message',
+        self.assertIn(self.get_val(response, 'message'), [
+            "JSON Malformed Illegal trailing comma before end "
+            "of object: line 3 column 47 (char 96)",  # python >= 3.13
             "JSON Malformed Expecting property name enclosed in "
-            "double quotes: line 4 column 17 (char 114)")
+            "double quotes: line 4 column 17 (char 114)"])  # python <= 3.12

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/tests/tests/basic_api_test.py

@@ -224,6 +224,7 @@ class BasicAPITest(TestAssertMixin, TestCase):
                 "label": "Types",
                 "name": "types",
                 "related_model": "BookType",
+                "api": "/book-types",
                 "technical": False,
                 "type": "ModelObject"
             }
@@ -286,6 +287,18 @@ class BasicAPITest(TestAssertMixin, TestCase):
 
         response = self.client.get('/api/books/meta/list')
         self.assertRC(response, 200)
+
+        self.assertJE(response, 'filters.@0.items.@0', {
+            "empty_value": False,
+            "is_group": False,
+            "label": "Author",
+            "name": "author",
+            "related_model": "Author",
+            "api": "/authors",
+            "technical": False,
+            "type": "ModelObject"
+        })
+
         self.assertJIn(response, 'orders', 'pk')
         self.assertJIn(response, 'orders', 'name')
         self.assertJIn(response, 'orders', 'author')

{django_pfx-1.4.dev52 → django_pfx-1.4.dev56}/tests/views.py

@@ -64,7 +64,7 @@ class AuthorRestView(AuthorRestViewMixin, SlugDetailRestViewMixin, RestView):
             Filter(
                 'heroic_fantasy', _("Heroic Fantasy"),
                 FieldType.BooleanField, heroic_fantasy_filter),
-            ModelFilter(Author, 'types')
+            ModelFilter(Author, 'types', related_model_api='/book-types')
         ]),
         FilterGroup('custom', _("Custom"), [
             ModelFilter(