Enum可以把一組相關常量定義在一個class中,且class不可變,而且成員可以直接比較。
py2版本需要pip安裝pip install --upgrade pip enum34
from enum import Enum
# (Enum當函數的用法)定義一個class類型Month,然后,每個常量都是class的一個唯一實例
Month = Enum('Month', ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))
#value屬性則是自動賦給成員的int常量,默認從1開始計數。
for name, member in Month.__members__.items():
print(name, '=>', member, ',', member.value)
結果如下
Jan => Month.Jan , 1
Feb => Month.Feb , 2
Mar => Month.Mar , 3
Apr => Month.Apr , 4
May => Month.May , 5
Jun => Month.Jun , 6
Jul => Month.Jul , 7
Aug => Month.Aug , 8
Sep => Month.Sep , 9
Oct => Month.Oct , 10
Nov => Month.Nov , 11
Dec => Month.Dec , 12
1. 枚舉的定義
首先,定義枚舉要導入enum模塊。
枚舉定義用class關鍵字,繼承Enum類。
用于定義枚舉的class和定義類的class是有區別【下一篇博文繼續分享】。
示例代碼:
from enum import Enum
class Color(Enum):
red = 1
orange = 2
yellow = 3
green = 4
blue = 5
indigo = 6
purple = 7
代碼分析:
上面的代碼,我們定義了顏色的枚舉Color.
顏色枚舉有7個成員,分別是Color.red、Color.orange、Color.yellow等。
每一個成員都有它們各自名稱和值,Color.red成員的名稱是:red,值是:1。
每個成員的數據類型就是它所屬的枚舉。【*注:用class定義的類,實際上就是一種類型】
1.1 定義枚舉時,成員名稱不允許重復
from enum import Enum
class Color(Enum):
red = 1
red = 2
上面的代碼,就無法執行。提示錯誤:TypeError: Attempted to reuse key: 'red'
1.2 默認情況下,不同的成員值允許相同。但是兩個相同值的成員,第二個成員的名稱被視作第一個成員的別名****
from enum import Enum
class Color(Enum):
red = 1
red_alias = 1
成員Color.red和Color.red_alias具有相同的值,那么成員Color.red_alias的名稱red_alias就被視作成員Color.red名稱red的別名。
** 1.3 如果枚舉中存在相同值的成員,在通過值獲取枚舉成員時,只能獲取到第一個成員**
from enum import Enum
class Color(Enum):
red = 1
red_alias = 1
print(Color(1))
輸出結果為:Color.red
1.4 如果要限制定義枚舉時,不能定義相同值的成員。可以使用裝飾器@unique【要導入unique模塊】
from enum import Enum, unique
@unique
class Color(Enum):
red = 1
red_alias = 1
再執行就會提示錯誤:ValueError: duplicate values found in <enum 'Color'>: red_alias -> red
2. 枚舉取值
2.1 通過成員的名稱來獲取成員
Color['red']
2.2 通過成員值來獲取成員
Color(2)
2.3 通過成員,來獲取它的名稱和值
red_member = Color.red
red_member.name
red_member.value
3. 迭代器
3.1 枚舉支持迭代器,可以遍歷枚舉成員
for color in Color:
print(color)
輸出結果是,枚舉的所有成員。
Color.red、Color.orange、Color.yellow、Color.green、Color.blue、Color.indigo、Color.purple。
3.2 如果枚舉有值重復的成員,循環遍歷枚舉時只獲取值重復成員的第一個成員
from enum import Enumclass
Color(Enum):
red = 1
orange = 2
yellow = 3
green = 4
blue = 5
indigo = 6
purple = 7
red_alias = 1
for color in Color:
print(color)
輸出結果是:
Color.red、Color.orange、Color.yellow、Color.green、Color.blue、Color.indigo、Color.purple。
但是Color.red_alias并沒有出現在輸出結果中。
3.3 如果想把值重復的成員也遍歷出來,要用枚舉的一個特殊屬性members
from enum import Enum
class Color(Enum):
red = 1
orange = 2
yellow = 3
green = 4
blue = 5
indigo = 6
purple = 7
red_alias = 1
for color in Color.__members__.items():
print(color)
輸出結果:
('red', <Color.red: 1>)、('orange', <Color.orange: 2>)、('yellow', <Color.yellow: 3>)、('green', <Color.green: 4>)、('blue', <Color.blue: 5>)、('indigo', <Color.indigo: 6>)、('purple', <Color.purple: 7>)、('red_alias', <Color.red: 1>)
4. 枚舉比較
4.1 枚舉成員可進行同一性比較
Color.red is Color.red
輸出結果是:True
Color.red is not Color.blue
輸出結果是:True
4.2 枚舉成員可進等值比較
Color.blue == Color.red
輸出結果是:False
Color.blue != Color.red
輸出結果是:True
4.3 枚舉成員不能進行大小比較
Color.red < Color.blue
輸出結果出錯:
TypeError: unorderable types: Color() < Color()