Django自定义YamlField实现过程解析


Posted in Python onNovember 11, 2020

需求

在使用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)

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python编写简单的HTML页面合并脚本
Jul 11 Python
python3中int(整型)的使用教程
Mar 23 Python
python实现12306火车票查询器
Apr 20 Python
利用arcgis的python读取要素的X,Y方法
Dec 22 Python
python tkinter图形界面代码统计工具
Sep 18 Python
tensorflow入门:tfrecord 和tf.data.TFRecordDataset的使用
Jan 20 Python
keras中的卷积层&amp;池化层的用法
May 22 Python
Python使用configparser读取ini配置文件
May 25 Python
基于python SMTP实现自动发送邮件教程解析
Jun 02 Python
如何基于Python Matplotlib实现网格动画
Jul 20 Python
Python基础之元编程知识总结
May 23 Python
python基础之函数的定义和调用
Oct 24 Python
Python监听剪切板实现方法代码实例
Nov 11 #Python
如何通过python计算圆周率PI
Nov 11 #Python
python中turtle库的简单使用教程
Nov 11 #Python
python 怎样进行内存管理
Nov 10 #Python
python tqdm实现进度条的示例代码
Nov 10 #Python
python 解决Windows平台上路径有空格的问题
Nov 10 #Python
Python在后台自动解压各种压缩文件的实现方法
Nov 10 #Python
You might like
PHP 中的类
2006/10/09 PHP
PHP+MYSQL会员系统的开发实例教程
2014/08/23 PHP
在Windows系统下使用PHP生成Word文档的教程
2015/07/03 PHP
ASP.NET jQuery 实例14 在ASP.NET form中校验时间范围
2012/02/03 Javascript
js 获取input点选按钮的值的方法
2014/04/14 Javascript
浅谈javascript中字符串String与数组Array
2014/12/31 Javascript
js实现可兼容IE、FF、Chrome、Opera及Safari的音乐播放器
2015/02/11 Javascript
jQuery插件jqGrid动态获取列和列字段的方法
2017/03/03 Javascript
Javascript封装id、class与元素选择器方法示例
2017/03/13 Javascript
利用jquery正则表达式在页面验证url网址输入是否正确
2017/04/04 jQuery
jQuery 中msgTips 顶部弹窗效果实现代码
2017/08/14 jQuery
JavaScript函数定义方法实例详解
2019/03/05 Javascript
js实现3D照片墙效果
2019/10/28 Javascript
JavaScript实现与web通信的方法详解
2020/08/07 Javascript
python中正则表达式的使用详解
2014/10/17 Python
python 爬取微信文章
2016/01/30 Python
python 剪切移动文件的实现代码
2018/08/02 Python
用Python编写一个高效的端口扫描器的方法
2018/12/20 Python
Python网络爬虫之爬取微博热搜
2019/04/18 Python
PyTorch的深度学习入门教程之构建神经网络
2019/06/27 Python
使用Python的Turtle绘制哆啦A梦实例
2019/11/21 Python
Pytorch 之修改Tensor部分值方式
2019/12/27 Python
html5 input输入实时检测以及延时优化
2018/07/18 HTML / CSS
html5自定义video标签的海报与播放按钮功能
2019/12/04 HTML / CSS
松下电器美国官方商店:Panasonic美国
2016/10/14 全球购物
一份婚庆公司创业计划书
2014/01/11 职场文书
优秀教师自我评价范文
2014/09/27 职场文书
奔腾年代观后感
2015/06/09 职场文书
安全第一课观后感
2015/06/18 职场文书
基于Nginx实现限制某IP短时间访问次数
2021/03/31 Servers
4种非常实用的python内置数据结构
2021/04/28 Python
如何理解PHP核心特性命名空间
2021/05/28 PHP
CSS中Single Div 绘图技巧的实现
2021/06/18 HTML / CSS
解决mysql模糊查询索引失效问题的几种方法
2021/06/18 MySQL
关于python类SortedList详解
2021/09/04 Python
CentOS7安装MySQL8的超级详细教程(无坑!)
2022/06/10 Servers