django 结构配有一个功用强大的办理站点,里边现已预界说了许多办理站点需求进行的操作,可是有时或许默许的操作不能满意需求,如需求批量更新选中的目标,这需求编写自界说 action 完成。本文根据 django 官方英文文档梳理了一下自界说办理操作需求做的作业,便利快速了解自界说办理操作的完成进程。
作者 | 单雨,责编 | 黄浩然
出品 | CSDN(ID:CSDNnews)
Admin actions 简介
admin actions 是一些在 admin 站点下拉列表中能够挑选履行的简略函数,比方删去一个目标操作。
编写 Admin actions
下面举例说明怎么编写Admin action。例如批量更新一个名为 Article 的模型:
fromdjango.dbimportmodels
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 (数据库检索目标)。
defmake_published(modeladmin, request,queryset):
queryset.update(status='p')
为了到达最佳功用,引荐运用 QuerySet 的 update 办法,
forobjinqueryset:
do_something_with(obj)
默许情况下,该操作将以“ Make published ”的方式呈现在操作列表中,便是函数名,下划线将由空格替换。为了让这个办法更简单被人了解,咱们能够给它增加一个 short_description 特点。
defmake_published(modeladmin, request,queryset):
queryset.update(status='p')
make_published.short_description ="Markselected stories as published"
增加 action 到 ModelAdmin
完好程序如下:
fromdjango.contribimportadmin
frommyapp.modelsimportArticle
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 中的过错
将 action 界说为 ModelAdmin 的内部办法
上述界说的 action 存在一个不足之处便是它和 Article 目标严密耦合,这会导致很多的重复代码呈现,即便这些 action 的功用都相同。将 action 界说为 ModelAdmin 的办法能够防止呈现这个问题。
修正上述 ArticleAdmin:
classArticleAdmin(admin.ModelAdmin):
...
actions = ['make_published']
defmake_published(self, request, queryset):
queryset.update(status='p')
make_published.short_description ="Mark selected stories aspublished"
留意 make_published 变为 ArticleAdmin 的内部办法,第一个参数变为了 self。将 action 变为 ModelAdmin 的办法,使得它能够调用任何admin 供给的办法。例如向用户发送音讯:
classArticleAdmin(admin.ModelAdmin):
...
defmake_published(self, request, queryset):
rows_updated = queryset.update(status='p')
ifrows_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 文件的操作:
fromdjango.coreimportserializers
fromdjango.httpimportHttpResponse
defexport_as_json(modeladmin, request, queryset):
response = HttpResponse(content_type="application/json")
serializers.serialize("json", queryset, stream=response)
returnresponse
可是这样或许会使 action 的逻辑非常杂乱,引荐做法是回来一个 HTTP 重定向,重定向到一个新的页面上,这样能够在页面的视图中履行更杂乱的逻辑,防止 action 中充溢杂乱的逻辑。
fromdjango.contribimportadmin
fromdjango.contrib.contenttypes.modelsimportContentType
fromdjango.httpimportHttpResponseRedirect
defexport_selected_objects(modeladmin, request, queryset):
selected =request.POST.getlist(admin.ACTION_CHECKBOX_NAME)
ct = ContentType.objects.get_for_model(queryset.model)
returnHttpResponseRedirect("/export/?ct=%s&ids=%s"% (ct.pk,",".join(selected)))
让 actions 在整个站点中都有用
假如想要让上述中的导出操作在整个办理站点中都能运用,能够这样做:
为了便利办理这个操作,比方运用代码移除这个操作,能够给它一个称号
禁用 action
禁用站点规模效果的的 action:
这将在整个办理站点规模内禁用该 action。
假如需求复用现已禁用的 action。只需求在相应的 ModelAdmin 的actions 特点中增加这个 action即可。例如复用上述禁用的 action:
# This one will
classAnotherModelAdmin(admin.ModelAdmin):
actions=['delete_selected']
在某个 ModelAdmin 中禁用一切的 action,只需求将 action 特点设置为None 即可。
classMyModelAdmin(admin.ModelAdmin):
actions =None
有条件的启用或许禁用 action
经过重写 ModelAdmin的get_actions() 办法能够完成有条件的启用或许禁用 action。该办法回来一个答应运用的 actions 字典,键是操作称号,值是(函数、称号、short_description)元组。例如,假如您只期望称号以“J”最初的用户能够批量删去目标:
设置 action 的权限
action 能够经过设置 allowed_permissions 特点来约束具有特定权限的用户的可用性:
efmake_published(modeladmin, request, queryset):
queryset.update(status='p')
make_published.allowed_permissions = ('change',)
假如 allowed_permissions 具有多个权限,则只需用户经过至少一个权限查看,该操作就可用。allowed_permissions 可用值为:
add
change
delete
view
假如需求指定其他值,需求在ModelAdmin中界说一个haspermission( self, request )办法,例如:
fromdjango.contribimportadmin
fromdjango.contrib.authimportget_permission_codename
classArticleAdmin(admin.ModelAdmin):
actions = ['make_published']
defmake_published(self, request, queryset):
queryset.update(status='p')
make_published.allowed_permissions = ('publish',)
defhas_publish_permission(self, request):
"""Does the user have the publishpermission?"""
opts =self.opts
codename = get_permission_codename('publish', opts)
returnrequest.user.has_perm('%s.%s'% (opts.app_label, codename))
最终附上官方文档地址:https://docs.djangoproject.com/zh-hans/2.2/ref/contrib/admin/actions/
【END】