Django自定义YamlField实现过程解析
需求
在使用django admin时希望后台的Textarea多行文本框可以按yaml格式编写，数据库保存为Text文本类型，字段和接口中读取出来自动变为字典或列表格式。
试过pip install django-yamlfied，修改支持新版django之后
接口中返回的字段是字符串形式，不符合预期。
之前写过一版。
import yaml
from django.db import models
class YamlField(models.TextField):
def to_python(self, value): # 将数据库内容转为python对象时调用
if not value:
value = {}
if isinstance(value, (list, dict)):
return value
return yaml.safe_load(value)
def get_prep_value(self, value): # create时插入数据, 转为字符串存储
return value if value is None else yaml.dump(value, default_flow_style=False)
def from_db_value(self, value, expression, connection): # 从数据库读取字段是调用
return self.to_python(value)
问题是输入框输入
- a
- b
- c
保存后就会变成字典的字符串形式
['a','b','c']
无法原样保存，反复研究后，参考django-jsonfield写了一版。
原理是，改为继承models.Field类，（继承models.TextField类，则formfield和value_to_string不生效）
数据库依旧将数据库中的yaml文本转为dict/list，在django admin中通过自定义widget显示为yaml字符串格式。
为了保存时，验证表单中yaml字符串格式是否正确，还需要自定义一个form。完整代码如下。
import django
from django.db import models
from django import forms
from django.core.exceptions import ValidationError
import yaml
class YamlWidget(forms.Textarea):
def render(self, name, value, attrs=None, renderer=None):
if value is None:
value = ""
if not isinstance(value, str):
value = yaml.safe_dump(value, default_flow_style=False)
if django.VERSION < (2, 0):
return super().render(name, value, attrs)
return super().render(name, value, attrs, renderer)
class YamlFormField(forms.CharField):
empty_values = [None, '']
def __init__(self, *args, **kwargs):
if 'widget' not in kwargs:
kwargs['widget'] = YamlWidget
super().__init__(*args, **kwargs)
def to_python(self, value):
if isinstance(value, str) and value:
try:
return yaml.safe_load(value)
except Exception as exc:
raise forms.ValidationError('Yaml decode error: %s' % (exc.args[0],))
else:
return value
def validate(self, value):
if value in self.empty_values and self.required:
raise forms.ValidationError(self.error_messages['required'], code='required')
class YamlField(models.Field):
description = "Yaml object"
def get_internal_type(self):
return 'TextField'
def formfield(self, **kwargs):
defaults = {
'form_class': YamlFormField,
'widget': YamlWidget
}
defaults.update(**kwargs)
return super().formfield(**defaults)
def to_python(self, value: str): # 将数据库内容转为python对象时调用
if value is None:
if not self.null and self.blank:
return ""
return None
if isinstance(value, (list, dict)):
return value
value = yaml.safe_load(value)
return value
def validate(self, value, model_instance): # 验证从接受到字典格式
if not self.null and value is None:
raise ValidationError(self.error_messages['null'])
try:
self.get_prep_value(value)
except ValueError:
raise ValidationError(self.error_messages['invalid'] % value)
def get_prep_value(self, value: (list, dict)): # 保存时插入数据, 转为字符串存储
if value is None:
return None
value = yaml.safe_dump(value, default_flow_style=False)
return value
def from_db_value(self, value: str, expression, connection, *args, **kwargs): # 从数据库读取字段是调用
return self.to_python(value)
def value_to_string(self, obj): # Rest Framework调用时
return self.value_from_object(obj)
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。
相关推荐
-
如何使用Django Admin管理后台导入CSV
假设你需要允许在Hero管理页面上导入CSV数据.为此,您需要添加一个指向更改Hero列表页面的链接,点击这个链接会跳转到上传页面.你需要编写一个处理POST请求的方法,来从CSV文件中获取数据对象: class CsvImportForm(forms.Form): csv_file = forms.FileField() @admin.register(Hero) class HeroAdmin(admin.ModelAdmin, ExportCsvMixin): ... change_lis
-
使用AJAX和Django获取数据的方法实例
前言 使用Django服务网页时,只要用户执行导致页面更改的操作,即使该更改仅影响页面的一小部分,它都会将完整的HTML模板传递给浏览器. 但是如果我们只想更新页面的一部分,则不必完全重新渲染页面-我们可以使用AJAX代替. AJAX提供了一种将GET或POST请求发送到Django视图并接收任何返回的数据而无需刷新页面的方法. 现代JavaScript包含fetch API,该API为我们提供了一种纯JavaScript方式来发送AJAX请求. 让我们看一下如何通过获取发出GET和POST请求
-
利用Pycharm + Django搭建一个简单Python Web项目的步骤
一.Pycharm中安装Django 此教程默认你已安装并配置了Python 3.7.6) 1.File->Settings 二.搭建Django项目 1.File->New Project 2.新窗口打开,会出现以下的文件 简单解释一下这几个文件: **init.py:**这是一个初始化的空文件,一般我们不需要动它. settings.py: 这是一个配置文件,里面有关于语言.时区.安装的app声明等等信息: urls.py: 这个文件里指明了在访问一个页面时要调用的视图啊等的映射,确保在访
-
Django配置跨域并开发测试接口
1.跨域原理 1. 首先浏览器安全策略限制js ajax跨域访问服务器 2. 如果服务器返回的头部信息中有当前域: // 允许 http://localhost:8080 这个网站打开的页面中的js访问我 Access-Control-Allow-Origin: http://localhost:8080 // 允许携带cookie访问我 Access-Control-Allow-Credentials: true 那么, 浏览器可以让js 请求该服务器 2.django cors设置: 1.
-
Django admin组件的使用
admin admin 是 Django 自带的后台管理组件,你可以在 admin 中执行增删改查等操作. 它以可视化的方式让你来操纵模型表,十分的便捷. 基本使用 数据准备 如下,在 app01 中有一个这样的模型表: from django.db import models # Create your models here. class User(models.Model): user_id = models.AutoField(primary_key=True, verbose_name
-
Django xadmin安装及使用详解
一.简介 xadmin 是一个开源项目. 针对于 django admin ,页面美化程度,功能不完善 等问题 , 额外开发的一个模块.目前 xadmin 的最新版本已经是 xadmin 3.0 ,但是 xadmin 3.0 已经变成了一个纯前端项目,有兴趣的同学可以自己研究下.目前 作者已经不对 xadmin 2.0 做版本维护了,所以社区并不是很好,建议选择 其他的持续维护的开源项目. 文档:https://xadmin.readthedocs.io/en/latest/index.html
-
Python Django路径配置实现过程解析
假设访问的views.py如下 1.使用url配置默认页 from django.conf.urls import url from django.contrib import admin from django.urls import path from HelloWorld import views urlpatterns = [ path('admin/', admin.site.urls), url('^$', views.hello), ] 这样可以访问http://127.0.0.1
-
Django自定义YamlField实现过程解析
需求 在使用django admin时希望后台的Textarea多行文本框可以按yaml格式编写,数据库保存为Text文本类型,字段和接口中读取出来自动变为字典或列表格式. 试过pip install django-yamlfied,修改支持新版django之后 接口中返回的字段是字符串形式,不符合预期. 之前写过一版. import yaml from django.db import models class YamlField(models.TextField): def to_pytho
-
django自定义模板标签过程解析
这篇文章主要介绍了django自定义模板标签过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 代码布局 自定义模板标签必须位于django的某个应用中 该应用中新建templatetags目录,和models.py,views.py同一级别 结构如下: polls/ __init__.py models.py templatetags/ __init__.py poll_extras.py views.py 模板中调用标签: {% loa
-
django创建超级用户过程解析
这篇文章主要介绍了django创建超级用户过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 终端输入 python3 manage.py createsuperuser 按照提示进行操作即可 不输入用户名会给你默认一个用户名,输入密码是在原处不动的,其实已经在输入了. 创建超级用户是为了能够登陆admin账户给数据库中添加数据. 需要添加数据的表格要放在admin里 from django.contrib import admin # R
-
Python Django源码运行过程解析
目录 一.Django运行顺序 1.启动 1.1 命令行启动(测试服务器) 2.监听 2.1 runserver(测试服务器) 3.中间件的执行 本文只算是本人片面之言(当然也会借鉴网络上公开资料),而且技术含量比较低,内容质量也一般,大家仅限参考即可 如果对本文看不太懂,请先阅读后面文章,等都差不多看完再回顾来看 一.Django运行顺序 WSGI会不断监听客户端发送来的请求 先经过中间件进行分析验证处理 然后经过url分发与验证 视图层进行处理 再经过中间件进行分析验证处理 返回响应内容 1
-
Django 大文件下载实现过程解析
django提供文件下载时,若果文件较小,解决办法是先将要传送的内容全生成在内存中,然后再一次性传入Response对象中: def simple_file_download(request): # do something... content = open("simplefile", "rb").read() 如果文件非常大时,最简单的办法就是使用静态文件服务器,比如Apache或者Nginx服务器来处理下载.不过有时候,我们需要对用户的权限做一下限定,或者不想
-
Django缓存系统实现过程解析
在动态网站中,用户每次请求一个页面,服务器都会执行以下操作:查询数据库,渲染模板,执行业务逻辑,最后生成用户可查看的页面. 这会消耗大量的资源,当访问用户量非常大时,就要考虑这个问题了. 缓存就是为了防止重复计算,把那些消耗了大量资源的结果保存起来,下次访问时就不用再次计算了.缓存的逻辑: given a URL, try finding that page in the cache if the page is in the cache: return the cached page else
-
Django实现celery定时任务过程解析
1.首先在项目同名目录下建一个celery.py from __future__ import absolute_import import os from celery import Celery from datetime import timedelta from kombu import Queue # set the default Django settings module for the 'celery' program. os.environ.setdefault('DJANG
-
Django集成MongoDB实现过程解析
将Django与MongoDB集成 在不更改Django ORM的情况下,将MongoDB用作Django项目的后端数据库.使用Django Admin在MongoDB中添加和修改文档.通过仅添加一行代码,开始将Django与MongoDB结合使用. 1.pip安装djongo 2.设置setting文件 DATABASES = { 'default': { 'ENGINE': 'djongo', 'NAME': 'your-db-name', } } 需要注意的地方: 1.Python 3.6
-
Python自定义计算时间过滤器实现过程解析
这篇文章主要介绍了Python自定义计算时间过滤器实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 在写自定义的过滤器时,因为django.template.Library.filter()本身可以作为一个装饰器,所以可以使用: register = django.template.Library() @register.filter 代替 register.filter("过滤器名","函数名") 如果