Действия администратора¶

Написание функций действия¶

Во-первых, нам нужно написать функцию, которая будет вызываться, когда действие запускается из админки. Функции действия - это обычные функции, принимающие три аргумента:

• Текущий ModelAdmin
• HttpRequest, представляющий текущий запрос,
• QuerySet, содержащий набор объектов, выбранных пользователем.

Нашей функции publish-these-articles не понадобится ModelAdmin или объект request, но мы будем использовать queryset:

def make_published(modeladmin, request, queryset):
    queryset.update(status="p")

for obj in queryset:
    do_something_with(obj)

Вот, собственно, и все, что нужно для написания действия! Однако мы сделаем еще один необязательный, но полезный шаг и дадим действию «красивое» название в админке. По умолчанию это действие будет отображаться в списке действий как «Сделать опубликованным» - название функции с подчеркиваниями, замененными пробелами. Это хорошо, но мы можем дать лучшее, более удобное для человека название, используя декоратор action() на функции make_published:

from django.contrib import admin

...


@admin.action(description="Mark selected stories as published")
def make_published(modeladmin, request, queryset):
    queryset.update(status="p")

Добавление действий в ModelAdmin¶

Далее нам нужно сообщить нашему ModelAdmin о действии. Это работает так же, как и любой другой параметр конфигурации. Таким образом, полный admin.py с действием и его регистрацией будет выглядеть так:

from django.contrib import admin
from myapp.models import Article


@admin.action(description="Mark selected stories as published")
def make_published(modeladmin, request, queryset):
    queryset.update(status="p")


class ArticleAdmin(admin.ModelAdmin):
    list_display = ["title", "status"]
    ordering = ["title"]
    actions = [make_published]


admin.site.register(Article, ArticleAdmin)

Этот код даст нам список изменений администратора, который будет выглядеть примерно так:

Вот, собственно, и все! Если вам не терпится написать свои собственные действия, вы теперь знаете достаточно, чтобы начать. Остальная часть этого документа посвящена более продвинутым техникам.

Обработка ошибок в действиях¶

Если во время выполнения вашего действия могут возникнуть предсказуемые ошибки, вы должны изящно проинформировать пользователя о проблеме. Это означает обработку исключений и использование django.contrib.admin.ModelAdmin.message_user() для отображения в ответе удобного для пользователя описания проблемы.

Действия как методы ModelAdmin¶

В приведенном выше примере действие make_published определено как функция. Это вполне нормально, но не идеально с точки зрения проектирования кода: поскольку действие тесно связано с объектом Article, имеет смысл подключить действие к самому объекту ArticleAdmin.

Вы можете сделать это следующим образом:

class ArticleAdmin(admin.ModelAdmin):
    ...

    actions = ["make_published"]

    @admin.action(description="Mark selected stories as published")
    def make_published(self, request, queryset):
        queryset.update(status="p")

Обратите внимание, во-первых, что мы переместили make_published в метод и переименовали параметр modeladmin в self, а во-вторых, мы поместили строку 'make_published' в actions вместо прямой ссылки на функцию. Это указывает ModelAdmin искать действие как метод.

Определение действий как методов дает действию более идиоматический доступ к самому ModelAdmin, позволяя действию вызывать любой из методов, предоставляемых администратором.

Например, мы можем использовать self, чтобы выдать пользователю сообщение об успешном выполнении действия:

from django.contrib import messages
from django.utils.translation import ngettext


class ArticleAdmin(admin.ModelAdmin):
    ...

    def make_published(self, request, queryset):
        updated = queryset.update(status="p")
        self.message_user(
            request,
            ngettext(
                "%d story was successfully marked as published.",
                "%d stories were successfully marked as published.",
                updated,
            )
            % updated,
            messages.SUCCESS,
        )

Это делает действие соответствующим тому, что делает сам администратор после успешного выполнения действия:

Действия, предоставляющие промежуточные страницы¶

По умолчанию после выполнения действия пользователь перенаправляется обратно на исходную страницу списка изменений. Однако некоторые действия, особенно более сложные, должны возвращать промежуточные страницы. Например, встроенное действие удаления запрашивает подтверждение перед удалением выбранных объектов.

Чтобы обеспечить промежуточную страницу, верните HttpResponse (или подкласс) из вашего действия. Например, вы можете написать функцию экспорта, которая использует serialization functions от Django, чтобы выгрузить некоторые выбранные объекты в виде JSON:

from django.core import serializers
from django.http import HttpResponse


def export_as_json(modeladmin, request, queryset):
    response = HttpResponse(content_type="application/json")
    serializers.serialize("json", queryset, stream=response)
    return response

Как правило, что-то вроде вышеописанного не считается хорошей идеей. В большинстве случаев лучшей практикой будет возвращать HttpResponseRedirect и перенаправлять пользователя на написанное вами представление, передавая список выбранных объектов в строке запроса GET. Это позволит вам обеспечить сложную логику взаимодействия на промежуточных страницах. Например, если вы хотите предоставить более полную функцию экспорта, вы должны позволить пользователю выбрать формат и, возможно, список полей, которые будут включены в экспорт. Лучше всего написать небольшое действие, перенаправляющее на пользовательский вид экспорта:

from django.contrib.contenttypes.models import ContentType
from django.http import HttpResponseRedirect


def export_selected_objects(modeladmin, request, queryset):
    selected = queryset.values_list("pk", flat=True)
    ct = ContentType.objects.get_for_model(queryset.model)
    return HttpResponseRedirect(
        "/export/?ct=%s&ids=%s"
        % (
            ct.pk,
            ",".join(str(pk) for pk in selected),
        )
    )

Как вы можете видеть, действие довольно короткое; вся сложная логика будет находиться в вашем экспортном представлении. Здесь нужно будет работать с объектами любого типа, отсюда и бизнес с ContentType.

Написание этого представления оставляем на усмотрение читателя.

Обеспечение доступности действий в масштабах всего сайта¶

AdminSite.add_action(action, name=None)[исходный код]¶

Некоторые действия лучше всего сделать доступными для любого объекта на сайте администратора - действие экспорта, определенное выше, было бы хорошим кандидатом. Вы можете сделать действие глобально доступным, используя AdminSite.add_action(). Например:

from django.contrib import admin

admin.site.add_action(export_selected_objects)

Это делает действие export_selected_objects глобально доступным как действие с именем «export_selected_objects». Вы можете явно дать действию имя - хорошо, если вы позже захотите программно remove the action> - передав второй аргумент в AdminSite.add_action():

admin.site.add_action(export_selected_objects, "export_selected")

Отключение действий¶

Иногда вам нужно отключить определенные действия - особенно те, которые registered site-wide - для определенных объектов. Есть несколько способов отключить действия:

class MyModelAdmin(admin.ModelAdmin):
    actions = None

Установка разрешений для действий¶

Действия могут ограничить свою доступность для пользователей с определенными правами, обернув функцию действия декоратором action() и передав аргумент permissions:

@admin.action(permissions=["change"])
def make_published(modeladmin, request, queryset):
    queryset.update(status="p")

Действие make_published() будет доступно только тем пользователям, которые прошли проверку ModelAdmin.has_change_permission().

Если permissions имеет более одного разрешения, действие будет доступно до тех пор, пока пользователь проходит хотя бы одну из проверок.

Доступными значениями для permissions и соответствующих проверок метода являются:

• 'add': ModelAdmin.has_add_permission()
• 'change': ModelAdmin.has_change_permission()
• 'delete': ModelAdmin.has_delete_permission()
• 'view': ModelAdmin.has_view_permission()

Вы можете указать любое другое значение, если вы реализуете соответствующий метод has_<value>_permission(self, request) на ModelAdmin.

Например:

from django.contrib import admin
from django.contrib.auth import get_permission_codename


class ArticleAdmin(admin.ModelAdmin):
    actions = ["make_published"]

    @admin.action(permissions=["publish"])
    def make_published(self, request, queryset):
        queryset.update(status="p")

    def has_publish_permission(self, request):
        """Does the user have the publish permission?"""
        opts = self.opts
        codename = get_permission_codename("publish", opts)
        return request.user.has_perm("%s.%s" % (opts.app_label, codename))