自定义 Django 字段不会从查询中返回 Enum 实例答案

【问题标题】：Custom Django field does not return Enum instances from query自定义 Django 字段不会从查询中返回 Enum 实例
【发布时间】：2016-01-20 23:13:22
【问题描述】：

我实现了一个简单的自定义字段来利用 Python 3 Enum 实例。将枚举实例分配给我的模型属性并保存到数据库中可以正常工作。但是，使用 QuerySet 获取模型实例会导致 enum 属性为字符串，而不是相应的 Enum 实例。

如何让下面的EnumField 返回有效的Enum 实例，而不是字符串？

fields.py：

from enum import Enum

from django.core.exceptions import ValidationError
from django.db import models


class EnumField(models.CharField):
    description = 'Enum with strictly typed choices'

    def __init__(self, enum_class, *args, **kwargs):
        self._enum_class = enum_class
        choices = []
        for enum in self._enum_class:
            title_case = enum.name.replace('_', ' ').title()
            entry = (enum, title_case)
            choices.append(entry)
        kwargs['choices'] = choices
        kwargs['blank'] = False  # blank doesn't make sense for enum's
        super().__init__(*args, **kwargs)

    def deconstruct(self):
        name, path, args, kwargs = super().deconstruct()
        args.insert(0, self._enum_class)
        del kwargs['choices']
        return name, path, args, kwargs

    def from_db_values(self, value, expression, connection, context):
        return self.to_python(value)

    def to_python(self, value):
        if value is None or isinstance(value, self._enum_class):
            return value
        else:
            return self._parse_enum(value)

    def _parse_enum(self, value):
        try:
            enum = self._enum_class[value]
        except KeyError:
            raise ValidationError("Invalid type '{}' for {}".format(
                value, self._enum_class))
        else:
            return enum

    def get_prep_value(self, value):
        if value is None:
            return None
        elif isinstance(value, Enum):
            return value.name
        else:
            msg = "'{}' must have type {}".format(
                value, self._enum_class.__name__)
            if self.null:
                msg += ', or `None`'
            raise TypeError(msg)

    def get_choices(self, **kwargs):
        kwargs['include_blank'] = False  # Blank is not a valid option
        choices = super().get_choices(**kwargs)
        return choices

【问题讨论】：

标签： python django python-3.x enums django-custom-field

【解决方案1】：

经过大量挖掘，我能够回答自己的问题：

SubfieldBase 已被弃用，将在 Django 1.10 中删除；这就是为什么我把它排除在上面的实现之外。但是，它的作用似乎仍然很重要。添加以下方法来替换 SubfieldBase 将添加的功能。

def contribute_to_class(self, cls, name, **kwargs):
    super(EnumField, self).contribute_to_class(cls, name, **kwargs)
    setattr(cls, self.name, Creator(self))

Creator 描述符在属性上调用to_python。如果这没有发生，对模型的查询将导致模型实例中的 EnumField 字段只是字符串，而不是我想要的 Enum 实例。

【讨论】：