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)