Python 3与Cloud NDB中msgprop.EnumProperty及messages.Enum的最佳实践是什么？

在Python 3的Google Cloud NDB环境中，原来依赖msgprop.EnumProperty的方式已经不再支持，官方也没有提供直接替代的内置属性。不过我们可以基于Python标准库的enum.Enum，结合NDB的基础属性来实现优雅的枚举存储，下面是几种常用的方案：

方案1：用IntegerProperty存储枚举数值（最接近原逻辑） #

这种方式和你之前用msgprop.EnumProperty的逻辑最像，数据库里存储枚举对应的整数Value，既节省存储空间，也能保持枚举的数值语义。

首先定义标准的Python枚举类：

import enum
from google.cloud import ndb

class CoreWebhookService(enum.Enum):
    UNKNOWN = 0
    AUTH0 = 1

然后在实体类中使用IntegerProperty，并封装一个属性来简化枚举成员的读写：

class CoreWebhook(ndb.Model):
    # 底层存储枚举的整数值
    _service = ndb.IntegerProperty(required=True, name="service")
    url = ndb.StringProperty(required=True)

    @property
    def service(self):
        # 从数据库的整数转成枚举成员
        return CoreWebhookService(self._service)

    @service.setter
    def service(self, value):
        # 支持直接传入枚举成员或合法的整数值
        if isinstance(value, CoreWebhookService):
            self._service = value.value
        else:
            try:
                self._service = CoreWebhookService(value).value
            except ValueError:
                raise ValueError(f"无效的服务类型：{value}，可选值为{[e.name for e in CoreWebhookService]}")

使用的时候就和操作普通属性一样自然：

# 创建实体
webhook = CoreWebhook(url="https://your-webhook-url.com")
webhook.service = CoreWebhookService.AUTH0
webhook.put()

# 查询并使用枚举
fetched_hook = CoreWebhook.query().get()
print(fetched_hook.service)  # 输出 CoreWebhookService.AUTH0
print(fetched_hook.service.value)  # 输出 1

方案2：用StringProperty存储枚举名称（可读性更强） #

如果希望数据库里存储的内容更直观（比如直接看到"AUTH0"而不是1），可以选择存储枚举的Name字符串：

import enum
from google.cloud import ndb

class CoreWebhookService(enum.Enum):
    UNKNOWN = 0
    AUTH0 = 1

class CoreWebhook(ndb.Model):
    _service = ndb.StringProperty(required=True, name="service")
    url = ndb.StringProperty(required=True)

    @property
    def service(self):
        return CoreWebhookService[self._service]

    @service.setter
    def service(self, value):
        if isinstance(value, CoreWebhookService):
            self._service = value.name
        else:
            try:
                self._service = CoreWebhookService[value].name
            except KeyError:
                raise ValueError(f"无效的服务名称：{value}，可选值为{[e.name for e in CoreWebhookService]}")

这种方式的优势是数据库中的数据可读性更高，排查问题时不用对照枚举的数值映射。

方案3：自定义NDB属性类（复用性最佳） #

如果你的项目中有多个实体需要使用枚举，推荐自定义一个通用的EnumProperty，封装序列化和反序列化逻辑，这样所有实体都能像使用原生NDB属性一样用枚举：

import enum
from google.cloud import ndb

class EnumProperty(ndb.Property):
    def __init__(self, enum_class, store_value=True, **kwargs):
        self.enum_class = enum_class
        # store_value=True 存储枚举数值，False存储枚举名称
        self.store_value = store_value
        super().__init__(**kwargs)

    def _validate(self, value):
        if not isinstance(value, self.enum_class):
            raise TypeError(f"需要传入{self.enum_class.__name__}类型，当前为{type(value).__name__}")
        return value

    def _to_base_type(self, value):
        # 把枚举转成数据库存储的基础类型
        return value.value if self.store_value else value.name

    def _from_base_type(self, value):
        # 把数据库的基础类型转回枚举
        try:
            return self.enum_class(value) if self.store_value else self.enum_class[value]
        except (ValueError, KeyError):
            raise ValueError(f"无法将{value}转换为{self.enum_class.__name__}枚举")

# 使用自定义属性
class CoreWebhookService(enum.Enum):
    UNKNOWN = 0
    AUTH0 = 1

class CoreWebhook(ndb.Model):
    # store_value=True 存储数值，False存储名称
    service = EnumProperty(CoreWebhookService, store_value=True, required=True)
    url = ndb.StringProperty(required=True)

使用时完全和原生属性一致，非常简洁：

webhook = CoreWebhook(service=CoreWebhookService.AUTH0, url="https://your-webhook-url.com")
webhook.put()

fetched_hook = CoreWebhook.query().get()
print(fetched_hook.service)  # 直接得到CoreWebhookService.AUTH0枚举成员

总结 #

目前官方推荐的最佳实践是基于Python标准库的enum.Enum，结合NDB的基础属性（Integer/String）来实现枚举存储。如果是单个实体使用，方案1或2足够简单；如果多个实体需要用枚举，方案3的自定义属性能大幅提升代码复用性。

内容的提问来源于stack exchange，提问作者Thibault Le Conte