在 Python 项目中,枚举(Enum)是一个很实用的工具。订单状态、用户角色、任务执行状态、HTTP 状态码,这些字段通常都有一个共同特点:取值范围相对固定,而且每个值都有明确的业务含义。本文主要总结三种枚举类型:Enum、IntEnum 和 StrEnum。Enum 是 Python 标准库提供的基础枚举类型,在 Python 3.4 引入。
from enum import Enum
class EnumDemo(Enum):
INT_DATA = 100
STR_DATA = "string"
print(EnumDemo.INT_DATA) # EnumDemo.INT_DATA
print(EnumDemo.STR_DATA) # EnumDemo.STR_DATA
print(EnumDemo.INT_DATA.value) # 100
print(EnumDemo.STR_DATA.value) # string
同时注意,获取枚举值需要通过 x.value 的形式。
下面这个示例中,约束的是 Color 成员的值类型只能是 str。
from enum import Enum
class Color(str, Enum):
RED = "red"
BLUE = "blue"
print(Color.RED) # Color.RED
print(Color.RED.value) # red
IntEnum 同样来自 Python 标准库 enum 模块,也是在 Python 3.4 引入。它继承自 int 和 Enum,枚举成员既是枚举,也是整数。from enum import IntEnum
class HttpStatus(IntEnum):
OK = 200
NOT_FOUND = 404
INTERNAL_ERROR = 500
print(HttpStatus.OK) # 200
print(HttpStatus.OK.name) # OK
需要注意的是,此处打印枚举成员,默认打印的是 value,而不是 name,如果要打印 name,应该采用 x.name 的形式。在 Python 3.11 中,标准库新增了 StrEnum。这是本文的重点,因为一些静态工具中已有规则,推荐将传统定义的字符串枚举,改用 StrEnum。StrEnum的设计思路和 IntEnum 类似,只不过继承的基础类型从 int 变成了 str。
from enum import StrEnum
class OrderStatus(StrEnum):
PAID = "paid"
PENDING = "pending"
CANCELLED = "cancelled"
print(OrderStatus.PAID) # paid
和 IntEnum 一样,枚举成员的默认打印结果是 value,不是 name,这样有一个好处:在 FastAPI 等技术栈中,经常需要处理 JSON 数据、请求参数和响应字段,StrEnum 可以减少枚举和字符串之间的转换。另外,StrEnum 还支持 auto(): 自动生成的值为成员名称的小写形式。这种写法可以少写代码,因为 auto() 生成的值依赖成员名称,修改成员名称时,值也会自动变化。from enum import StrEnum, auto
class OrderStatus(StrEnum):
PAID = auto()
PENDING = auto()
CANCELLED = auto()
print(OrderStatus.PAID) # paid
print(OrderStatus.PENDING) # pending
print(OrderStatus.CANCELLED) # cancelled
如果枚举类型是 int / str,优先考虑 IntEnum / StrEnum,否则,使用 Enum。