需求
在使用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)
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件!
如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
白云城资源网 Copyright www.dyhadc.com
暂无“Django自定义YamlField实现过程解析”评论...
更新日志
2024年11月08日
2024年11月08日
- 雨林唱片《赏》新曲+精选集SACD版[ISO][2.3G]
- 罗大佑与OK男女合唱团.1995-再会吧!素兰【音乐工厂】【WAV+CUE】
- 草蜢.1993-宝贝对不起(国)【宝丽金】【WAV+CUE】
- 杨培安.2009-抒·情(EP)【擎天娱乐】【WAV+CUE】
- 周慧敏《EndlessDream》[WAV+CUE]
- 彭芳《纯色角3》2007[WAV+CUE]
- 江志丰2008-今生为你[豪记][WAV+CUE]
- 罗大佑1994《恋曲2000》音乐工厂[WAV+CUE][1G]
- 群星《一首歌一个故事》赵英俊某些作品重唱企划[FLAC分轨][1G]
- 群星《网易云英文歌曲播放量TOP100》[MP3][1G]
- 方大同.2024-梦想家TheDreamer【赋音乐】【FLAC分轨】
- 李慧珍.2007-爱死了【华谊兄弟】【WAV+CUE】
- 王大文.2019-国际太空站【环球】【FLAC分轨】
- 群星《2022超好听的十倍音质网络歌曲(163)》U盘音乐[WAV分轨][1.1G]
- 童丽《啼笑姻缘》头版限量编号24K金碟[低速原抓WAV+CUE][1.1G]