列舉是一種資料型別，在程式設計中用於表示一組相關的常數。列舉中的每個常數都有一個名稱和一個對應的值，可以用於增強程式碼的可讀性和可維護性。在Python中，列舉是由enum模組提供的，而不是Python提供專用的列舉語法。關於enum模組介紹見：enum。如需詳細瞭解Python的enum模組，參見文章：Python enum和列舉(enum)介紹。

1 語法介紹

基礎範例

# 引入 Enum 模組，用於建立列舉
from enum import Enum

# 建立一個列舉類Color，從Python內建的列舉類Enum繼承
class Color(Enum):
    # 定義 RED 數值為 1
    RED = 1
    # 定義 GREEN 數值為 2
    GREEN = 2
    # 定義 BLUE 數值為 3
    BLUE = 3


col = Color.RED
# 輸出Color.RED
print(col)

if col == Color.RED:
    # 判斷 col 是否為 Color.RED，若是則輸出 "Red"
    print("Red")

# 輸出 Color 列舉類的所有成員：[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
print(list(Color))

# 判斷col是否為Color型別
print(isinstance(col, Color))

# 輸出 col 的型別：<enum 'Color'>
print(type(col))

# 輸出 col 的字串表示形式：<Color.RED: 1>
print(repr(col))

# 通過 Color['RED'] 獲取 Color.RED
print(Color['RED'])

# 通過 Color(1) 獲取 Color.RED
print(Color(1))

Color.RED
Red
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
True
<enum 'Color'>
<Color.RED: 1>
Color.RED
Color.RED

函數式API建立列舉類

# 引入列舉型別
from enum import Enum

# 使用functional API建立列舉類，定義三個列舉常數，分別為 RED, GREEN, BLUE，從數位2開始標號
Color = Enum('Color', 'RED GREEN BLUE', start=2)
# 或使用以下形式
# Color = Enum('Color', [('RED', 1), ('BLUE', 2), ('GREEN', 3)])

# 將 col 設為 GREEN
col = Color.GREEN

# 輸出 col 的值：Color.GREEN
print(col)

# 比較 col 和 GREEN 是否相等，如果相等則輸出 "Green"
if col == Color.GREEN:
    print("Green")

# 遍歷列舉
for color in Color:
    print(color)
# 使用 name 和 value 屬性獲取列舉名稱和值
for color in Color:
    print(color.name, color.value)

# 使用 __members__ 屬性獲取列舉型別 Color 中的所有列舉常數和名稱
for name, member in Color.__members__.items():
    print(name, member)

Color.GREEN
Green
Color.RED
Color.GREEN
Color.BLUE
RED 2
GREEN 3
BLUE 4
RED Color.RED
GREEN Color.GREEN
BLUE Color.BLUE

自動賦值

# 匯入列舉和自動賦值模組
from enum import Enum, auto

# 定義一個顏色的列舉類
class Color(Enum):
    # 自動賦值，RED 的值為 1，後面的列舉類值依次加 1
    RED = auto()
    BLUE = auto()
    GREEN = auto()

# 遍歷 Color 列舉類，輸出每個列舉值
for color in Color:
    print(color)

# 遍歷 Color 列舉類，輸出每個列舉值的名稱和值
for color in Color:
    print(color.name, color.value)

Color.RED
Color.BLUE
Color.GREEN
RED 1
BLUE 2
GREEN 3

異類值

from enum import Enum

# 列舉元的值型別可以不一樣，但是非常不推薦這樣做
class UserResponse(Enum):
    YES = 1
    NO = "No"
    MAYBE = "Maybe"

print(list(UserResponse))

[<UserResponse.YES: 1>, <UserResponse.NO: 'No'>, <UserResponse.MAYBE: 'Maybe'>]

混合列舉

from enum import Enum

# 通過多重繼承建立支援整數比較的列舉
class Size(int, Enum):
    S = 1
    M = 2
    L = 3
    XL = 4

print(Size.S > Size.M)

False

# 實現和上述程式碼一樣的功能
from enum import IntEnum

# 通過IntEnum建立支援整數比較的列舉
class Size(IntEnum):
    S = 1
    M = 2
    L = 3
    XL = 4

print(Size.S > Size.M)

False

強制唯一值

from enum import Enum, unique

# 當成員值不唯一，如果不新增unique裝飾器，則程式碼執行成功，但只保留第一個出現具有相同值的成員。
# 如果新增unique，則執行報錯
# @unique
class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3
    ORANGE = 3
    WHITE = 3

for color in Color:
    print(color)

Color.RED
Color.GREEN
Color.BLUE

基於位掩碼的列舉型別enum.Flag

from enum import IntFlag, Flag, auto

# 建立基於位掩碼的列舉型別，注意成員值為2的冪，最好不要自定義
# 如果想建立整數列舉繼承IntFlag即可
class Permissions(Flag):
    READ = auto()  # 定義讀許可權
    WRITE = auto()  # 定義寫許可權
    EXECUTE = auto()  # 定義執行許可權
    DELETE = auto()  # 定義刪除許可權

# 使用 name 和 value 屬性獲取列舉名稱和值
# 可以看到各個成員的值是2的冪
for p in Permissions:
    print(p.name, p.value)

# 使用列舉元
perms_rw = Permissions.READ | Permissions.WRITE  # 使用者擁有讀和寫許可權
# 可以看到perms_rw的值為3
print(perms_rw.name,perms_rw.value)

# 檢查是否有某個許可權
# 使用&運運算元來判斷一個列舉值中是否包含某個特定的列舉值
if perms_rw & Permissions.READ:  # 如果使用者擁有讀許可權
    print("使用者擁有讀許可權")
if perms_rw & Permissions.WRITE:  # 如果使用者擁有寫許可權
    print("使用者擁有寫許可權")
if perms_rw & Permissions.EXECUTE:  # 如果使用者擁有執行許可權
    print("使用者擁有執行許可權")

 # 遍歷所有許可權
for perm in Permissions: 
    print(perm)

READ 1
WRITE 2
EXECUTE 4
DELETE 8
None 3
使用者擁有讀許可權
使用者擁有寫許可權
Permissions.READ
Permissions.WRITE
Permissions.EXECUTE
Permissions.DELETE

[python] Python列舉模組enum總結

1 語法介紹

2 參考