django-pfx 1.4.dev156__tar.gz → 1.4.dev160__tar.gz

{django_pfx-1.4.dev156 → django_pfx-1.4.dev160}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev156
+Version: 1.4.dev160
 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.dev156 → django_pfx-1.4.dev160}/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-09-16 10:41+0200\n"
+"POT-Creation-Date: 2025-10-22 16:49+0200\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -286,23 +286,23 @@ msgstr "Le paramètre object est requis pour move={move}."
 msgid "object {pk} does not exists in this move context."
 msgstr "object {pk} n'existe pas dans ce contexte de déplacement."
 
-#: views/rest_views.py:220 views/rest_views.py:381
+#: views/rest_views.py:221 views/rest_views.py:387
 #, python-brace-format
 msgid "{obj} cannot be deleted because it is referenced by other objects."
 msgstr ""
 "{obj} ne peut pas être supprimé car il est référencé par d’autres objets."
 
-#: views/rest_views.py:345
+#: views/rest_views.py:351
 #, python-brace-format
 msgid "{model} {obj} created."
 msgstr "{model} {obj} créé."
 
-#: views/rest_views.py:346
+#: views/rest_views.py:352
 #, python-brace-format
 msgid "{model} {obj} updated."
 msgstr "{model} {obj} modifié."
 
-#: views/rest_views.py:1224
+#: views/rest_views.py:1261
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."

{django_pfx-1.4.dev156 → django_pfx-1.4.dev160}/pfx/pfxcore/views/rest_views.py

@@ -6,9 +6,10 @@ from json import JSONDecodeError
 from django.conf import settings
 from django.core.cache import cache
 from django.core.exceptions import FieldError, ValidationError
-from django.db import IntegrityError, transaction
-from django.db.models import ForeignKey, ManyToOneRel, Model, Q
+from django.db import IntegrityError, connection, transaction
+from django.db.models import F, ForeignKey, ManyToOneRel, Model, Q, Window
 from django.db.models.fields import AutoFieldMixin
+from django.db.models.functions import Lag, Lead, RowNumber
 from django.urls import path
 from django.utils.translation import gettext_lazy as _
 from django.views import View
@@ -280,6 +281,9 @@ class ModelResponseMixin(ModelMixin):
         vals.update(fields)
         return vals
 
+    def get_navigation_meta(self, obj):
+        raise APIError("navigation data are only available on list view.")
+
     def response(self, o, **meta):
         """Build a :class:`JsonResponse` from an object instance.
 
@@ -288,6 +292,8 @@ class ModelResponseMixin(ModelMixin):
         :returns: The JSON response
         :rtype: :class:`JsonResponse`
         """
+        if get_bool(self.request.GET, 'navigation'):
+            meta.update(self.get_navigation_meta(o))
         return JsonResponse(self.serialize_object(o, **{
             _f.alias: _f.to_json(o, self)
             for _f in self.get_fields().values()}, meta=meta))
@@ -742,6 +748,14 @@ class ListRestViewMixin(ModelResponseMixin):
         order = self.request.GET.get('order')
         return order and [apply(o) for o in order.split(',')] or order
 
+    def get_order(self):
+        order = (
+            self.get_query_order() or self.default_order or
+            self.model._meta.ordering)
+        if 'pk' not in order:
+            order.append('pk')
+        return order
+
     def apply_view_order(self, qs):
         """Apply view order on queryset.
 
@@ -750,13 +764,10 @@ class ListRestViewMixin(ModelResponseMixin):
         :returns: The ordered queryset
         :rtype: :class:`django.db.models.QuerySet`
         """
-        order = self.get_query_order()
-        if order:
-            try:
-                return qs.order_by(*order)
-            except FieldError as e:
-                raise APIError(e.args[0])
-        return qs.order_by(*(self.default_order or self.model._meta.ordering))
+        try:
+            return qs.order_by(*self.get_order())
+        except FieldError as e:
+            raise APIError(e.args[0])
 
     def get_list_queryset(self, select_related=None, prefetch_related=None):
         """Get list queryset.
@@ -937,6 +948,32 @@ class ListRestViewMixin(ModelResponseMixin):
 
         return self._get_list(*args, **kwargs)
 
+    def get_navigation_meta(self, obj):
+        qs = self.get_list_queryset()
+        order = qs.query.order_by
+        qs_window = qs.annotate(
+            prev_id=Window(Lag('id'), order_by=order),
+            next_id=Window(Lead('id'), order_by=order),
+            index=Window(RowNumber(), order_by=order)).values(
+                'prev_id', 'next_id', 'index', obj_id=F('id'))
+        compiler = qs_window.query.get_compiler(connection=connection)
+        inner_sql, params = compiler.as_sql()
+        sql = f"""
+            WITH annotated AS ({inner_sql})
+            SELECT prev_id, next_id, index
+            FROM annotated
+            WHERE obj_id = %s;
+        """
+
+        with connection.cursor() as cursor:
+            cursor.execute(sql, list(params) + [obj.pk])
+            prev_id, next_id, index = cursor.fetchone() or (None, None)
+            return {
+                'previous_pk': prev_id or qs.last().pk,
+                'next_pk': next_id or qs.first().pk,
+                'index': index,
+                'count': qs.count()}
+
     @classmethod
     def generate_schemas(cls):
         """Generate schemas for the class.

{django_pfx-1.4.dev156 → django_pfx-1.4.dev160}/tests/tests/basic_api_test.py

@@ -632,6 +632,31 @@ class BasicAPITest(TestAssertMixin, TestCase):
         self.assertJE(response, 'gender.value', 'male')
         self.assertJE(response, 'gender.label', 'Male')
 
+    def test_get_detail_navigation_meta(self):
+        response = self.client.get(
+            f'/api/authors/{self.author3.pk}?navigation=1&order=last_name')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.previous_pk', self.author1.pk)
+        self.assertJE(response, 'meta.next_pk', self.author2.pk)
+        self.assertJE(response, 'meta.index', 1)
+        self.assertJE(response, 'meta.count', 4)
+
+        response = self.client.get(
+            f'/api/authors/{self.author2.pk}?navigation=1&order=last_name')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.previous_pk', self.author3.pk)
+        self.assertJE(response, 'meta.next_pk', self.author4.pk)
+        self.assertJE(response, 'meta.index', 2)
+        self.assertJE(response, 'meta.count', 4)
+
+        response = self.client.get(
+            f'/api/authors/{self.author2.pk}?navigation=1&order=-last_name')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'meta.previous_pk', self.author4.pk)
+        self.assertJE(response, 'meta.next_pk', self.author3.pk)
+        self.assertJE(response, 'meta.index', 3)
+        self.assertJE(response, 'meta.count', 4)
+
     def test_get_date_format(self):
         response = self.client.get(f'/api/books/{self.author1_book1.pk}')
         self.assertRC(response, 200)