Add label/description decorator

Reference:
crccheck#115

Author: Alexerson

django_object_actions/__init__.py

@@ -7,4 +7,5 @@
     BaseDjangoObjectActions,
     DjangoObjectActions,
     takes_instance_or_queryset,
+    action,
 )

django_object_actions/tests/test_utils.py

@@ -3,7 +3,12 @@
 from django.test import TestCase
 from example_project.polls.models import Poll
 
-from ..utils import BaseDjangoObjectActions, BaseActionView, takes_instance_or_queryset
+from ..utils import (
+    BaseDjangoObjectActions,
+    BaseActionView,
+    takes_instance_or_queryset,
+    action,
+)
 
 
 class BaseDjangoObjectActionsTest(TestCase):
@@ -122,3 +127,23 @@ def myfunc(foo, bar, queryset):
         queryset = myfunc(None, None, queryset=self.obj)
         # the resulting queryset only has one item and it's self.obj
         self.assertEqual(queryset.get(), self.obj)
+
+
+class DecoratorActionTest(TestCase):
+    def test_decorated(self):
+        # setup
+        @action(description="First action of this admin site.")
+        def action_1(modeladmin, request, queryset):
+            pass
+
+        @action(permissions=["do_action2"])
+        def action_2(modeladmin, request, queryset):
+            pass
+
+        @action(label="Third action")
+        def action_3(modeladmin, request, queryset):
+            pass
+
+        self.assertEqual(action_1.short_description, "First action of this admin site.")
+        self.assertEqual(action_2.allowed_permissions, ["do_action2"])
+        self.assertEqual(action_3.label, "Third action")

django_object_actions/utils.py

@@ -311,3 +311,44 @@ def decorated_function(self, request, queryset):
         return func(self, request, queryset)
 
     return decorated_function
+
+
+def action(function=None, *, permissions=None, description=None, label=None):
+    """
+    Conveniently add attributes to an action function::
+
+        @admin_action(
+            permissions=['publish'],
+            description='Mark selected stories as published',
+            label='Publish'
+        )
+        def make_published(self, request, queryset):
+            queryset.update(status='p')
+
+    This is equivalent to setting some attributes (with the original, longer
+    names) on the function directly::
+
+        def make_published(self, request, queryset):
+            queryset.update(status='p')
+        make_published.allowed_permissions = ['publish']
+        make_published.short_description = 'Mark selected stories as published'
+        make_published.label = 'Publish'
+
+    This is the django-object-actions equivalent of
+    https://docs.djangoproject.com
+    /en/dev/ref/contrib/admin/actions/#django.contrib.admin.action
+    """
+
+    def decorator(func):
+        if permissions is not None:
+            func.allowed_permissions = permissions
+        if description is not None:
+            func.short_description = description
+        if label is not None:
+            func.label = label
+        return func
+
+    if function is None:
+        return decorator
+    else:
+        return decorator(function)