enum

enum 模块

基本示例

from enum import Enum

class TrafficLight(Enum):
    RED = 1
    YELLOW = 2
    GREEN = 3
    # GREEN = 4 # 错误：枚举成员的值不支持重新定义

    # 不推荐的写法，不符合使用枚举的目的
    A = None # 将枚举成员的值设置为None、False、True等
    B = [255, 0, 0] # 将枚举成员的值设置为可变类型
    C = 1 # 将枚举成员的值设置为与其他枚举成员的值相同

# 使用枚举
light = TrafficLight.RED

# if light == 1   常见错误：错误地使用Enum成员进行比较
if light == TrafficLight.RED:
    print("红灯，停车")
elif light == TrafficLight.YELLOW:
    print("黄灯，准备")
else:
    print("绿灯，通行")

是否使用Enum取决于你项目的需求和代码的复杂度。你可能觉得不需要它，尤其是在简单的场景下，直接使用字符串或整数常量看似足够。但是，Enum有以下几个优势：

1. 增加可读性

当你看到Color.RED时，比直接看到一个1或'red'更容易理解。Enum能让你的代码更具语义化，避免硬编码的常量值。

例如：

status = Status.SUCCESS  # 一目了然：状态是成功

相比：

status = 1  # 需要额外判断 1 是什么意义

2. 减少错误

使用Enum可以避免常见的错误，比如不小心使用了错误的值或者字符串拼写错误。Enum成员是唯一的，且不可变的，能够防止无意间改变它们的值。

比如，如果你用了Status.SUCCESS = 1，然后在后续代码中某处错误地设置了Status.SUCCESS = 2，你会收到警告或报错，而不是默默覆盖，产生潜在的 bug。

3. 类型安全

使用Enum可以确保变量的值只来自于枚举成员，而不会误用其他类型的值（如普通的数字、字符串等）。这对于大型项目来说尤其重要，因为它能有效地避免一些奇怪的 bug。

比如：

def set_color(color: Color):
    if not isinstance(color, Color):
        raise ValueError("Invalid color")

4. 易于扩展和维护

随着项目的扩展，你可能会有更多的常量值需要添加，Enum让这种扩展变得更清晰、更系统化。你不再需要在多个地方定义相同的常量，所有的常量都集中在一个地方。

比如，随着系统需求变化，你可能需要扩展交通灯的状态：

class TrafficLight(Enum):
    RED = 1
    YELLOW = 2
    GREEN = 3
    FLASHING = 4  # 新增状态

5. 集成与协作的优势

在多人开发的团队中，使用Enum可以提高协作性。它使得每个成员的代码中常量的含义更加清晰，减少误解或重复定义的问题。

6. 可迭代、可比较

Enum支持迭代、比较等操作，允许你灵活处理。例如，你可以遍历所有的Enum成员，或者比较它们的顺序。

for state in TrafficLight:
    print(state)