django-no-queryset-admin-actions 1.2.0

Extension for the Django admin panel that makes it possible to add actions that do not require a queryset to run.

django-no-queryset-admin-actions

Extension for the Django admin panel that makes it possible to add actions that do not require a queryset to run.

Works with django-admin-action-forms.

• 🔌 Installation
• ✏️ Examples
  • No queryset actions
  • Optional queryset actions

🔌 Installation

1. Install using pip:

   $ pip3 install django-no-queryset-admin-actions
   

2. Add 'django_no_queryset_admin_actions' to your INSTALLED_APPS setting.

   INSTALLED_APPS = [
       ...
       'django_no_queryset_admin_actions',
   ]
   

✏️ Examples

No queryset actions

Let's say you have an action that fetches external orders from an API. You don't need a queryset to run this action, but Django requires it by default. By using the @no_queryset_action, you can bypass that, and create actions that can be run without selecting any objects.

from django.contrib.admin import ModelAdmin, register

from django_no_queryset_admin_actions import NoQuerySetAdminActionsMixin, no_queryset_action


@register(ExternalOrder)
class ExternalOrderAdmin(NoQuerySetAdminActionsMixin, ModelAdmin):

    @no_queryset_action(description="Fetch external orders")
    def fetch_external_orders(self, request): # <- No `queryset` parameter
        ...

    actions = [fetch_external_orders]

Optional queryset actions

Another use case is when you have an action that can be run on a specific queryset, but you also want to allow running it without selecting any objects.

This type of action could be used to e.g.:

• default to all, or a filtered subset of objects when no selection is made
• choose a random object if no specific item is selected

Leveraging the @optional_queryset_action decorator, you can create actions that run whether or not objects are selected.

Let's say, that ExternalOrder objects fetched in the previous example may sometimes need updating. In this example, if no objects are selected, queryset will be empty, and the action will default to updating all ExternalOrder objects.

from django.contrib.admin import ModelAdmin, register

from django_no_queryset_admin_actions import NoQuerySetAdminActionsMixin, optional_queryset_action


@register(ExternalOrder)
class ExternalOrderAdmin(NoQuerySetAdminActionsMixin, ModelAdmin):

    @optional_queryset_action(description="Update external orders")
    def update_external_orders(self, request, queryset): # <- `queryset` can be empty

        if not queryset:
            queryset = ExternalOrder.objects.all()

        ...

    actions = [update_external_orders]