序列化和反序列化 Django Enum 字段以接受数字和文本表示

2024-03-06

我正在尝试创建一个枚举字段 https://github.com/5monkeys/django-enumfield在 Django 中,在 GET 请求时将返回枚举的文本表示形式,在 POST 或 PATCH 请求时将在保存之前将文本表示形式转换为相应的整数。

The

transform_<field>()

方法可以很好地将整数枚举值转换为其相应的字符串,但除了破解之外,我找不到更好的方法将字符串转换为相应的整数

validate_<field>()

method.

有更好的方法吗?请看下面的代码

模型文件

class Status(enum.Enum):
    RUNNING = 0
    COMPLETED = 1

    labels = {
         RUNNING: 'Running',
         COMPLETED: 'Completed'
    }

    translation = {v: k for k, v in labels.iteritems()}

class Job(models.Model):
    status = enum.EnumField(Status)

串行器

class JobSeralizer(serializers.ModelSerailzer):
    status = seralizers.CharField(max_length=32, default=Status.QUEUED)

    def transform_status(self, obj, value):
        return JobStatus.labels[value]

    def validate_status(self, attrs, source):
        """Allow status to take numeric or character representation of status
        """
        status = attrs[source]
        if status in JobStatus.translation:
            attrs[source] = JobStatus.translation[status]
        elif status.isdigit():
            attrs[source] = int(status)
        else:
            raise serializers.ValidationError("'%s' not a valid status" % status)
        return attrs

正如OP所说,你可以使用轻松做到这一点自定义字段 http://www.django-rest-framework.org/api-guide/fields/#custom-fields在 drf v3.x 中。以下是用于转换值 标签(例如枚举值 文本表示)的通用自定义字段的快速示例:

class KeyValueField(serializers.Field):
    """ A field that takes a field's value as the key and returns
    the associated value for serialization """

    labels = {}
    inverted_labels = {}

    def __init__(self, labels, *args, **kwargs):
        self.labels = labels
        # Check to make sure the labels dict is reversible, otherwise
        # deserialization may produce unpredictable results
        inverted = {}
        for k, v in labels.iteritems():
            if v in inverted:
                raise ValueError(
                    'The field is not deserializable with the given labels.'
                    ' Please ensure that labels map 1:1 with values'
                )
            inverted[v] = k
        self.inverted_labels = inverted
        return super(KeyValueField, self).__init__(*args, **kwargs)

    def to_representation(self, obj):
        if type(obj) is list:
            return [self.labels.get(o, None) for o in obj]
        else:
            return self.labels.get(obj, None)

    def to_internal_value(self, data):
        if type(data) is list:
            return [self.inverted_labels.get(o, None) for o in data]
        else:
            return self.inverted_labels.get(data, None)

字段初始化看起来像这样:

class MySerializer(serializers.Serializer):
    afield = KeyValueField(labels={0:'enum text 0', 1:'enum text 1'})
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

序列化和反序列化 Django Enum 字段以接受数字和文本表示 的相关文章

随机推荐