自定义django admin Action

https://blog.csdn.net/anbuqi/article/details/100810993

 

自定义django admin Action

 

 

简介

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

Admin actions简介

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

在这里插入图片描述

编写Admin actions

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

下面来编写action函数,这个函数接受三个函数:

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

为了达到最佳性能,推荐使用QuerySetupdate方法,

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

添加actionModelAdmin

完整程序如下:

效果如下:

在这里插入图片描述

处理action中的错误

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

将action定义为ModelAdmin的内部方法

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

修改上述ArticleAdmin

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

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

效果如下:

在这里插入图片描述

提供中间页的action

在一些情况下,action需要提供一个中间页来提示用户是否确认执行操作,比如删除对象时提醒用户是否确认执行操作:
在这里插入图片描述

要提供中间页,只需要返回一个HttpResponse或者子类即可。例如一个导出选中对象json文件的操作:

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

actions在整个站点中都有效

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

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

禁用action

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

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

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

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

有条件的启用或者禁用action

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

设置action的权限

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

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

  • add
  • change
  • delete
  • view

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

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

 
文章知识点与官方知识档案匹配,可进一步学习相关知识
Python入门技能树Web应用开发 Django182986 人正在系统学习中
posted on 2022-11-18 10:14  ldx-wsj  阅读(255)  评论(0)    收藏  举报