python3 枚舉定義和使用

定義

在某些情況下，一個類的對象是有限且固定的，比如季節類，它只有 4 個對象；再比如行星類，目前只有 8 個對象。這種實例有限且固定的類，在 Python 中被稱為枚舉類。
程序有兩種方式來定義枚舉類：

1. 直接使用 Enum 列出多個枚舉值來創建枚舉類。
2. 通過繼承 Enum 基類來派生枚舉類。

使用

使用 Enum 列出多個枚舉值來創建枚舉類

如下程序示范了直接使用 Enum 列出多個枚舉值來創建枚舉類：

import enum
#定義枚舉類
Season = enum.Enum('Season', ('SPRING', 'SUMMER', 'FALL', 'WINTER'))

上面程序使用 Enum() 函數（就是 Enum 的構造方法）來創建枚舉類，該構造方法的第一個參數是枚舉類的類名；第二個參數是一個元組，用於列出所有枚舉值。

在定義了上面的 Season 枚舉類之后，程序可直接通過枚舉值進行前問，這些枚舉值都是該枚舉的成員，每個成員都有 name、value 兩個屬性，其中 name 屬性值為該枚舉值的變量名，value 代表該枚舉值的序號（序號通常從 1 開始）。

例如，如下代碼測試了枚舉成員的用法：

#直接訪問指定枚舉對象
print(Season.SPRING)

#訪問枚舉成員的變量名
print(Season.SPRING.name)

#訪問枚舉成員的值
print(Season.SPRING.value)

輸出如下：

Season.SPRING
SPRING
1

 通過繼承 Enum 基類來派生枚舉類

也可通過枚舉變量名或枚舉值來訪問指定枚舉對象。例如如下代碼：

#根據枚舉變量名訪問枚舉對象
print(Season['SUMMER'])    //輸出Season.SUMMER
 
#根據枚舉值訪問枚舉對象       //輸出Season.FALL
print(Season(3))

　　

Python 還為枚舉提供了一個 __members__ 屬性，該屬性返回一個 dict 字典，字典包含了該枚舉的所有枚舉實例。程序可通過遍歷 __members__ 屬性來訪問枚舉的所有實例。例如如下代碼：

 

#遍歷所有的成員
for name, member in Season.__members__.items():
    print(member, '--->', name,'--->', member.value)


輸出如下：
Season.SPRING ---> SPRING ---> 1
Season.SUMMER ---> SUMMER ---> 2
Season.FALL ---> FALL ---> 3
Season.WINTER ---> WINTER ---> 4

　　

如果要定義更復雜的枚舉，則可通過繼承 Enum 來派生枚舉類，在這種方式下程序就可以為枚舉額外定義方法了。例如如下程序：

import enum
class Orientation(enum.Enum):
    #為序列指定值
    EAST = '東'
    SOUTH = '南'
    WEST = '西'
    NORTH = '北'

    def info(self):
        print('這是一個定義方向為【%s】的枚舉'% self.value)

print(Orientation.SOUTH)
print(Orientation.SOUTH.value)
#通過枚舉變量訪問枚舉
print(Orientation['WEST'])

#通過枚舉值訪問枚舉
print(Orientation('北'))

#調用枚舉的info()方法
Orientation.EAST.info()

#循環遍歷Orientation枚舉的所有成員
for name, member in Orientation.__members__.items():
    print(member, '--->', name, '--->', member.value)




輸出如下：
Orientation.SOUTH
南
Orientation.WEST
Orientation.NORTH
這是一個定義方向【東】的枚舉
Orientation.EAST ---> EAST ---> 東
Orientation.SOUTH ---> SOUTH ---> 南
Orientation.WEST ---> WEST ---> 西
Orientation.NORTH ---> NORTH ---> 北

　　

 上面程序通過繼承 Enum 派生了 Orientation 枚舉類，通過這種方式派生的枚舉類既可額外定義方法，如上面的 info() 方法所示，也可為枚舉指定 value（value 的值默認是 1、2、3、…）。

雖然此時 Orientation 枚舉的 value 是由類型，但該枚舉同樣可通過 value 來訪問特定枚舉，如上面程序中的 Orientation('南')，這是完全允許的。

 

枚舉構造器

枚舉也是類，因此枚舉也可以定義構造器。為枚舉定義構造器之后，在定義枚舉實例時必須為構造器參數設置值。例如如下程序：import enum

class Gender(enum.Enum):
    MALE = '男', '陽剛之力'
    FEMALE = '女', '柔順之美'

    def __init__(self, cn_name, desc):
        self._cn_name = cn_name
        self._desc = desc

    @property
    def desc(self):
        return self._desc

    @property
    def cn_name(self):
        return self._cn_name

#訪問FEMALE的name
print('FEMALE的name:', Gender.FEMALE.name)

#訪問FEMALE的value
print('FEMALE的value:', Gender.FEMALE.value)

#訪問自定義的cn_name屬性
print('FEMALE的cn_name:', Gender.FEMALE.cn_name)

# 訪問自定義的desc屬性
print('FEMALE的desc:', Gender.FEMALE.desc)

　　

上面程序定義了 Gender 枚舉類，並為它定義了一個構造器，調用該構造器需要傳入 cn_name 和 desc 兩個參數，因此程序使用如下代碼來定義 Gender 的枚舉值。

MALE = '男', '陽剛之力'
FEMALE = '女', '柔順之美

上面代碼為 MALE 枚舉指定的 value 是‘男’和‘陽剛之力’這兩個字符串，其實它們會被自動封裝成元組后傳給 MALE 的 value 屬性；而且此處傳入的‘男’和‘陽剛之力’ 這兩個參數值正好分別傳給 cnname 和 desc 兩個參數。簡單來說，枚舉的構造器需要幾個參數，此處就必須指定幾個值。

輸出如下：

FEMALE的name: FEMALE
FEMALE的value: ('女', '柔順之美')
FEMALE的cn_name: 女
FEMALE的desc: 柔順之美