Python 枚举类型 Enum

纵饮孤独 提交于 2020-11-21 09:29:43

实际开发中,我们离不开定义各种类型,当我们需要定义类型时,一般是通过一组整数来定义。比如:定义不同的月份

1JAN 1
2FEB 2
3MAR 3
4...
5NOV 11
6DEC 12

一般会想到以下几种定义的方法:
1.直接使用定义变量的方法

1jan = 1
2feb = 2

2.使用字典

1d = {"jan"1"feb"2}

3.使用类变量

1class TypeMonth:
2    jan = 1
3    feb = 2

对于表示月份的数字或者其他类型,一旦定义之后就不需要作改变!但是以上几种定义的方法,都能轻易的对类型的值进行改变,比如:

1d['jan'] = 3
2
3TypeMonth.jan = 3

这在实际开发中是不严谨的,也不安全,是不可取的。
同时,以上几种方法都会出现不同的类型 key,相同值的情况。

1d = {"jan"1"feb"2"mar"2}

对于这种情况,在 Python3.4 之后,给我们增加了枚举类,枚举类型可以看作是一种标签或是一系列常量的集合,通常用于表示某些特定的有限集合,例如星期、月份、状态等

枚举类

简单示例:

1from enum import Enum
2
3class Color(Enum):
4    RED = 1
5    GREEN = 2
6    BLUE = 3
7
8print(Color.RED)
9输出结果: Color.RED

上面的代码创建了一个基本的枚举示例,与我们普通类不同,它继承 Enum 这个类。同时使用类获取属性的时候,输出的不是它的数值,而是会显示枚举项。这样更能增加代码的可读性。

对比普通的类,它有以下优势:

不允许在类外直接修改枚举项的值。

我们可以尝试修改枚举中标签的值,

1Color.RED = 4

运行之后,会报错,

不存在 key 相同的枚举项(类变量)

在枚举类中存在相同的 key 值也是不允许的

1class Color(Enum):
2    RED = 1
3    RED = 1
4    GREEN = 2
5    BLUE = 3

运行之后,会提示类型错误。

枚举可以相同的值,但是值相同的各项 Key 都会当做别名

在枚举类中,可以有相同值,但是后面的枚举项都是第一个的别名

1class Color(Enum):
2    RED = 1
3    GREEN = 1
4    BLUE = 3
5
6print(Color.GREEN)
7
8输出结果:Color.RED

从结果中可以看到,输出的是 Color.RED 这个类型,而不是 Color.GREEN。
如果你不想让枚举类中有相同的 value 值,Enum 也提供了的相应的处理方法

 1from enum import Enum
2from enum import unique
3
4@unique
5class Color(Enum):
6    RED = 1
7    GREEN = 1
8    BLUE = 3
9
10print(Color.GREEN)

运行之后,代码会提示 ValueError

枚举的基本操作

获取枚举标签的值

1Color.GREEN.value

获取枚举标签的名字

1Color.GREEN.name

对枚举进行遍历

1for v in Color:
2    print(v)
3
4输出结果:
5Color.RED
6Color.GREEN
7Color.BLUE

对于有相同 value 值的枚举类进行遍历

 1class Color(Enum):
2    RED = 1
3    GREEN = 2
4    BLUE = 3
5    BLACK = 1
6
7for v in Color:
8    print(v)
9
10输出结果:
11Color.RED
12Color.GREEN
13Color.BLUE

可以看到,相同值的标签名称不会被输出。如果要输出,要使用以下方法遍历

1for k, v in Color.__members__.items():
2    print(k, v)
3
4输出结果:
5RED Color.RED
6GREEN Color.GREEN
7BLUE Color.BLUE
8BLACK Color.RED

枚举的比较运算

枚举之间可以进行等值比较

1result = Color.RED == Color.GREEN
2print(result)
3
4输出结果: False

同时支持 is 身份比较

1result = Color.RED is Color.BLACK
2print(result)
3
4输出结果: True

因为 RED 和 BLACK 的 value 值是相等的

枚举之间不支持大小比较

枚举之间不支持 '>' 或 '<' 比较,比如下面的代码就会报错

1result = Color.RED > Color.BLACK

枚举类型转换

枚举最大的好处,就是增加了我们代码的可读性

1if a ==1:
2  pass
3elif a == 2:
4  pass

上面代码可读性就很差,因为我们并不知道 1、2 所代表的含义。但是如果有枚举类就不一样了。

1if a == Color.RED.value:
2    pass
3elif a == Color.GREEN.value:
4    pass

相比第一份代码,后面的代码可读性就好很多了。那么如果我们怎么将枚举的值转换成枚举名称呢?
比如 a = 1,直接将该变量传入枚举类即可

1a = 1
2print(Color(a))
3
4输出结果:
5Color.RED

总结

1.枚举类不能用来实例化对象
2.访问枚举类中的某一项,直接使用类名访问加上要访问的项即可,比如 color.RED
3.枚举类里面定义的 Key = Value,在类外部不能修改 Value 值
4.枚举项可以用来比较,使用 ==,或者 is
5.枚举类中的 Key 不能相同,Value 可以相同,但是 Value 相同的各项 Key 都会当做别名
6.枚举类可以用 for 进行遍历,members.items() 可以遍历出含有别名的类
7.如果要枚举类中的 key 也不能相同,需要导入 unique 对枚举类进行装饰

扫描加关注

本文分享自微信公众号 - Python编程与实战(GoPy1024)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!