PyTips 0x17-Python 中的枚舉類型

Python 中的枚舉類型

枚舉類型能夠看做是一種標籤或是一系列常量的集合，一般用於表示某些特定的有限集合，例如星期、月份、狀態等。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 <enum 'WEEKDAY'>: 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'

更有趣的是 Enum 的成員均爲單例（Singleton），而且不可實例化，不可更改：

class Color(Enum):
    R = 0
    G = 1
    B = 2

try:
    Color.R = 2
except AttributeError as e:
    print(e)

Cannot reassign members.

雖然不可實例化，但能夠將枚舉成員賦值給變量：

red = Color(0)
green = Color(1)
blue = Color(2)
print(red, green, blue)

Color.R Color.G Color.B

也能夠進行比較判斷：

print(red is Color.R)
print(red == Color.R)
print(red is blue)
print(green != Color.B)
print(red == 0) # 不等於任何非本枚舉類的值

True
True
False
True
False

最後一點，因爲枚舉成員自己也是枚舉類型，所以也能夠經過枚舉成員找到其它成員：

print(red.B)
print(red.B.G.R)

Color.B
Color.R

可是要謹慎使用這一特性，由於可能與成員原有的命名空間中的名稱相沖突：

print(red.name, ':', red.value)

class Attr(Enum):
    name  = 'NAME'
    value = 'VALUE'
print(Attr.name.value, Attr.value.name)

R : 0
NAME value

總結

enum 模塊的用法很簡單，功能也很明確，可是其實現方式卻很是值得學習。若是你想更深刻了解更多 Python 中關於 Class 和 Metaclass 的黑魔法，又不知道如何入手，那麼不妨閱讀一下 enum 的源碼，或者關注接下來後面幾篇的內容！

---

歡迎關注公衆號 PyHub 每日推送