django-pfx 1.4.dev54__tar.gz → 1.4.dev58__tar.gz

{django_pfx-1.4.dev54 → django_pfx-1.4.dev58}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.4.dev54
+Version: 1.4.dev58
 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.dev54 → django_pfx-1.4.dev58}/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-08-20 12:22+0200\n"
+"POT-Creation-Date: 2024-12-11 12:51+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:1093
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."
 
-#: views/rest_views.py:1169 views/rest_views.py:1209
+#: views/rest_views.py:1185 views/rest_views.py:1225
 msgid "Unexpected storage error"
 msgstr "Erreur de stockage inattendue"

{django_pfx-1.4.dev54 → django_pfx-1.4.dev58}/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.dev54 → django_pfx-1.4.dev58}/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):
@@ -87,7 +89,20 @@ class Filter():
             [self.filter_func(v) for v in values])
 
     def _get_values(self, params):
-        values = [self._parse_value(v) for v in params.getlist(self.name)]
+        values = []
+        if (self.type == FieldType.ModelObject and self.related_model and
+                hasattr(self.related_model.objects, 'default_search')):
+            q = None
+            for search in params.getlist(f'{self.name}*'):
+                crit = self.related_model.objects.default_search(search)
+                if q is None:
+                    q = crit
+                q |= crit
+            if q:
+                values.extend(self.related_model.objects.filter(
+                    q).values_list('pk', flat=True))
+        values.extend([
+            self._parse_value(v) for v in params.getlist(self.name)])
         return values or self.defaults
 
     def query(self, params):
@@ -99,8 +114,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 +128,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.dev54 → django_pfx-1.4.dev58}/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.
 
@@ -541,6 +550,8 @@ class ListRestViewMixin(ModelResponseMixin):
         :returns: The django filters
         :rtype: :class:`django.db.models.Q`
         """
+        if hasattr(self.model.objects, 'default_search'):
+            return self.model.objects.default_search(search)
         return Q()
 
     def orderable_fields(self, model, models=None):
@@ -577,7 +588,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(
@@ -620,9 +631,14 @@ class ListRestViewMixin(ModelResponseMixin):
         :returns: The filtered queryset
         :rtype: :class:`django.db.models.QuerySet`
         """
-        search = self.request.GET.get('search')
-        if search:
-            return qs.filter(self.search_filter(search))
+        q = None
+        for search in self.request.GET.getlist('search'):
+            crit = self.search_filter(search)
+            if q is None:
+                q = crit
+            q |= crit
+        if q:
+            return qs.filter(q)
         return qs
 
     def get_order_mapping(self):
@@ -681,8 +697,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 +706,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 +724,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.

{django_pfx-1.4.dev54 → django_pfx-1.4.dev58}/tests/models.py

@@ -1,6 +1,7 @@
 from django.contrib.auth.base_user import BaseUserManager
 from django.core.mail import send_mail
 from django.db import models
+from django.db.models import Q
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
 
@@ -96,6 +97,13 @@ class User(CacheableMixin, JSONReprMixin, OtpUserMixin, AbstractPFXBaseUser):
         send_mail(subject, message, from_email, [self.email], **kwargs)
 
 
+class AuthorQuerySet(models.QuerySet):
+    def default_search(self, search):
+        return (
+            Q(first_name__unaccent__icontains=search) |
+            Q(last_name__unaccent__icontains=search))
+
+
 class BadUserAuthorQuerySet(UserFilteredQuerySetMixin, models.QuerySet):
     pass
 
@@ -109,6 +117,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)
@@ -126,7 +135,7 @@ class Author(CacheableMixin, JSONReprMixin, models.Model):
         'tests.BookType', related_name='authors',
         verbose_name="Types")
 
-    objects = models.QuerySet.as_manager()
+    objects = AuthorQuerySet.as_manager()
     bad_user_objects = BadUserAuthorQuerySet.as_manager()
     user_objects = UserAuthorQuerySet.as_manager()
 

{django_pfx-1.4.dev54 → django_pfx-1.4.dev58}/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.dev54 → django_pfx-1.4.dev58}/tests/tests/basic_api_test.py

@@ -197,6 +197,12 @@ class BasicAPITest(TestAssertMixin, TestCase):
         self.assertJE(response, 'items.@0.gender.value', 'male')
         self.assertJE(response, 'items.@0.gender.label', 'Male')
 
+        response = self.client.get(
+            '/api/authors?search=isaac&search=tolkien&items=1&count=1')
+
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.count', 2)
+
     def test_meta_list(self):
         response = self.client.get('/api/authors/meta/list')
         self.assertRC(response, 200)
@@ -224,6 +230,7 @@ class BasicAPITest(TestAssertMixin, TestCase):
                 "label": "Types",
                 "name": "types",
                 "related_model": "BookType",
+                "api": "/book-types",
                 "technical": False,
                 "type": "ModelObject"
             }
@@ -286,6 +293,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')
@@ -470,6 +489,24 @@ class BasicAPITest(TestAssertMixin, TestCase):
             self.assertTrue(
                 item['type'] is None or item['type']['pk'] == book_type.pk)
 
+    def test_model_filter_foreign_key_text_search(self):
+        response = self.client.get(
+            '/api/books?author*=asimov&items=1&count=1')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.count', 3)
+
+        # Test multiple values
+        response = self.client.get(
+            '/api/books?author*=asimov&author*=tolkien&items=1&count=1')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.count', 7)
+
+        # Test empty search
+        response = self.client.get(
+            '/api/books?author*=&items=1&count=1')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.count', 7)
+
     def test_model_filter_char_choices(self):
         response = self.client.get('/api/authors?gender=male&items=1&count=1')
 

{django_pfx-1.4.dev54 → django_pfx-1.4.dev58}/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(
@@ -80,11 +80,6 @@ class AuthorRestView(AuthorRestViewMixin, SlugDetailRestViewMixin, RestView):
         ]),
     ]
 
-    def search_filter(self, search):
-        return (
-            Q(first_name__unaccent__icontains=search) |
-            Q(last_name__unaccent__icontains=search))
-
     @rest_api("/cache/<int:id>", method="get", groups=['cache'])
     def cache_get(self, id, *args, **kwargs):
         book = Author.cache_get(id)