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函数返回值实例分析
Jun 08 Python
分析Python中设计模式之Decorator装饰器模式的要点
Mar 02 Python
python调用fortran模块
Apr 08 Python
TF-IDF与余弦相似性的应用(一) 自动提取关键词
Dec 21 Python
Python实现压缩文件夹与解压缩zip文件的方法
Sep 01 Python
python使用正则筛选信用卡
Jan 27 Python
python 通过SSHTunnelForwarder隧道连接redis的方法
Feb 19 Python
python中数组和矩阵乘法及使用总结(推荐)
May 18 Python
Python生成器实现简单&quot;生产者消费者&quot;模型代码实例
Mar 27 Python
keras输出预测值和真实值方式
Jun 27 Python
Python实现Hash算法
Mar 18 Python
pandas时间序列之pd.to_datetime()的实现
Jun 16 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 执行系统外部命令 system() exec() passthru()
2009/08/11 PHP
php图片上传存储源码并且可以预览
2011/08/26 PHP
php中mysql连接方式PDO使用详解
2015/02/25 PHP
一个简单的php MVC留言本实例代码(必看篇)
2016/09/22 PHP
PHP GD库相关图像生成和处理函数小结
2016/09/30 PHP
jQuery中add实现同时选择两个id对象
2010/10/22 Javascript
IE6/7/8/9不支持exec的简写方式
2011/05/25 Javascript
js子页面获取父页面数据示例
2014/05/15 Javascript
javascript实现信息增删改查的方法
2015/07/25 Javascript
avalon js实现仿google plus图片多张拖动排序附源码下载
2015/09/24 Javascript
详解JavaScript时间处理之几个月前或几个月后的指定日期
2016/12/21 Javascript
js处理包含中文的字符串实例
2017/10/11 Javascript
利用10行js代码实现上下滚动公告效果
2017/12/08 Javascript
修改Nodejs内置的npm默认配置路径方法
2018/05/13 NodeJs
jquery 验证用户名是否重复代码实例
2019/05/14 jQuery
vue移动端城市三级联动组件使用详解
2019/07/26 Javascript
8个有意思的JavaScript面试题
2019/07/30 Javascript
使用Webpack提升Vue.js应用程序的4种方法(翻译)
2019/10/09 Javascript
vue搜索页开发实例代码详解(热门搜索,历史搜索,淘宝接口演示)
2020/04/11 Javascript
OpenLayer学习之自定义测量控件
2020/09/28 Javascript
[08:29]DOTA2每周TOP10 精彩击杀集锦vol.7
2014/06/25 DOTA
编写Python爬虫抓取暴走漫画上gif图片的实例分享
2016/04/20 Python
Python在Matplotlib图中显示中文字体的操作方法
2019/07/29 Python
python 使用pygame工具包实现贪吃蛇游戏(多彩版)
2019/10/30 Python
pytorch 多分类问题,计算百分比操作
2020/07/09 Python
Corelle官方网站:购买康宁餐具
2016/11/02 全球购物
纽约市的奢华内衣目的地:Anya Lust
2019/08/02 全球购物
职业生涯规划怎么写
2013/12/29 职场文书
物业保安员岗位职责制度
2014/01/30 职场文书
爱祖国演讲稿
2014/05/04 职场文书
党支部创先争优活动总结
2014/08/28 职场文书
奖金申请报告模板
2015/05/15 职场文书
开学典礼致辞
2015/07/29 职场文书
传单、海报早OUT了,另类传单营销方案送给你!
2019/07/15 职场文书
redis实现排行榜功能
2021/05/24 Redis
MIME类型中application/xml与text/xml的区别介绍
2022/01/18 HTML / CSS