自定义django admin Action

自定义django admin Action

简介

django框架配有一个功能强大的管理站点，里面已经预定义了许多管理站点需要进行的操作，但是有时可能默认的操作不能满足需求，如需要批量更新选中的对象，这需要编写自定义action实现。本文基于django官方英文文档梳理了一下自定义管理操作需要做的工作，方便快速了解自定义管理操作的实现过程。

Admin actions简介

admin actions是一些在admin站点下拉列表中可以选择执行的简单函数，比如删除一个对象操作。

编写Admin actions

下面举例说明如何编写Admin action。例如批量更新一个名为Article的模型：

from django.db import models

STATUS_CHOICES = [
    ('d', 'Draft'),
    ('p', 'Published'),
    ('w', 'Withdrawn'),
]

class Article(models.Model):
    title = models.CharField(max_length=100)
    body = models.TextField()
    status = models.CharField(max_length=1, choices=STATUS_CHOICES)

    def __str__(self):
        return self.title

下面来编写action函数，这个函数接受三个函数：

• 当前的ModelAdmin
• 一个代表当前HTTP请求的HttpRequest对象
• 一个包含用户选定的对象的QuerySet(数据库检索对象）。

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

为了达到最佳性能，推荐使用QuerySet的update方法，

for obj in queryset:
    do_something_with(obj)

默认情况下，该操作将以“Make published”的形式出现在操作列表中,就是函数名，下划线将由空格替换。为了让这个方法更容易被人了解，我们可以给它添加一个short_description属性。

def make_published(modeladmin, request, queryset):
    queryset.update(status='p')
make_published.short_description = "Mark selected stories as published"

添加action到ModelAdmin

完整程序如下：

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

def make_published(modeladmin, request, queryset):
    queryset.update(status='p')
make_published.short_description = "Mark selected stories as published"

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

admin.site.register(Article, ArticleAdmin)

效果如下：

处理action中的错误

如果在自定义的actions中可能发生错误，需要捕获这些错误并调用 **django.contrib.admin.ModelAdmin.message_user()**来向用户显示错误消息。

将action定义为ModelAdmin的内部方法

上述定义的action存在一个不足之处就是它和Article对象紧密耦合，这会导致大量的重复代码出现，即使这些action的功能都相同。将action定义为ModelAdmin的方法可以避免出现这个问题。

修改上述ArticleAdmin：

class ArticleAdmin(admin.ModelAdmin):
    ...

    actions = ['make_published']

    def make_published(self, request, queryset):
        queryset.update(status='p')
    make_published.short_description = "Mark selected stories as published"

注意make_published变为ArticleAdmin的内部方法，第一个参数变为了self。将action变为ModelAdmin的方法，使得它可以调用任何admin提供的方法。例如向用户发送消息：

class ArticleAdmin(admin.ModelAdmin):
    ...

    def make_published(self, request, queryset):
        rows_updated = queryset.update(status='p')
        if rows_updated == 1:
            message_bit = "1 story was"
        else:
            message_bit = "%s stories were" % rows_updated
        self.message_user(request, "%s successfully marked as published." % message_bit)

这使得action执行成功之后自动将action的行为和admin站点的行为相匹配。

效果如下：

提供中间页的action

在一些情况下，action需要提供一个中间页来提示用户是否确认执行操作，比如删除对象时提醒用户是否确认执行操作：

要提供中间页，只需要返回一个HttpResponse或者子类即可。例如一个导出选中对象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

但是这样可能会使action的逻辑非常复杂，推荐做法是返回一个HTTP重定向，重定向到一个新的页面上，这样可以在页面的视图中执行更复杂的逻辑，避免action中充满复杂的逻辑。

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

def export_selected_objects(modeladmin, request, queryset):
    selected = request.POST.getlist(admin.ACTION_CHECKBOX_NAME)
    ct = ContentType.objects.get_for_model(queryset.model)
    return HttpResponseRedirect("/export/?ct=%s&ids=%s" % (ct.pk, ",".join(selected)))

让actions在整个站点中都有效

如果想要让上述中的导出操作在整个管理站点中都能使用，可以这样做：

from django.contrib import admin

admin.site.add_action(export_selected_objects)

为了方便管理这个操作，比如使用代码移除这个操作，可以给它一个名称

from django.contrib import admin

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

禁用action

禁用站点范围作用的的action:

admin.site.disable_action('delete_selected')

这将在整个管理站点范围内禁用该action。

如果需要复用已经禁用的action。只需要在相应的ModelAdmin的actions属性中添加这个action即可。例如复用上述禁用的action:

# This one will
class AnotherModelAdmin(admin.ModelAdmin):
    actions = ['delete_selected']

在某个ModelAdmin中禁用所有的action，只需要将action属性设置为None即可。

class MyModelAdmin(admin.ModelAdmin):
    actions = None

有条件的启用或者禁用action

通过重写ModelAdmin的get_actions()方法可以实现有条件的启用或者禁用action。该方法返回一个允许使用的actions字典，键是操作名称，值是(函数、名称、short_description)元组。例如，如果您只希望名称以“J”开头的用户能够批量删除对象:

class MyModelAdmin(admin.ModelAdmin):
    ...

    def get_actions(self, request):
        actions = super().get_actions(request)
        if request.user.username[0].upper() != 'J':
            if 'delete_selected' in actions:
                del actions['delete_selected']
        return actions

设置action的权限

action可以通过设置allowed_permissions属性来限制具有特定权限的用户的可用性:

ef make_published(modeladmin, request, queryset):
    queryset.update(status='p')
make_published.allowed_permissions = ('change',)

如果allowed_permissions具有多个权限，则只要用户通过至少一个权限检查，该操作就可用。allowed_permissions可用值为：

• add
• change
• delete
• view

如果需要指定其他值，需要在ModelAdmin中定义一个**has_<value>_permission(self, request)**方法，例如：

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

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

    def make_published(self, request, queryset):
        queryset.update(status='p')
    make_published.allowed_permissions = ('publish',)

    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))

最后附上官方文档地址：https://docs.djangoproject.com/zh-hans/2.2/ref/contrib/admin/actions/