Redo admin model viewsets with inner classes

Author: davegaeddert

bolt-admin/bolt/admin/__init__.py

@@ -1,5 +1,16 @@
-from .views.base import AdminListView, AdminPageView
-from .views.models import AdminModelViewset
+from .views.base import (
+    AdminDeleteView,
+    AdminDetailView,
+    AdminListView,
+    AdminPageView,
+    AdminUpdateView,
+)
+from .views.models import (
+    AdminModelDetailView,
+    AdminModelListView,
+    AdminModelUpdateView,
+    AdminModelViewset,
+)
 from .views.registry import (
     register_dashboard,
     register_view,
@@ -9,7 +20,13 @@
 __all__ = [
     "AdminPageView",
     "AdminListView",
+    "AdminDetailView",
+    "AdminUpdateView",
+    "AdminDeleteView",
     "AdminModelViewset",
+    "AdminModelListView",
+    "AdminModelDetailView",
+    "AdminModelUpdateView",
     "register_viewset",
     "register_view",
     "register_dashboard",

bolt-admin/bolt/admin/assets/admin/admin.js

@@ -11,4 +11,8 @@ jQuery(function($) {
             }
         });
     });
+
+    $("[data-autosubmit]").on("change", function(e) {
+        $(this).closest("form").submit();
+    });
 });

bolt-admin/bolt/admin/templates/admin/base.html

@@ -29,7 +29,7 @@
             <div class="mt-4">
                 {% for view in admin_registry.get_nav_views() %}
                 <a class="flex items-center px-2 py-2 -mx-2 text-sm rounded hover:text-stone-300 text-stone-400 hover:bg-white/5" href="{{ view.get_absolute_url() }}">
-                    {{ view.title }}
+                    {{ view.get_title() }}
                 </a>
                 {% endfor %}
             </div>
@@ -39,7 +39,7 @@
                 <div class="text-xs tracking-wide text-gray-500">Dashboards</div>
                 {% for view in admin_registry.registered_dashboards %}
                 <a class="flex items-center px-2 py-2 -mx-2 text-sm rounded hover:text-stone-300 text-stone-400 hover:bg-white/5" href="{{ view.get_absolute_url() }}">
-                    {{ view.title }}
+                    {{ view.get_title() }}
                 </a>
                 {% endfor %}
             </div>
@@ -75,7 +75,7 @@
                 <a class="text-stone-500" href="{{ url ('admin:index') }}">Admin</a>
                 {% for parent in parent_view_classes %}
                 <span class="text-stone-400">/</span>
-                <a class="text-stone-500" href="{{ parent.get_absolute_url() }}">{{ parent.title }}</a>
+                <a class="text-stone-500" href="{{ parent.get_absolute_url() }}">{{ parent.get_title() }}</a>
                 {% endfor %}
                 <span class="text-stone-400">/</span>
                 <a class="text-stone-600" href="{{ request.path }}">{{ title }}</a>

bolt-admin/bolt/admin/templates/admin/index.html

@@ -8,7 +8,7 @@ <h2>dashboards</h2>
     <div class="grid grid-cols-4 gap-6 mt-4">
         {% for view in dashboards %}
         <a class="p-4 border rounded" href="{{ view.get_absolute_url() }}">
-            {{ view.title }}
+            {{ view.get_title() }}
         </a>
         {% endfor %}
     </div>

bolt-admin/bolt/admin/templates/admin/list.html

@@ -13,7 +13,18 @@
         <div class="font-semibold">
             {{ title }}
         </div>
-        <div>
+        <div class="flex space-x-5">
+            {% if list_filters %}
+            <form method="GET" class="inline-flex">
+                <select data-autosubmit name="filter" class="text-sm border-gray-200 rounded-md">
+                    <option value="">Filters</option>
+                    {% for filter in list_filters %}
+                    <option {% if filter == list_filter %}selected{% endif %}>{{ filter }}</option>
+                    {% endfor %}
+                </select>
+            </form>
+            {% endif %}
+
             {% if list_actions %}
             <form method="POST" data-actions-form>
                 {{ csrf_input }}

bolt-admin/bolt/admin/views/base.py

@@ -42,7 +42,7 @@ class BaseAdminView(AuthViewMixin, TemplateView):
 
     def get_context(self):
         context = super().get_context()
-        context["title"] = self.title
+        context["title"] = self.get_title()
         context["slug"] = self.get_slug()
         context["description"] = self.get_description()
         context["links"] = self.get_links()
@@ -53,9 +53,13 @@ def get_context(self):
     def view_name(cls) -> str:
         raise NotImplementedError
 
+    @classmethod
+    def get_title(cls) -> str:
+        return cls.title
+
     @classmethod
     def get_slug(cls) -> str:
-        return cls.slug or slugify(cls.title)
+        return cls.slug or slugify(cls.get_title())
 
     @classmethod
     def get_description(cls) -> str:
@@ -125,17 +129,27 @@ class AdminListView(AdminPageView):
     template_name = "admin/list.html"
     list_fields: list
     list_actions: dict[str] = {}
+    list_filters: list[str] = []
     page_size = 100
     show_search = False
 
     def get_context(self):
         context = super().get_context()
-        context["paginator"] = Paginator(self.get_objects(), self.page_size)
+
+        list_filter = self.request.GET.get("filter", "")
+
+        objects = self.get_objects()
+        objects = self.filter_objects(list_filter, objects)
+
+        context["paginator"] = Paginator(objects, self.page_size)
         context["page"] = context["paginator"].get_page(self.request.GET.get("page", 1))
         context["objects"] = context["page"]  # alias
         context["list_fields"] = self.list_fields
         context["list_actions"] = self.list_actions
 
+        context["list_filters"] = self.list_filters
+        context["list_filter"] = list_filter
+
         # Implement search yourself in get_objects
         context["search_query"] = self.request.GET.get("search", "")
         context["show_search"] = self.show_search
@@ -162,6 +176,10 @@ def post(self) -> HttpResponse:
     def get_objects(self) -> list:
         return []
 
+    def filter_objects(self, filter_name: str, objects: list):
+        """Implement custom object filters here by looking at filter name"""
+        return objects
+
     def get_object_field(self, obj, field: str):
         # Try basic dict lookup first
         if field in obj:
@@ -200,6 +218,7 @@ def get_context(self):
         return context
 
     def get_template_names(self) -> list[str]:
+        # TODO move these to model views
         if not self.template_name and isinstance(self.object, models.Model):
             object_meta = self.object._meta
             return [

bolt-admin/bolt/admin/views/models.py

@@ -43,6 +43,14 @@ class AdminModelListView(AdminListView):
     list_order = []
     search_fields: list = ["pk"]
 
+    @classmethod
+    def get_title(cls) -> str:
+        return cls.model._meta.verbose_name_plural.capitalize()
+
+    @classmethod
+    def get_slug(cls) -> str:
+        return cls.model._meta.model_name
+
     def get_context(self):
         context = super().get_context()
 
@@ -92,122 +100,90 @@ def get_object_field(self, object, field: str):
         return get_model_field(object, field)
 
 
-class AdminModelViewset:
+class AdminModelDetailView(AdminDetailView):
     model: "models.Model"
-    list_description = ""
-    list_fields: list = ["pk"]
-    list_order = []
-    detail_fields: list = []
-    search_fields = ["pk"]
-
-    form_class = None  # TODO type annotation
-
-    list_cards = []
-    form_cards = []
+    fields: list = []
 
     @classmethod
-    def get_list_view(cls) -> AdminModelListView:
-        class V(AdminModelListView):
-            model = cls.model
-            title = cls.model._meta.verbose_name_plural.capitalize()
-            description = cls.list_description
-            slug = cls.model._meta.model_name
-            list_fields = cls.list_fields
-            list_order = cls.list_order
-            cards = cls.list_cards
-            search_fields = cls.search_fields
+    def get_title(cls) -> str:
+        return cls.model._meta.verbose_name.capitalize()
 
-            def get_update_url(self, object):
-                update_view = cls.get_update_view()
+    @classmethod
+    def get_slug(cls) -> str:
+        return f"{cls.model._meta.model_name}_detail"
 
-                if not update_view:
-                    return None
+    @classmethod
+    def get_path(cls) -> str:
+        return f"{cls.model._meta.model_name}/<int:pk>/"
 
-                # TODO a way to do this without explicit namespace?
-                return reverse_lazy(
-                    URL_NAMESPACE + ":" + update_view.view_name(),
-                    kwargs={"pk": object.pk},
-                )
+    def get_context(self):
+        context = super().get_context()
+        context["fields"] = self.fields or ["pk"] + [
+            f.name for f in self.object._meta.get_fields() if not f.remote_field
+        ]
+        return context
 
-            def get_detail_url(self, object):
-                detail_view = cls.get_detail_view()
+    def get_object_field(self, object, field: str):
+        return get_model_field(object, field)
 
-                if not detail_view:
-                    return None
+    def get_object(self):
+        return self.model.objects.get(pk=self.url_kwargs["pk"])
 
-                return reverse_lazy(
-                    URL_NAMESPACE + ":" + detail_view.view_name(),
-                    kwargs={"pk": object.pk},
-                )
+    def get_template_names(self) -> list[str]:
+        return super().get_template_names() + [
+            "admin/detail.html",
+        ]
 
-            def get_initial_queryset(self):
-                return cls.get_list_queryset(self)
 
-        return V
+class AdminModelUpdateView(AdminUpdateView):
+    model: "models.Model"
+    form_class = None  # TODO type annotation
+    success_url = "."  # Redirect back to the same update page by default
 
     @classmethod
-    def get_update_view(cls) -> AdminUpdateView | None:
-        if not cls.form_class:
-            return None
+    def get_title(cls) -> str:
+        return f"Update {cls.model._meta.verbose_name}"
 
-        class V(AdminUpdateView):
-            title = f"Update {cls.model._meta.verbose_name}"
-            slug = f"{cls.model._meta.model_name}_update"
-            form_class = cls.form_class
-            path = f"{cls.model._meta.model_name}/<int:pk>/update/"
-            cards = cls.form_cards
-            success_url = "."  # Redirect back to the same update page by default
-            parent_view_class = cls.get_list_view()
+    @classmethod
+    def get_slug(cls) -> str:
+        return f"{cls.model._meta.model_name}_update"
 
-            def get_object(self):
-                return cls.model.objects.get(pk=self.url_kwargs["pk"])
+    @classmethod
+    def get_path(cls) -> str:
+        return f"{cls.model._meta.model_name}/<int:pk>/update/"
 
-        return V
+    def get_object(self):
+        return self.model.objects.get(pk=self.url_kwargs["pk"])
 
-    @classmethod
-    def get_detail_view(cls) -> AdminDetailView | None:
-        class V(AdminDetailView):
-            title = cls.model._meta.verbose_name.capitalize()
-            slug = f"{cls.model._meta.model_name}_detail"
-            path = f"{cls.model._meta.model_name}/<int:pk>/"
-            parent_view_class = cls.get_list_view()
-            fields = cls.detail_fields
-
-            def get_context(self):
-                context = super().get_context()
-                context["fields"] = self.fields or ["pk"] + [
-                    f.name for f in self.object._meta.get_fields() if not f.remote_field
-                ]
-                return context
-
-            def get_object(self):
-                return cls.model.objects.get(pk=self.url_kwargs["pk"])
-
-            def get_template_names(self) -> list[str]:
-                return super().get_template_names() + [
-                    "admin/detail.html",
-                ]
-
-            def get_object_field(self, object, field: str):
-                return get_model_field(object, field)
-
-        return V
 
+class AdminModelViewset:
     @classmethod
     def get_views(cls) -> list["View"]:
         views = []
 
-        if list_view := cls.get_list_view():
-            views.append(list_view)
+        if hasattr(cls, "ListView") and hasattr(cls, "DetailView"):
+            cls.ListView.get_detail_url = lambda self, obj: reverse_lazy(
+                f"{URL_NAMESPACE}:{cls.DetailView.view_name()}",
+                kwargs={"pk": obj.pk},
+            )
 
-        if update_view := cls.get_update_view():
-            views.append(update_view)
+            cls.DetailView.parent_view_class = cls.ListView
 
-        if detail_view := cls.get_detail_view():
-            views.append(detail_view)
+        if hasattr(cls, "ListView") and hasattr(cls, "UpdateView"):
+            cls.ListView.get_update_url = lambda self, obj: reverse_lazy(
+                f"{URL_NAMESPACE}:{cls.UpdateView.view_name()}",
+                kwargs={"pk": obj.pk},
+            )
 
-        return views
+            cls.UpdateView.parent_view_class = cls.ListView
 
-    def get_list_queryset(self):
-        # Can't use super() with this the way it works now
-        return self.model.objects.all()
+        if hasattr(cls, "ListView"):
+            views.append(cls.ListView)
+
+        if hasattr(cls, "DetailView"):
+            views.append(cls.DetailView)
+
+        if hasattr(cls, "UpdateView"):
+            views.append(cls.UpdateView)
+
+        return views

bolt-admin/bolt/admin/views/registry.py

@@ -48,7 +48,7 @@ def get_nav_views(self):
 
         sorted_views = sorted(
             [view for view in self.registered_views if view.should_show_in_nav()],
-            key=lambda v: v.title,
+            key=lambda v: v.get_title(),
         )
 
         return sorted_views