django-admin-form-action 1.0.0

Parametrized actions for Django admin site

django-admin-form-action

django-admin-form-action is intended to implement parametrized actions on the Django admin site. Action parameters are passed through an intermediate form as it shown below.

The demonstrated functionality can be implemented with django-admin-form-action in the following way:

from django import forms
from django.contrib import admin
from django.contrib.auth.models import Group, User

from admin_form_action import form_action


class GroupsForm(forms.Form):
    groups = forms.ModelMultipleChoiceField(queryset=Group.objects.all())

    def add_user(self, user: User):
        user.groups.add(*self.cleaned_data['groups'])

@admin.register(User)
class UserAdmin(admin.ModelAdmin):
    actions = ['add_to_groups']

    @form_action(GroupsForm)
    @admin.action(description='Add selected users to certain groups')
    def add_to_groups(self, request, queryset):
        # Validated form is injected by `@form_action` to `request.form`
        groups_form = request.form
        for user in queryset:
            groups_form.add_user(user)

Install

pip install django-admin-form-action

INSTALLED_APPS = [
    ...
    'admin_form_action',
    ...
]

Development

Run demo app

poetry install
poetry run django-admin migrate --settings=tests.app.settings
poetry run django-admin runserver --settings=tests.app.settings

Test

poetry run pytest

Lint

poetry run isort .
poetry run ruff . 
poetry run mypy .