python - pydantic 如何不使用 enum 设置枚举值？

Question

是否可以使用 Literal 来实现？

Answer 1

在 Pydantic 中，如果你想要设置枚举值但不使用内置的 Enum 类型，确实可以使用 Literal 来达到这个目的。Literal 类型是 Python 的 typing 模块（在 Python 3.8 及更高版本中作为内建类型提供，或在早期版本中使用 typing_extensions 包）的一部分，它可以用来指定一个或多个特定的值。

当在 Pydantic 模型中使用 Literal 时，它会确保该字段只接受指定的字面值之一。以下是一个如何使用 Literal 而不是 Enum 来设置枚举值的示例：

from pydantic import BaseModel, Literal, ValidationError
from typing import Union

class MyModel(BaseModel):
    status: Union[Literal['active'], Literal['inactive'], Literal['pending']]

# 创建一个有效的实例
instance = MyModel(status='active')
print(instance)

# 尝试创建一个带有无效状态的实例将引发 ValidationError
try:
    invalid_instance = MyModel(status='invalid')
except ValidationError as e:
    print(e)

在这个例子中，status 字段只接受 'active'、'inactive' 或 'pending' 这三个值之一。如果尝试使用其他值（如 'invalid'），则会引发 ValidationError。

需要注意的是，使用 Literal 时，你通常需要将多个可能的字面量值组合在一个 Union 中（如上例所示），除非你只想要一个固定的值。如果你有许多可能的值，这可能会有些冗长，但它在功能上等同于使用枚举，而无需定义额外的枚举类。