django 框架配有一个功能强大的管理站点,里面已经预定义了许多管理站点需要进行的操作,但是有时可能默认的操作不能满足需求,如需要批量更新选中的对象,这需要编写自定义 action 实现。本文基于 django 官方英文文档梳理了一下自定义管理操作需要做的工作,方便快速了解自定义管理操作的实现过程。
作者 | 单雨,责编 | 黄浩然
出品 | CSDN(ID:CSDNnews)
Admin actions 简介
admin actions 是一些在 admin 站点下拉列表中可以选择执行的简单函数,比如删除一个对象操作。
编写 Admin actions
下面举例说明如何编写Admin action。例如批量更新一个名为 Article 的模型:
from django.db import models
STATUS_CHOICES = [
('d', 'Draft'),
('p', 'Published'),
('w', 'Withdrawn'),
]
classArticle(models.Model):
title = models.CharField(max_length=100)
body = models.TextField
status = models.CharField(max_length=1,choices=STATUS_CHOICES)
def__str__(self):
returnself.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 ="Markselected stories as published"
添加 action 到 ModelAdmin
完整程序如下:
from django.contrib import admin
from myapp.models import Article
defmake_published(modeladmin, request, queryset):
queryset.update(status='p')
make_published.short_description ="Markselected stories as published"
classArticleAdmin(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 aspublished"
注意 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
defexport_as_json(modeladmin, request, queryset):
response = HttpResponse(content_type="application/json")
serializers.serialize("json