干货 - 一文搞定Python 枚举

Python027

干货 - 一文搞定Python 枚举,第1张

enum是一组绑定到唯一常数值的符号名称,并且具备可迭代性和可比较性的特性。我们可以使用enum创建具有良好定义的标识符,而不是直接使用魔法字符串或整数,也便于开发工程师的代码维护。

我们可以使用class语法创建一个枚举类型,方便我们进行读写,另外,根据函数API的描述定义,我们可以创建一个enum的子类,如下:

enum自带属性name和value ,日常工作中使用最多的也是这两个属性,我们打印看看结果:

枚举支持迭代和遍历顺序。举个例子:

打印结果:

可以看出,遍历的每一个status是一个独立的枚举成员,拥有name和value属性。

另外,我们也可以使用如下形式来进行枚举遍历:

上 面我们创建的枚举类中, value值是可以重复的,如果我们不想枚举类中的值重复可以是用装饰器@unique ,举例如下:

我们运行后,报如下异常:

我们查看源代码,发现加入此装饰器的枚举类型, unique方法会将其__members__.items()进行遍历,追加到duplicates列表中,如果发现列表不为空,则抛出如上异常信息。

此功能用于我们在使用枚举时,只在意枚举的标识符的含义而不在意值的情况下,但是如果需要与字符串或整数混合使用就要额外注意。下面贴上官方的示例:

可以发现,使用auto()得到的是整数自增型,如果我们需要别的方式,只需要在我们的枚举类中,重写_generate_next_value_方法。

枚举对象可以进行比较,但是不能进行值比较,如果需要进行值比较则需要枚举对象继承IntEnum对象,举个例子:

上 面的测试例子当中,我们创建了两个继承类型不一样的枚举类,可以看到继承了IntEnum的Season可以进行值的比较,而继承了Enum的Part则不能进行值比较,并且IntEnum类型与Enum类型也不能进行比较,即使属性和值一样。

枚举中可以定义枚举类自身特有的方法,也可以复写一些已经在基类中定义好的方法,比如:__init__ ,__str__ , __repr__ , __hash__ , __format__等。举个例子:

上面我们定义了一个枚举类,其中value是一个枚举类型,我们可以定义__init__方法去对应元组中的值,我们也复写了__str__方法。

打印方法看看效果:

从输出结果看,我们自定义和复写的方法都已经成功的应用到了Mood类中。

不同于java中的枚举类,python中的枚举类是可以被继承的,但是被继承的枚举类规定其不能定义任何成员,但可以定义抽象方法。举例如下:

测试用例可以完美运行,我们可以发现:第一个方法中,抛出了TypeError的异常;第二个测试方法中, MoreColor继承了Color ,Color继承了Shade , 并且我们可以通过子类调用父类中的方法。

主要介绍了enum模块的基础知识,包含枚举的创建、枚举成员和属性的访问、枚举方法的创建、枚举的继承等。其中新版中的_ignore_ 、 _order_ 、 _missing_等可以学习官网的例子,另外enum的子类IntEnum 、 IntFlag 等也是我们比较常用的枚举基类,本文中简单的介绍了IntEnum , 而IntFlag相比与IntEnum多了&, |, ^, ~的操作,其他的子类大家感兴趣也可以了解。

枚举类型可以看作是一种标签或是一系列常量的集合,通常用于表示某些特定的有限集合,例如星期、月份、状态等。Python 的原生类型(Built-in types)里并没有专门的枚举类型,但是我们可以通过很多方法来实现它,例如字典、类等:

WEEKDAY = {

'MON': 1,

'TUS': 2,

'WEN': 3,

'THU': 4,

'FRI': 5

}

class Color:

RED = 0

GREEN = 1

BLUE = 2

上面两种方法可以看做是简单的枚举类型的实现,如果只在局部范围内用到了这样的枚举变量是没有问题的,但问题在于它们都是可变的(mutable),也就是说可以在其它地方被修改从而影响其正常使用:

WEEKDAY['MON'] = WEEKDAY['FRI']

print(WEEKDAY)

{'FRI': 5, 'TUS': 2, 'MON': 5, 'WEN': 3, 'THU': 4}

通过类定义的枚举甚至可以实例化,变得不伦不类:

c = Color()

print(c.RED)

Color.RED = 2

print(c.RED)

0

2

当然也可以使用不可变类型(immutable),例如元组,但是这样就失去了枚举类型的本意,将标签退化为无意义的变量:

COLOR = ('R', 'G', 'B')

print(COLOR[0], COLOR[1], COLOR[2])

R G B

为了提供更好的解决方案,Python 通过 PEP 435 在 3.4 版本中添加了 enum 标准库,3.4 之前的版本也可以通过 pip install enum 下载兼容支持的库。enum 提供了 Enum/IntEnum/unique 三个工具,用法也非常简单,可以通过继承 Enum/IntEnum 定义枚举类型,其中 IntEnum 限定枚举成员必须为(或可以转化为)整数类型,而 unique 方法可以作为修饰器限定枚举成员的值不可重复:

from enum import Enum, IntEnum, unique

try:

@unique

class WEEKDAY(Enum):

MON = 1

TUS = 2

WEN = 3

THU = 4

FRI = 1

except ValueError as e:

print(e)

duplicate values found in : FRI ->MON

try:

class Color(IntEnum):

RED = 0

GREEN = 1

BLUE = 'b'

except ValueError as e:

print(e)

invalid literal for int() with base 10: 'b'