如何轻松了解 Python 必学的 django 框架?
toyiye 2024-09-19 04:44 3 浏览 0 评论
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", queryset, stream=response)
return response
但是这样可能会使 action 的逻辑非常复杂,推荐做法是返回一个 HTTP 重定向,重定向到一个新的页面上,这样可以在页面的视图中执行更复杂的逻辑,避免 action 中充满复杂的逻辑。
from django.contrib import admin
fromdjango.contrib.contenttypes.models import ContentType
from django.http import HttpResponseRedirect
defexport_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
classAnotherModelAdmin(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 属性来限制具有特定权限的用户的可用性:
efmake_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
classArticleAdmin(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 publishpermission?"""
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/
作者简介:单雨,90 后工科男,伪文艺青年。目前就读于北京理工大学宇航系,喜欢研究 AI,网络爬虫,微信小程序以及机器人,痴迷于 Coding,睡前必撸码。
【END】
相关推荐
- 为何越来越多的编程语言使用JSON(为什么编程)
-
JSON是JavascriptObjectNotation的缩写,意思是Javascript对象表示法,是一种易于人类阅读和对编程友好的文本数据传递方法,是JavaScript语言规范定义的一个子...
- 何时在数据库中使用 JSON(数据库用json格式存储)
-
在本文中,您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?,Devops,敏捷?,测试?以及?项目?管理?最新?,最热门?的?文章?,每天?花?...
- MySQL 从零开始:05 数据类型(mysql数据类型有哪些,并举例)
-
前面的讲解中已经接触到了表的创建,表的创建是对字段的声明,比如:上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...
- JSON对象花样进阶(json格式对象)
-
一、引言在现代Web开发中,JSON(JavaScriptObjectNotation)已经成为数据交换的标准格式。无论是从前端向后端发送数据,还是从后端接收数据,JSON都是不可或缺的一部分。...
- 深入理解 JSON 和 Form-data(json和formdata提交区别)
-
在讨论现代网络开发与API设计的语境下,理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里,特别值得关注的是两种主流数据格式:...
- JSON 语法(json 语法 priority)
-
JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...
- JSON语法详解(json的语法规则)
-
JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意:json的key是字符串,且必须是双引号,不能是单引号...
- MySQL JSON数据类型操作(mysql的json)
-
概述mysql自5.7.8版本开始,就支持了json结构的数据存储和查询,这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库,在处理json这种非结构化的数据...
- JSON的数据模式(json数据格式示例)
-
像XML模式一样,JSON数据格式也有Schema,这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...
- 前端学习——JSON格式详解(后端json格式)
-
JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...
- 什么是 JSON:详解 JSON 及其优势(什么叫json)
-
现在程序员还有谁不知道JSON吗?无论对于前端还是后端,JSON都是一种常见的数据格式。那么JSON到底是什么呢?JSON的定义...
- PostgreSQL JSON 类型:处理结构化数据
-
PostgreSQL提供JSON类型,以存储结构化数据。JSON是一种开放的数据格式,可用于存储各种类型的值。什么是JSON类型?JSON类型表示JSON(JavaScriptO...
- JavaScript:JSON、三种包装类(javascript 包)
-
JOSN:我们希望可以将一个对象在不同的语言中进行传递,以达到通信的目的,最佳方式就是将一个对象转换为字符串的形式JSON(JavaScriptObjectNotation)-JS的对象表示法...
- Python数据分析 只要1分钟 教你玩转JSON 全程干货
-
Json简介:Json,全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...
- 比较一下JSON与XML两种数据格式?(json和xml哪个好)
-
JSON(JavaScriptObjectNotation)和XML(eXtensibleMarkupLanguage)是在日常开发中比较常用的两种数据格式,它们主要的作用就是用来进行数据的传...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- r语言矩阵 (127)
- browsererror (114)
- exportexcel (119)
- cv2.bitwise_not (137)
- dump命令 (128)
- es6concat (126)
- heapify (127)
- java.security.egd (130)
- javax.annotation (117)
- jsstringsplit (117)
- js数字 (115)
- maven编译 (132)
- mysqlleft (128)
- nodejsbuffer (149)
- org.apache.commons.httpclient (126)
- org.jsoup (141)
- org.springframework.web (128)
- robotframework-ride (115)
- setnocounton (141)
- socket.gethostbyname (122)
- sqlmid (121)
- time.strptime (133)
- vscode格式化 (125)
- win32con (129)
- window.localstorage (126)