工具集

Python枚举类Enum用法详解

2019-07-29  本文已影响8人  GoPython

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

JAN 1
FEB 2
MAR 3
...
NOV 11
DEC 12

大多数人想到以下几种定义的方法:

1.直接使用定义变量的方法

jan = 1
feb = 2

2.使用字典

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

3.使用类变量

class TypeMonth:
    jan = 1
    feb = 2

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

d['jan'] = 3

TypeMonth.jan = 3

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

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

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

枚举类

简单示例:

from enum import Enum

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

print(Color.RED)
输出结果: Color.RED

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

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

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

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

Color.RED = 4

运行之后,会报错,

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

在枚举类中存在相同的 key 值也是不允许的,比如下面代码有两个相同的 RED

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

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

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

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


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

print(Color.GREEN)

输出结果:Color.RED

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

from enum import Enum
from enum import unique

@unique
class Color(Enum):
    RED = 1
    GREEN = 1
    BLUE = 3

print(Color.GREEN)

运行之后,代码会提示 ValueError

枚举的基本操作

获取枚举标签的值

Color.GREEN.value

获取枚举标签的名字

Color.GREEN.name

对枚举进行遍历

for v in Color:
    print(v)

输出结果:
Color.RED
Color.GREEN
Color.BLUE

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

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

for v in Color:
    print(v)

输出结果:
Color.RED
Color.GREEN
Color.BLUE

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

for k, v in Color.__members__.items():
    print(k, v)

输出结果:
RED Color.RED
GREEN Color.GREEN
BLUE Color.BLUE
BLACK Color.RED

枚举的比较运算

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

result = Color.RED == Color.GREEN
print(result)

输出结果: False

同时支持 is 身份比较

result = Color.RED is Color.BLACK
print(result)

输出结果: True

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

枚举之间不支持大小比较

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

result = Color.RED > Color.BLACK

枚举类型转换

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

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

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

if a == Color.RED.value:
    pass
elif a == Color.GREEN.value:
    pass

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

a = 1
print(Color(a))

输出结果:
Color.RED

总结

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

上一篇下一篇

猜你喜欢

热点阅读