grouped admin actions

Author: KommuSoft

.github/workflows/django-adminlink-ci.yml

@@ -104,7 +104,7 @@ jobs:
         python -m setuptools_scm
         python setup.py sdist bdist_wheel
 
-  test-publish:
+  publish:
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
     needs: [black, build, test, no-makemigrations, no-makemessages]
@@ -121,21 +121,3 @@ jobs:
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         verbose: true
-
-  publish:
-    runs-on: ubuntu-latest
-    needs: [test-publish]
-    if: startsWith(github.ref, 'refs/tags/')
-    steps:
-    - name: checkout code
-      uses: actions/checkout@v2.3.1
-    - name: Set up Python
-      uses: actions/setup-python@v4
-    - run: |
-        pip install 'setuptools>=38.6.0,<69.0' twine>=1.11.0 wheel>=0.31.0 setuptools_scm>=6.2
-        python -m setuptools_scm
-        python setup.py sdist bdist_wheel
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        verbose: true

README.md

@@ -82,4 +82,35 @@ from django_adminlink.admin import SingleItemActionMixin
 @admin.register(Movie)
 class MovieAdmin(SingleItemActionMixin, admin.ModelAdmin):
     action_buttons = ['delete_selected']
-```
+```
+
+## Grouping actions
+
+The list of actions is "flat". We can add item groups, just like in other Django `ChoiceField`s. For this we introduced the `GroupedActionAdminMixin`.
+
+This mixin looks at the actions. We also defined a `@grouped_action` decorator, which does approximately the same as the `@admin.action` decorator, except with an extra parameter `action_group=…`.
+
+We can register actions like:
+
+```python3
+from django.contrib import admin
+from django_adminlink.admin import GroupedActionAdminMixin, grouped_action
+
+@admin.register(Movie)
+class MovieAdmin(GroupedActionAdminMixin, admin.ModelAdmin):
+    action_buttons = ['star', 'unstar', 'clear_comments']
+    
+    @grouped_action(description='star item', action_group='stars')
+    def star(self, request, queryset):
+      # …
+    
+    @grouped_action(description='unstar item', action_group='stars')
+    def unstar(self, request, queryset):
+      # …
+    
+    @grouped_action(description='clear comments', action_group='comments')
+    def clear_comments(self, request, queryset):
+      # …
+```
+
+The order of the groups is determined by the order of the indivual actions: the first action for that group for each group determines how the groups are listed.

django_adminlink/admin.py

@@ -1,4 +1,7 @@
+from collections import defaultdict
+
 from django.contrib import admin
+from django.contrib.admin.utils import model_format_dict
 from django.core.exceptions import FieldDoesNotExist
 from django.db import models
 from django.forms import Media
@@ -127,3 +130,36 @@ def media(self):
 
 class SingleItemActionAdmin(SingleItemActionMixin, admin.ModelAdmin):
     pass
+
+
+def grouped_action(
+    function=None, *, permissions=None, description=None, action_group=None
+):
+    if function is None:
+        base_decorator = admin.action(permissions=permissions, description=description)
+
+        def decorator(func):
+            func = base_decorator(func)
+            func.action_group = action_group
+            return func
+
+        return decorator
+    else:
+        function = admin.action(function)
+        function.action_group = action_group
+        return function
+
+
+class GroupedActionAdminMixin:
+    def get_action_choices(self, request, default_choices=models.BLANK_CHOICE_DASH):
+        grouped_items = defaultdict(list)
+        grouped_items[None].extend(default_choices)
+        for func, name, description in self.get_actions(request).values():
+            group = getattr(func, "action_group", None)
+            choice = (name, description % model_format_dict(self.opts))
+            grouped_items[group].append(choice)
+        return [(k, v) for k, v in grouped_items.items()]
+
+
+class GroupedActionAdmin(SingleItemActionMixin, admin.ModelAdmin):
+    pass