plain.admin 0.31.3__tar.gz → 0.31.4__tar.gz

{plain_admin-0.31.3 → plain_admin-0.31.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.admin
-Version: 0.31.3
+Version: 0.31.4
 Summary: Admin dashboard and tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -165,6 +165,37 @@ TODO
 
 TODO
 
+## List `displays`
+
+On admin list views, you can define different `displays` to build predefined views of your data. The display choices will be shown in the UI, and you can use the current `self.display` in your view.
+
+```python
+# app/users/admin.py
+from plain.admin.views import AdminModelListView, register_viewset
+
+from .models import User
+
+
+@register_viewset
+class UserAdmin(AdminViewset):
+    class ListView(AdminModelListView):
+        model = User
+        fields = [
+            "id",
+            "email",
+            "created_at__date",
+        ]
+        displays = ["Users without email"]
+
+        def get_objects(self):
+            objects = super().get_objects()
+
+            if self.display == "Users without email":
+                objects = objects.filter(email="")
+
+            return objects
+```
+
 ## Toolbar
 
 TODO

{plain_admin-0.31.3 → plain_admin-0.31.4}/plain/admin/README.md

@@ -150,6 +150,37 @@ TODO
 
 TODO
 
+## List `displays`
+
+On admin list views, you can define different `displays` to build predefined views of your data. The display choices will be shown in the UI, and you can use the current `self.display` in your view.
+
+```python
+# app/users/admin.py
+from plain.admin.views import AdminModelListView, register_viewset
+
+from .models import User
+
+
+@register_viewset
+class UserAdmin(AdminViewset):
+    class ListView(AdminModelListView):
+        model = User
+        fields = [
+            "id",
+            "email",
+            "created_at__date",
+        ]
+        displays = ["Users without email"]
+
+        def get_objects(self):
+            objects = super().get_objects()
+
+            if self.display == "Users without email":
+                objects = objects.filter(email="")
+
+            return objects
+```
+
 ## Toolbar
 
 TODO

{plain_admin-0.31.3 → plain_admin-0.31.4}/plain/admin/templates/admin/list.html

@@ -41,7 +41,7 @@
         <form method="GET" class="inline-flex space-x-5">
             {% if displays %}
             <select data-autosubmit name="display" class="text-sm">
-                <option value="">Displays</option>
+                <option value="">Choose a display</option>
                 {% for display in displays %}
                 <option {% if display == current_display %}selected{% endif %}>{{ display }}</option>
                 {% endfor %}
@@ -89,9 +89,9 @@
                         {% else %}
                         <a
                             data-merge-params
-                            class="font-mono text-xs font-normal"
+                            class="font-mono text-xs font-normal flex space-x-1 items-center"
                             href="?page=1&order_by={{ '-' if not order_by_direction else '' }}{{ field }}">
-                            {{ field }}
+                            <span>{{ field }}</span>
                             {% if field == order_by_field %}
                             {% if order_by_direction == "-" %}
                             <span class="text-xs">▲</span>

{plain_admin-0.31.3 → plain_admin-0.31.4}/plain/admin/views/models.py

@@ -1,6 +1,7 @@
 from typing import TYPE_CHECKING
 
 from plain import models
+from plain.exceptions import FieldError
 from plain.models import Manager, Q
 
 from .objects import (
@@ -92,8 +93,8 @@ class AdminModelListView(AdminListView):
 
     def get_objects(self):
         queryset = self.get_initial_queryset()
-        queryset = self.order_queryset(queryset)
         queryset = self.search_queryset(queryset)
+        queryset = self.order_queryset(queryset)
         return queryset
 
     def get_initial_queryset(self):
@@ -103,7 +104,24 @@ class AdminModelListView(AdminListView):
 
     def order_queryset(self, queryset):
         if order_by := self.request.query_params.get("order_by"):
-            queryset = queryset.order_by(order_by)
+            try:
+                queryset = queryset.order_by(order_by)
+            except FieldError:
+                # Fallback to sorting in Python if the field is not valid
+                # Note this can be an expensive operation!
+                if order_by.startswith("-"):
+                    order_by = order_by[1:]
+                    queryset = sorted(
+                        queryset,
+                        key=lambda obj: self.get_field_value(obj, order_by),
+                        reverse=True,
+                    )
+                else:
+                    queryset = sorted(
+                        queryset,
+                        key=lambda obj: self.get_field_value(obj, order_by),
+                        reverse=False,
+                    )
         elif self.queryset_order:
             queryset = queryset.order_by(*self.queryset_order)
 

{plain_admin-0.31.3 → plain_admin-0.31.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.admin"
-version = "0.31.3"
+version = "0.31.4"
 description = "Admin dashboard and tools for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"