[python] Python枚举模块enum总结

枚举是一种数据类型，在编程中用于表示一组相关的常量。枚举中的每个常量都有一个名称和一个对应的值，可以用于增强代码的可读性和可维护性。在Python中，枚举是由enum模块提供的，而不是Python提供专用的枚举语法。关于enum模块介绍见：enum。如需详细了解Python的enum模块，参见文章：Python enum和枚举(enum)介绍。

目录

• 1 语法介绍
• 2 参考

1 语法介绍

基础示例

# 引入 Enum 模块，用于创建枚举
from enum import Enum

# 创建一个枚举类Color，从Python内置的枚举类Enum继承
class Color(Enum):
    # 定义 RED 数值为 1
    RED = 1
    # 定义 GREEN 数值为 2
    GREEN = 2
    # 定义 BLUE 数值为 3
    BLUE = 3


col = Color.RED
# 输出Color.RED
print(col)

if col == Color.RED:
    # 判断 col 是否为 Color.RED，若是则输出 "Red"
    print("Red")

# 输出 Color 枚举类的所有成员：[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
print(list(Color))

# 判断col是否为Color类型
print(isinstance(col, Color))

# 输出 col 的类型：<enum 'Color'>
print(type(col))

# 输出 col 的字符串表示形式：<Color.RED: 1>
print(repr(col))

# 通过 Color['RED'] 获取 Color.RED
print(Color['RED'])

# 通过 Color(1) 获取 Color.RED
print(Color(1))

Color.RED
Red
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
True
<enum 'Color'>
<Color.RED: 1>
Color.RED
Color.RED

函数式API创建枚举类

# 引入枚举类型
from enum import Enum

# 使用functional API创建枚举类，定义三个枚举常量，分别为 RED, GREEN, BLUE，从数字2开始标号
Color = Enum('Color', 'RED GREEN BLUE', start=2)
# 或使用以下形式
# Color = Enum('Color', [('RED', 1), ('BLUE', 2), ('GREEN', 3)])

# 将 col 设为 GREEN
col = Color.GREEN

# 输出 col 的值：Color.GREEN
print(col)

# 比较 col 和 GREEN 是否相等，如果相等则输出 "Green"
if col == Color.GREEN:
    print("Green")

# 遍历枚举
for color in Color:
    print(color)
# 使用 name 和 value 属性获取枚举名称和值
for color in Color:
    print(color.name, color.value)

# 使用 __members__ 属性获取枚举类型 Color 中的所有枚举常量和名称
for name, member in Color.__members__.items():
    print(name, member)

Color.GREEN
Green
Color.RED
Color.GREEN
Color.BLUE
RED 2
GREEN 3
BLUE 4
RED Color.RED
GREEN Color.GREEN
BLUE Color.BLUE

自动赋值

# 导入枚举和自动赋值模块
from enum import Enum, auto

# 定义一个颜色的枚举类
class Color(Enum):
    # 自动赋值，RED 的值为 1，后面的枚举类值依次加 1
    RED = auto()
    BLUE = auto()
    GREEN = auto()

# 遍历 Color 枚举类，输出每个枚举值
for color in Color:
    print(color)

# 遍历 Color 枚举类，输出每个枚举值的名称和值
for color in Color:
    print(color.name, color.value)

Color.RED
Color.BLUE
Color.GREEN
RED 1
BLUE 2
GREEN 3

异类值

from enum import Enum

# 枚举成员的值类型可以不一样，但是非常不推荐这样做
class UserResponse(Enum):
    YES = 1
    NO = "No"
    MAYBE = "Maybe"

print(list(UserResponse))

[<UserResponse.YES: 1>, <UserResponse.NO: 'No'>, <UserResponse.MAYBE: 'Maybe'>]

混合枚举

from enum import Enum

# 通过多重继承创建支持整数比较的枚举
class Size(int, Enum):
    S = 1
    M = 2
    L = 3
    XL = 4

print(Size.S > Size.M)

False

# 实现和上述代码一样的功能
from enum import IntEnum

# 通过IntEnum创建支持整数比较的枚举
class Size(IntEnum):
    S = 1
    M = 2
    L = 3
    XL = 4

print(Size.S > Size.M)

False

强制唯一值

from enum import Enum, unique

# 当成员值不唯一，如果不添加unique装饰器，则代码运行成功，但只保留第一个出现具有相同值的成员。
# 如果添加unique，则运行报错
# @unique
class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3
    ORANGE = 3
    WHITE = 3

for color in Color:
    print(color)

Color.RED
Color.GREEN
Color.BLUE

基于位掩码的枚举类型enum.Flag

from enum import IntFlag, Flag, auto

# 创建基于位掩码的枚举类型，注意成员值为2的幂，最好不要自定义
# 如果想创建整数枚举继承IntFlag即可
class Permissions(Flag):
    READ = auto()  # 定义读权限
    WRITE = auto()  # 定义写权限
    EXECUTE = auto()  # 定义执行权限
    DELETE = auto()  # 定义删除权限

# 使用 name 和 value 属性获取枚举名称和值
# 可以看到各个成员的值是2的幂
for p in Permissions:
    print(p.name, p.value)

# 使用枚举成员
perms_rw = Permissions.READ | Permissions.WRITE  # 用户拥有读和写权限
# 可以看到perms_rw的值为3
print(perms_rw.name,perms_rw.value)

# 检查是否有某个权限
# 使用&运算符来判断一个枚举值中是否包含某个特定的枚举值
if perms_rw & Permissions.READ:  # 如果用户拥有读权限
    print("用户拥有读权限")
if perms_rw & Permissions.WRITE:  # 如果用户拥有写权限
    print("用户拥有写权限")
if perms_rw & Permissions.EXECUTE:  # 如果用户拥有执行权限
    print("用户拥有执行权限")

 # 遍历所有权限
for perm in Permissions: 
    print(perm)  

READ 1
WRITE 2
EXECUTE 4
DELETE 8
None 3
用户拥有读权限
用户拥有写权限
Permissions.READ
Permissions.WRITE
Permissions.EXECUTE
Permissions.DELETE

2 参考

• enum
• Python enum
• 枚举(enum)介绍