列舉型別可以看作是一種標籤或是一系列常量的集合,通常用於表示某些特定的有限集合,例如星期、月份、狀態等。Python 的原生型別(Built-in types)裡並沒有專門的列舉型別,但是我們可以通過很多方法來實現它,例如字典、類等:
1 2 3 4 5 6 7 8 9 10 11 |
WEEKDAY = { 'MON': 1, 'TUS': 2, 'WEN': 3, 'THU': 4, 'FRI': 5 } class Color: RED = 0 GREEN = 1 BLUE = 2 |
上面兩種方法可以看做是簡單的列舉型別的實現,如果只在區域性範圍內用到了這樣的列舉變數是沒有問題的,但問題在於它們都是可變的(mutable),也就是說可以在其它地方被修改從而影響其正常使用:
1 2 |
WEEKDAY['MON'] = WEEKDAY['FRI'] print(WEEKDAY) |
1 |
{'FRI': 5, 'TUS': 2, 'MON': 5, 'WEN': 3, 'THU': 4} |
通過類定義的列舉甚至可以例項化,變得不倫不類:
1 2 3 4 |
c = Color() print(c.RED) Color.RED = 2 print(c.RED) |
1 2 |
0 2 |
當然也可以使用不可變型別(immutable),例如元組,但是這樣就失去了列舉型別的本意,將標籤退化為無意義的變數:
1 2 |
COLOR = ('R', 'G', 'B') print(COLOR[0], COLOR[1], COLOR[2]) |
1 |
R G B |
為了提供更好的解決方案,Python 通過 PEP 435 在 3.4 版本中新增了 enum 標準庫,3.4 之前的版本也可以通過 pip install enum
下載相容支援的庫。enum
提供了 Enum
/IntEnum
/unique
三個工具,用法也非常簡單,可以通過繼承 Enum
/IntEnum
定義列舉型別,其中 IntEnum
限定列舉成員必須為(或可以轉化為)整數型別,而 unique
方法可以作為修飾器限定列舉成員的值不可重複:
1 2 3 4 5 6 7 8 9 10 11 12 |
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) |
1 |
duplicate values found in : FRI -> MON |
1 2 3 4 5 6 7 |
try: class Color(IntEnum): RED = 0 GREEN = 1 BLUE = 'b' except ValueError as e: print(e) |
1 |
invalid literal for int() with base 10: 'b' |
更有趣的是 Enum
的成員均為單例(Singleton),並且不可例項化,不可更改:
1 2 3 4 |
class Color(Enum): R = 0 G = 1 B = 2 |
1 2 3 4 |
try: Color.R = 2 except AttributeError as e: print(e) |
1 |
Cannot reassign members. |
雖然不可例項化,但可以將列舉成員賦值給變數:
1 2 3 4 |
red = Color(0) green = Color(1) blue = Color(2) print(red, green, blue) |
1 |
Color.R Color.G Color.B |
也可以進行比較判斷:
1 2 3 4 5 |
print(red is Color.R) print(red == Color.R) print(red is blue) print(green != Color.B) print(red == 0) # 不等於任何非本列舉類的值 |
1 2 3 4 5 |
True True False True False |
最後一點,由於列舉成員本身也是列舉型別,因此也可以通過列舉成員找到其它成員:
1 2 |
print(red.B) print(red.B.G.R) |
1 2 |
Color.B Color.R |
但是要謹慎使用這一特性,因為可能與成員原有的名稱空間中的名稱相沖突:
1 2 3 4 5 6 |
print(red.name, ':', red.value) class Attr(Enum): name = 'NAME' value = 'VALUE' print(Attr.name.value, Attr.value.name) |
1 2 |
R : 0 NAME value |
總結
enum
模組的用法很簡單,功能也很明確,但是其實現方式卻非常值得學習。如果你想更深入瞭解更多 Python 中關於 Class
和 Metaclass
的黑魔法,又不知道如何入手,那麼不妨閱讀一下 enum
的原始碼,或者關注接下來後面幾篇的內容!
打賞支援我寫出更多好文章,謝謝!
打賞作者
打賞支援我寫出更多好文章,謝謝!