当前位置：日志文章 > 详细内容

Python枚举(enum)模块使用的全面指南

2025年07月30日 • Python •

一、为什么需要枚举？1. 传统常量的局限性# 传统方式定义常量red = 1green = 2blue = 3def print_color(color): if color == red:

一、为什么需要枚举？

1. 传统常量的局限性

# 传统方式定义常量
red = 1
green = 2
blue = 3

def print_color(color):
    if color == red:
        print("红色")
    elif color == green:
        print("绿色")
    elif color == blue:
        print("蓝色")

# 问题：
print_color(1)      # 正确
print_color(100)    # 错误但不会报错

2. 枚举的优势

类型安全：防止无效值
可读性强：使用名称而非魔数
易于维护：集中管理相关常量
ide 支持：自动补全和文档提示
避免冲突：自动处理值唯一性

二、基础枚举：enum

1. 创建简单枚举

from enum import enum

class color(enum):
    red = 1
    green = 2
    blue = 3

# 使用枚举
print(color.red)        # color.red
print(color.red.name)    # 'red'
print(color.red.value)   # 1

2. 枚举的比较

# 身份比较
print(color.red is color.red)  # true

# 值比较
print(color.red == 1)         # false
print(color.red.value == 1)   # true

# 等值比较
print(color.red == color.red)  # true
print(color.red == color.blue) # false

3. 遍历枚举

# 遍历所有成员
for color in color:
    print(color.name, color.value)
    
# 输出：
# red 1
# green 2
# blue 3

三、自动赋值：auto()

auto() 自动生成唯一值：

from enum import enum, auto

class direction(enum):
    north = auto()
    east = auto()
    south = auto()
    west = auto()

print(list(direction))
# [<direction.north: 1>, <direction.east: 2>, ...]

自定义自动赋值

class customauto(enum):
    def _generate_next_value_(name, start, count, last_values):
        return f"{name}_{count}"
    
    first = auto()  # 'first_1'
    second = auto() # 'second_2'

四、唯一枚举：@unique

确保所有值唯一：

from enum import enum, unique

@unique
class status(enum):
    active = 1
    inactive = 2
    # pending = 1  # 会引发 valueerror: duplicate values

五、功能枚举：intenum 和 strenum

1. intenum - 整型枚举

from enum import intenum

class httpstatus(intenum):
    ok = 200
    not_found = 404
    server_error = 500

# 可以与整数比较
print(httpstatus.ok == 200)  # true

2. strenum (python 3.11+)

from enum import strenum

class loglevel(strenum):
    debug = 'debug'
    info = 'info'
    warning = 'warning'
    error = 'error'

# 可以与字符串比较
print(loglevel.debug == 'debug')  # true

六、标志枚举：flag

用于位操作：

from enum import flag, auto

class permissions(flag):
    read = auto()     # 1
    write = auto()    # 2
    execute = auto()  # 4
    all = read | write | execute  # 7

# 使用示例
user_perms = permissions.read | permissions.write

print(permissions.read in user_perms)  # true
print(permissions.execute in user_perms)  # false

七、高级用法

1. 枚举的别名

class shape(enum):
    square = 1
    rectangle = 1  # 别名，与square相同
    
print(shape.square is shape.rectangle)  # true

2. 动态创建枚举

animal = enum('animal', 'cat dog bird')
print(list(animal))
# [<animal.cat: 1>, <animal.dog: 2>, <animal.bird: 3>]

# 带值创建
vehicle = enum('vehicle', [('car', 10), ('bus', 20), ('train', 30)])

3. 枚举方法

class planet(enum):
    mercury = (3.303e+23, 2.4397e6)
    venus   = (4.869e+24, 6.0518e6)
    
    def __init__(self, mass, radius):
        self.mass = mass
        self.radius = radius
        
    @property
    def surface_gravity(self):
        g = 6.67300e-11
        return g * self.mass / (self.radius * self.radius)

print(planet.mercury.surface_gravity)

4. 枚举的序列化

import json
from enum import enum

class color(enum):
    red = 1
    green = 2
    blue = 3

# 自定义json编码
class enumencoder(json.jsonencoder):
    def default(self, obj):
        if isinstance(obj, enum):
            return obj.name
        return super().default(obj)

# 序列化
print(json.dumps(color.red, cls=enumencoder))  # "red"

# 反序列化
def enum_decoder(dct):
    if 'color' in dct:
        dct['color'] = color[dct['color']]
    return dct

data = '{"color": "red"}'
obj = json.loads(data, object_hook=enum_decoder)
print(obj['color'])  # color.red

八、实际应用场景

1. 状态管理

class orderstatus(enum):
    pending = auto()
    processing = auto()
    shipped = auto()
    delivered = auto()
    cancelled = auto()

def update_order_status(order, new_status):
    if not isinstance(new_status, orderstatus):
        raise valueerror("invalid status")
    # 更新逻辑...

2. 配置选项

class loglevel(enum):
    debug = 10
    info = 20
    warning = 30
    error = 40

def configure_logger(level=loglevel.info):
    # 配置日志...

3. django 模型选择字段

from django.db import models
from enum import enum

class usertype(enum):
    regular = 'r'
    admin = 'a'
    guest = 'g'
    
    @classmethod
    def choices(cls):
        return [(member.value, member.name) for member in cls]

class user(models.model):
    user_type = models.charfield(
        max_length=1,
        choices=usertype.choices(),
        default=usertype.regular.value
    )

4. api 参数验证

from enum import enum
from flask import flask, abort

app = flask(__name__)

class sortorder(enum):
    asc = 'asc'
    desc = 'desc'

@app.route('/api/users')
def get_users():
    order = request.args.get('order', sortorder.asc.value)
    try:
        # 验证参数
        sort_order = sortorder(order)
    except valueerror:
        abort(400, "invalid sort order")
    
    # 处理请求...

九、枚举与替代方案对比

特性	枚举	字典	类常量
类型安全	✓	✗	✗
值唯一性	✓	✗	✗
可迭代性	✓	✓	✗
成员方法	✓	✗	✓
ide 支持	✓	✗	✗
序列化	需自定义	原生	原生
内存效率	高	中	高

十、最佳实践与常见陷阱

最佳实践：

优先使用 enum 替代魔数
使用 @unique 确保值唯一
为枚举成员添加文档字符串
使用 auto() 简化值分配
在类型提示中使用枚举

常见陷阱：

值比较而非成员比较

# 错误
if color == 1: ...

# 正确
if color == color.red: ...

动态修改枚举

color.red = 10  # 引发 attributeerror

忽略大小写

# 错误
color = color['red']  # keyerror

# 解决方法
class caseinsensitiveenum(enum):
    @classmethod
    def _missing_(cls, value):
        for member in cls:
            if member.name.lower() == value.lower():
                return member
        return none

class color(caseinsensitiveenum):
    red = 1
    green = 2

十一、性能考虑

枚举在创建时有些开销，但使用时的性能与普通类相当：

# 创建性能
%timeit enum('color', 'red green blue')
# 10000 loops, best of 5: 29.7 µs per loop

# 访问性能
class color(enum):
    red = 1
    green = 2
    blue = 3

%timeit color.red
# 10000000 loops, best of 5: 29.9 ns per loop