Python枚举类定义和使用

深碍√TFBOYSˉ_ 2023-10-07 23:09 50阅读 0赞

![6160441d40f045cd7d067fcbe33b2e55.png][]

一些具有特殊含义的类，其实例化对象的个数往往是固定的，比如用一个类表示月份，则该类的实例对象最多有 12 个；再比如用一个类表示季节，则该类的实例化对象最多有 4 个。

针对这种特殊的类，Python 3.4 中新增加了 Enum 枚举类。也就是说，对于这些实例化对象个数固定的类，可以用枚举类来定义。

例如，下面程序演示了如何定义一个枚举类：

from enum import Enum
    classColor(Enum):
    # 为序列值指定value值
        red =1
        green =2
        blue =3

如果想将一个类定义为枚举类，只需要令其继承自 enum 模块中的 Enum 类即可。例如在上面程序中，Color 类继承自 Enum 类，则证明这是一个枚举类。

在 Color 枚举类中，red、green、blue 都是该类的成员（可以理解为是类变量）。注意，枚举类的每个成员都由 2 部分组成，分别为 name 和 value，其中 name 属性值为该枚举值的变量名（如 red），value 代表该枚举值的序号（序号通常从 1 开始）。

和普通类的用法不同，枚举类不能用来实例化对象，但这并不妨碍我们访问枚举类中的成员。访问枚举类成员的方式有多种，例如以 Color 枚举类为例，在其基础上添加如下代码：

#调用枚举成员的 3 种方式
    print(Color.red)
    print(Color['red'])
    print(Color(1))
    #调取枚举成员中的 value 和 name
    print(Color.red.value)
    print(Color.red.name)
    #遍历枚举类中所有成员的 2 种方式
    for color in Color:
    print(color)

程序输出结果为：

> Color.red  
> Color.red  
> Color.red  
> 1  
> red  
> Color.red  
> Color.green  
> Color.blue

枚举类成员之间不能比较大小，但可以用 == 或者 is 进行比较是否相等，例如：

print(Color.red == Color.green)
    print(Color.red.name is Color.green.name)

输出结果为：

> Flase  
> Flase

需要注意的是，枚举类中各个成员的值，不能在类的外部做任何修改，也就是说，下面语法的做法是错误的：

Color.red =4

除此之外，该枚举类还提供了一个 \_\_members\_\_ 属性，该属性是一个包含枚举类中所有成员的字典，通过遍历该属性，也可以访问枚举类中的各个成员。例如：

for name,member in Color.__members__.items():
    print(name,"->",member)

输出结果为：

> red -> Color.red  
> green -> Color.green  
> blue -> Color.blue

值得一提的是，Python 枚举类中各个成员必须保证 name 互不相同，但 value 可以相同，举个例子：

from enum import Enum
    
    classColor(Enum):
    # 为序列值指定value值
        red =1
        green =1
        blue =3
    print(Color['green'])

输出结果为：

> Color.red

可以看到，Color 枚举类中 red 和 green 具有相同的值（都是 1），Python 允许这种情况的发生，它会将 green 当做是 red 的别名，因此当访问 green 成员时，最终输出的是 red。

在实际编程过程中，如果想避免发生这种情况，可以借助 @unique 装饰器，这样当枚举类中出现相同值的成员时，程序会报 ValueError 错误。例如：

#引入 unique
    from enum import Enum,unique
    #添加 unique 装饰器
    @unique
    classColor(Enum):
    # 为序列值指定value值
        red =1
        green =1
        blue =3
    print(Color['green'])

运行程序会报错：

> Traceback (most recent call last):  
>  File "D:\\python3.6\\demo.py", line 3, in <module>  
>  class Color(Enum):  
>  File "D:\\python3.6\\lib\\enum.py", line 834, in unique  
>  (enumeration, alias\_details))  
> ValueError: duplicate values found in <enum 'Color'>: green -> red

除了通过继承 Enum 类的方法创建枚举类，还可以使用 Enum() 函数创建枚举类。例如：

from enum import Enum
    #创建一个枚举类
    Color =Enum("Color",('red','green','blue'))
    
    #调用枚举成员的 3 种方式
    print(Color.red)
    print(Color['red'])
    print(Color(1))
    #调取枚举成员中的 value 和 name
    print(Color.red.value)
    print(Color.red.name)
    #遍历枚举类中所有成员的 2 种方式
    for color in Color:
    print(color)

Enum() 函数可接受 2 个参数，第一个用于指定枚举类的类名，第二个参数用于指定枚举类中的多个成员。

如上所示，仅通过一行代码，即创建了一个和前面的 Color 类相同的枚举类。运行程序，其输出结果为：

> Color.red  
> Color.red  
> Color.red  
> 1  
> red  
> Color.red  
> Color.green  
> Color.blue

[6160441d40f045cd7d067fcbe33b2e55.png]: https://img-blog.csdnimg.cn/img_convert/6160441d40f045cd7d067fcbe33b2e55.png