35.Django给admin添加Action

Django给admin添加Action

在使用Django自带的admin后台的时候,他提供了一些默认的指令可以对数据进行操作, 比如批量删除,修改等

同样的我们也可以添加自己的指令。

创建一个Django项目

$ django-admin startproject DjangoActions
$ cd DjangoActions
$ python3 manage.py startapp mysite

添加model

打开mysite下的models.py

from django.db import models


class Article(models.Model):
    # 文章状态,类似枚举
    STATUS_CHOICES = (
        ('d', '草稿'),
        ('p', '发布'),
    )
    # 标题
    title = models.CharField(max_length=30)
    # 内容
    body = models.TextField()
    # 状态
    status = models.CharField(max_length=1, choices=STATUS_CHOICES, default='d')

    def __str__(self):
        return self.title

将Article注册到admin

打开mysite下的admin.py

from django.contrib import admin
from .models import Article


# 指令处理函数,参数固定写法
def make_article_published(modeladmin, request, queryset):
    # queryset 是从数据库查询到的model set
    # 更新status状态为p,在此处就是Article
    queryset.update(status='p')


# 此指令的名称
make_article_published.short_description = '更改状态为发布'


#将Article注册到后台
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
    # 后台列表展示的字段
    list_display = ('title', 'status')
    # 动作集合
    actions = [make_article_published]

启动服务

1.首先同步数据库

$ python3 manage.py makemigrations
$ python3 manage.py migrate

2.创建超级用户

$ python3 manage.py createsuperuser

按照提示操作即可
3.启动服务

$ python3 manage.py runserver

效果

1.点击MYSITE下面Articles右边的add,添加一个文章。保存文章后会自动跳到文章列表。
2.点击Action右边的option。

我们自己的action已经添加进来了。
可以尝试选择文章前面的checkbox然后将其标记为发布。

将action定义到ModelAdmin内部

上面已经添加好了,一个自定义action但是看起有点不是很直观,不符合封装原理。 我们稍作修改。

from django.contrib import admin
from .models import Article


#将Article注册到后台
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
    # 后台列表展示的字段
    list_display = ('title', 'status')
    # 动作集合 修改为字符串
    actions = ['make_article_published']

    # 指令处理函数,参数固定写法
    def make_article_published(self, request, queryset):
        # queryset 是从数据库查询到的model set
        # 更新status状态为p,在此处就是Article
        queryset.update(status='p')
        # 操作完成后的提示信息
        self.message_user(request, '修改成功')

    # 此指令的名称
    make_article_published.short_description = '更改状态为发布'

重起服务器,再次修改状态,依旧执行成功,而且还有提示信息

跳转到中间页面

Django默认执行完动作后会返回到当前页面并刷新,同样我们也可以自定义跳转到其他页面。 只需在动作函数上返回一个HttpResponse即可。

views.py

from django.shortcuts import render


def success(request):
    return render(request, 'success.html')

DjangoActions/urls.py

from mysite.views import success
urlpatterns = [
    path('admin/', admin.site.urls),
    path('success/', success, name='success'),
]

templates/success.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
success
</body>
</html>

mysite/admin.py

from django.contrib import admin
from .models import Article
from django.shortcuts import redirect

#将Article注册到后台
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
    # 后台列表展示的字段
    list_display = ('title', 'status')
    # 动作集合 修改为字符串
    actions = ['make_article_published']

    # 指令处理函数,参数固定写法
    def make_article_published(self, request, queryset):
        # queryset 是从数据库查询到的model set
        # 更新status状态为p,在此处就是Article
        queryset.update(status='p')

        # 此处使用的转发,一可以直接使用HttpResponse
        return redirect('success')

    # 此指令的名称
    make_article_published.short_description = '更改状态为发布'

再次尝试修改,成功后会跳转到

整个站点的action

有时候为了方便,可能这个站点都有一个相同的动作,那么每一个modelAdmin都写一遍似乎有点傻,我们 可以配置整个站点的action解决问题。

使用方式:

from django.contrib import admin

admin.site.add_action(make_article_published)

禁用action

  • 禁用全站级别的acitons:
# 禁用默认的删除
admin.site.disable_action('delete_selected')
  • 全站禁用,个别可用 启用了全站禁用,某个又想使用怎么办,只需单独添加到actions里面就可以了
# 禁用默认的删除
admin.site.disable_action('delete_selected')

@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
    # 后台列表展示的字段
    list_display = ('title', 'status')
    # 动作集合
    actions = ['delete_selected']
  • 在指定模型中禁用所有actions 如果将模型中的actions=None那么所有的action都不可用,包括系统默认的
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
    # 后台列表展示的字段
    list_display = ('title', 'status')
    # 动作集合
    actions = None
  • 根据条件自动启用或禁用
#将Article注册到后台
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
    # 后台列表展示的字段
    list_display = ('title', 'status')
    # 动作集合 修改为字符串
    actions = ['make_article_published']

    # 指令处理函数,参数固定写法
    def make_article_published(self, request, queryset):
        # queryset 是从数据库查询到的model set
        # 更新status状态为p,在此处就是Article
        queryset.update(status='p')

        # 此处使用的转发,一可以直接使用HttpResponse
        return redirect('success')

    # 重写此方法,做出判断即可
    def get_actions(self, request):
        actions = super(ArticleAdmin, self).get_actions(request)
        if request.user.username[0].upper() != 'SuperUser':
            if 'delete_selected' in actions:
                del actions['delete_selected']
        return actions

    # 此指令的名称
    make_article_published.short_description = '更改状态为发布'
声明:原创文章,版权所有,转载请注明出处,https://litets.com。