草根學Python(十一)列舉類

兩點水發表於2017-08-27

前言

雖然沒多少閱讀,可是還是堅持寫下去。對 Python 感興趣的童鞋可以加入 Python 學習討論微信群喔。可以先加我微信,然後拉進群。本人微信:

微信
微信

目錄

草根學Python(十一) 列舉類
草根學Python(十一) 列舉類

一、列舉類的使用

實際開發中,我們離不開定義常量,當我們需要定義常量時,其中一個辦法是用大寫變數通過整數來定義,例如月份:

JAN = 1
FEB = 2
MAR = 3
...
NOV = 11
DEC = 12複製程式碼

當然這樣做簡單快捷,缺點是型別是 int ,並且仍然是變數。

那有沒有什麼好的方法呢?

這時候我們定義一個 class 型別,每個常量都是 class 裡面唯一的例項。正好 Python 提供了 Enum 類來實現這個功能如下:

#!/usr/bin/env python3
# -*- coding: UTF-8 -*-

from enum import Enum

Month = Enum('Month', ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))

# 遍歷列舉型別
for name, member in Month.__members__.items():
    print(name, '---------', member, '----------', member.value)

# 直接引用一個常量
print('\n', Month.Jan)複製程式碼

輸出的結果如下:

Python3 列舉型別的使用
Python3 列舉型別的使用

可見,我們可以直接使用 Enum 來定義一個列舉類。上面的程式碼,我們建立了一個有關月份的列舉型別 Month ,這裡要注意的是構造引數,第一個引數 Month 表示的是該列舉類的類名,第二個 tuple 引數,表示的是列舉類的值;當然,列舉類通過 __members__ 遍歷它的所有成員的方法。注意的一點是 , member.value 是自動賦給成員的 int型別的常量,預設是從 1 開始的。而且 Enum 的成員均為單例(Singleton),並且不可例項化,不可更改

二、Enum 的原始碼

通過上面的例項可以知道通過 __members__ 可以遍歷列舉類的所有成員。那為什麼呢?

我們可以先來大致看看 Enum 的原始碼是如何實現的;Enum 在模組 enum.py 中,先來看看 Enum 類的片段

class Enum(metaclass=EnumMeta):
    """Generic enumeration.
    Derive from this class to define new enumerations.
    """複製程式碼

可以看到,Enum 是繼承元類 EnumMeta 的;再看看 EnumMeta 的相關片段

class EnumMeta(type):
    """Metaclass for Enum"""
    @property
    def __members__(cls):
        """Returns a mapping of member name->value.
        This mapping lists all enum members, including aliases. Note that this
        is a read-only view of the internal mapping.
        """
        return MappingProxyType(cls._member_map_)複製程式碼

首先 __members__ 方法返回的是一個包含一個 Dict 既 Map 的 MappingProxyType,並且通過 @property 將方法 __members__(cls) 的訪問方式改變為了變數的的形式,既可以直接通過 __members__ 來進行訪問了

三、自定義型別的列舉

但有些時候我們需要控制列舉的型別,那麼我們可以 Enum 派生出自定義類來滿足這種需要。通過修改上面的例子:

#!/usr/bin/env python3
# -*- coding: UTF-8 -*-
from enum import Enum, unique

Enum('Month', ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))


# @unique 裝飾器可以幫助我們檢查保證沒有重複值
@unique
class Month(Enum):
    Jan = 'January'
    Feb = 'February'
    Mar = 'March'
    Apr = 'April'
    May = 'May'
    Jun = 'June'
    Jul = 'July'
    Aug = 'August'
    Sep = 'September '
    Oct = 'October'
    Nov = 'November'
    Dec = 'December'


if __name__ == '__main__':
    print(Month.Jan, '----------',
          Month.Jan.name, '----------', Month.Jan.value)
    for name, member in Month.__members__.items():
        print(name, '----------', member, '----------', member.value)複製程式碼

輸出的結果如下:

Python3 自定義型別的列舉類
Python3 自定義型別的列舉類

通過上面的例子,可以知道列舉模組定義了具有迭代 (interator) 和比較(comparison) 功能的列舉型別。 它可以用來為值建立明確定義的符號,而不是使用具體的整數或字串。

四、列舉的比較

因為列舉成員不是有序的,所以它們只支援通過標識(identity) 和相等性 (equality) 進行比較。下面來看看 ==is 的使用:


#!/usr/bin/env python3
# -*- coding: UTF-8 -*-
from enum import Enum


class User(Enum):
    Twowater = 98
    Liangdianshui = 30
    Tom = 12


Twowater = User.Twowater
Liangdianshui = User.Liangdianshui

print(Twowater == Liangdianshui, Twowater == User.Twowater)
print(Twowater is Liangdianshui, Twowater is User.Twowater)

try:
    print('\n'.join('  ' + s.name for s in sorted(User)))
except TypeError as err:
    print(' Error : {}'.format(err))複製程式碼

輸出的結果:


False True
False True
 Error : ''>複製程式碼

可以看看最後的輸出結果,報了個異常,那是因為大於和小於比較運算子引發 TypeError 異常。也就是 Enum 類的列舉是不支援大小運算子的比較的。

那麼能不能讓列舉類進行大小的比較呢?

當然是可以的,使用 IntEnum 類進行列舉,就支援比較功能。

#!/usr/bin/env python3
# -*- coding: UTF-8 -*-
import enum


class User(enum.IntEnum):
    Twowater = 98
    Liangdianshui = 30
    Tom = 12


try:
    print('\n'.join(s.name for s in sorted(User)))
except TypeError as err:
    print(' Error : {}'.format(err))複製程式碼

看看輸出的結果:

Tom
Liangdianshui
Twowater複製程式碼

通過輸出的結果可以看到,列舉類的成員通過其值得大小進行了排序。也就是說可以進行大小的比較。

相關文章