2. 程式人生 > >每週一個 Python 模組 | enum

每週一個 Python 模組 | enum

阿新 • • 發佈：2018-12-10

專欄地址：每週一個 Python 模組

列舉型別可以看作是一種標籤或是一系列常量的集合，通常用於表示某些特定的有限集合，例如星期、月份、狀態等。Python 的原生型別（Built-in types）裡並沒有專門的列舉型別，但是我們可以通過很多方法來實現它，例如字典、類等：

WEEKDAY = {
    'MON': 1,
    'TUS': 2,
    'WEN': 3,
    'THU': 4,
    'FRI': 5
}
class Color:
    RED   = 0
    GREEN = 1
    BLUE  = 2
複製程式碼

上面兩種方法可以看做是簡單的列舉型別的實現，如果只在區域性範圍內用到這樣的列舉變數是沒有問題的，但問題在於它們都是可變的（mutable），也就是說可以在其它地方被修改，從而影響其正常使用：

WEEKDAY['MON'] = WEEKDAY['FRI']
print(WEEKDAY) # {'FRI': 5, 'TUS': 2, 'MON': 5, 'WEN': 3, 'THU': 4}
複製程式碼

通過類定義的列舉甚至可以例項化，變得不倫不類：

c = Color()
print(c.RED)	# 0
Color.RED = 2
print(c.RED)	# 2
複製程式碼

當然也可以使用不可變型別（immutable），例如元組，但是這樣就失去了列舉型別的本意，將標籤退化為無意義的變數：

COLOR = ('R', 'G', 'B')
print(COLOR[0], COLOR[1
 
], COLOR[2])	# R G B
複製程式碼

為了提供更好的解決方案，Python 通過 PEP 435 在 3.4 版本中添加了 enum 標準庫，3.4 之前的版本也可以通過 pip install enum 下載相容支援的庫。enum 提供了 Enum/IntEnum/unique 三個工具，用法也非常簡單，可以通過繼承 Enum/IntEnum 定義列舉型別，其中 IntEnum 限定列舉成員必須為（或可以轉化為）整數型別，而 unique 方法可以作為修飾器限定列舉成員的值不可重複。

建立列舉

通過子類化 enum 類來定義列舉，程式碼如下：

import enum


class
 
 BugStatus(enum.Enum):

    new = 7
    incomplete = 6
    invalid = 5
    wont_fix = 4
    in_progress = 3
    fix_committed = 2
    fix_released = 1


print('\nMember name: {}'.format(BugStatus.wont_fix.name))
print('Member value: {}'.format(BugStatus.wont_fix.value))

# output
# Member name: wont_fix
# Member value: 4
複製程式碼

在解析 Enum 類時，會將每個成員轉換成例項，每個例項都有 name 和 value 屬性，分別對應成員的名稱和值。

迭代列舉

直接看程式碼：

import enum


class BugStatus(enum.Enum):

    new = 7
    incomplete = 6
    invalid = 5
    wont_fix = 4
    in_progress = 3
    fix_committed = 2
    fix_released = 1


for status in BugStatus:
    print('{:15} = {}'.format(status.name, status.value))
    
# output
# new             = 7
# incomplete      = 6
# invalid         = 5
# wont_fix        = 4
# in_progress     = 3
# fix_committed   = 2
# fix_released    = 1
複製程式碼

成員按照在類中的定義順序生成。

比較列舉

由於列舉成員未被排序，因此它們僅支援通過 is 和 == 進行比較。

import enum


class BugStatus(enum.Enum):

    new = 7
    incomplete = 6
    invalid = 5
    wont_fix = 4
    in_progress = 3
    fix_committed = 2
    fix_released = 1


actual_state = BugStatus.wont_fix
desired_state = BugStatus.fix_released

print('Equality:',
      actual_state == desired_state,
      actual_state == BugStatus.wont_fix)
print('Identity:',
      actual_state is desired_state,
      actual_state is BugStatus.wont_fix)
print('Ordered by value:')
try:
    print('\n'.join('  ' + s.name for s in sorted(BugStatus)))
except TypeError as err:
    print('  Cannot sort: {}'.format(err))
    
# output
# Equality: False True
# Identity: False True
# Ordered by value:
#   Cannot sort: '<' not supported between instances of 'BugStatus' and 'BugStatus'
複製程式碼

大小比較引發 TypeError 異常。

繼承 IntEnum 類建立的列舉類，成員間支援大小比較，程式碼如下：

import enum


class BugStatus(enum.IntEnum):

    new = 7
    incomplete = 6
    invalid = 5
    wont_fix = 4
    in_progress = 3
    fix_committed = 2
    fix_released = 1


print('Ordered by value:')
print('\n'.join('  ' + s.name for s in sorted(BugStatus)))

# output
# Ordered by value:
#   fix_released
#   fix_committed
#   in_progress
#   wont_fix
#   invalid
#   incomplete
#   new
複製程式碼

唯一列舉值

具有相同值的列舉成員將作為對同一成員物件的別名引用，在迭代過程中，不會被打印出來。

import enum


class BugStatus(enum.Enum):

    new = 7
    incomplete = 6
    invalid = 5
    wont_fix = 4
    in_progress = 3
    fix_committed = 2
    fix_released = 1

    by_design = 4
    closed = 1


for status in BugStatus:
    print('{:15} = {}'.format(status.name, status.value))

print('\nSame: by_design is wont_fix: ',
      BugStatus.by_design is BugStatus.wont_fix)
print('Same: closed is fix_released: ',
      BugStatus.closed is BugStatus.fix_released)

# output
# new             = 7
# incomplete      = 6
# invalid         = 5
# wont_fix        = 4
# in_progress     = 3
# fix_committed   = 2
# fix_released    = 1
# 
# Same: by_design is wont_fix:  True
# Same: closed is fix_released:  True
複製程式碼

因為 by_design 和 closed 是其他成員的別名，所以沒有被列印。在列舉中，第一個出現的值是有效的。

如果想讓每一個成員都有唯一值，可以使用 @unique 裝飾器。

import enum


@enum.unique
class BugStatus(enum.Enum):

    new = 7
    incomplete = 6
    invalid = 5
    wont_fix = 4
    in_progress = 3
    fix_committed = 2
    fix_released = 1

    # This will trigger an error with unique applied.
    by_design = 4
    closed = 1
    
# output
# Traceback (most recent call last):
#   File "enum_unique_enforce.py", line 11, in <module>
#     class BugStatus(enum.Enum):
#   File ".../lib/python3.6/enum.py", line 834, in unique
#     (enumeration, alias_details))
# ValueError: duplicate values found in <enum 'BugStatus'>:
# by_design -> wont_fix, closed -> fix_released
複製程式碼

如果成員中有重複值，會有 ValueError 的報錯。

以程式設計方式建立列舉

在一些情況下，通過程式設計的方式建立列舉，比直接在類中硬編碼更方便。如果採用這種方式，還可以傳遞成員的 name 和 value 到類的建構函式。

import enum


BugStatus = enum.Enum(
    value='BugStatus',
    names=('fix_released fix_committed in_progress '
           'wont_fix invalid incomplete new'),
)

print('Member: {}'.format(BugStatus.new))

print('\nAll members:')
for status in BugStatus:
    print('{:15} = {}'.format(status.name, status.value))
    
# output
# Member: BugStatus.new
# 
# All members:
# fix_released    = 1
# fix_committed   = 2
# in_progress     = 3
# wont_fix        = 4
# invalid         = 5
# incomplete      = 6
# new             = 7
複製程式碼

引數 value代表列舉的名稱，names 表示成員。如果給 name 傳遞的引數是字串，那麼會對這個字串從空格和逗號處進行拆分，將拆分後的單個字串作為成員的名稱，然後再對其賦值，從 1 開始，以此類推。

為了更好地控制與成員關聯的值， names可以使用元組或將名稱對映到值的字典替換字串。什麼意思，看下面的程式碼：

import enum


BugStatus = enum.Enum(
    value='BugStatus',
    names=[
        ('new', 7),
        ('incomplete', 6),
        ('invalid', 5),
        ('wont_fix', 4),
        ('in_progress', 3),
        ('fix_committed', 2),
        ('fix_released', 1),
    ],
)

print('All members:')
for status in BugStatus:
    print('{:15} = {}'.format(status.name, status.value))
    
# output
# All members:
# new             = 7
# incomplete      = 6
# invalid         = 5
# wont_fix        = 4
# in_progress     = 3
# fix_committed   = 2
# fix_released    = 1
複製程式碼

在這裡例子中，names 是一個列表，列表中的元素是元組。

非整數成員值

列舉成員值不限於整數。實際上，任何型別的物件都可以作為列舉值。如果值是元組，則成員將作為單獨的引數傳遞給__init__()。

import enum


class BugStatus(enum.Enum):

    new = (7, ['incomplete', 'invalid', 'wont_fix', 'in_progress'])
    incomplete = (6, ['new', 'wont_fix'])
    invalid = (5, ['new'])
    wont_fix = (4, ['new'])
    in_progress = (3, ['new', 'fix_committed'])
    fix_committed = (2, ['in_progress', 'fix_released'])
    fix_released = (1, ['new'])

    def __init__(self, num, transitions):
        self.num = num
        self.transitions = transitions

    def can_transition(self, new_state):
        return new_state.name in self.transitions


print('Name:', BugStatus.in_progress)
print('Value:', BugStatus.in_progress.value)
print('Custom attribute:', BugStatus.in_progress.transitions)
print('Using attribute:', BugStatus.in_progress.can_transition(BugStatus.new))

# output
# Name: BugStatus.in_progress
# Value: (3, ['new', 'fix_committed'])
# Custom attribute: ['new', 'fix_committed']
# Using attribute: True
複製程式碼

在此示例中，每個成員值是一個元組，其中包含數字和列表。

對於更復雜的情況，元組可能就不那麼方便了。由於成員值可以是任何型別的物件，因此如果有大量需要鍵值對資料結構的列舉值場景，字典就派上用場了。

import enum


class BugStatus(enum.Enum):

    new = {
        'num': 7,
        'transitions': [
            'incomplete',
            'invalid',
            'wont_fix',
            'in_progress',
        ],
    }
    incomplete = {
        'num': 6,
        'transitions': ['new', 'wont_fix'],
    }
    invalid = {
        'num': 5,
        'transitions': ['new'],
    }
    wont_fix = {
        'num': 4,
        'transitions': ['new'],
    }
    in_progress = {
        'num': 3,
        'transitions': ['new', 'fix_committed'],
    }
    fix_committed = {
        'num': 2,
        'transitions': ['in_progress', 'fix_released'],
    }
    fix_released = {
        'num': 1,
        'transitions': ['new'],
    }

    def __init__(self, vals):
        self.num = vals['num']
        self.transitions = vals['transitions']

    def can_transition(self, new_state):
        return new_state.name in self.transitions


print('Name:', BugStatus.in_progress)
print('Value:', BugStatus.in_progress.value)
print('Custom attribute:', BugStatus.in_progress.transitions)
print('Using attribute:', BugStatus.in_progress.can_transition(BugStatus.new))

# output
# Name: BugStatus.in_progress
# Value: (3, ['new', 'fix_committed'])
# Custom attribute: ['new', 'fix_committed']
# Using attribute: True
複製程式碼

這個例子和上面用元組是等價的。

相關文件：

pymotw.com/3/enum/inde…

python.jobbole.com/84112/

相關推薦

每週一個 Python 模組 | enum

專欄地址：每週一個 Python 模組 列舉型別可以看作是一種標籤或是一系列常量的集合，通常用於表示某些特定的有限集合，例如星期、月份、狀態等。Python 的原生型別（Built-in types）裡並沒有專門的列舉型別，但是我們可以通過很多方法來實現它，例如字典、類等： WEEKDAY = {

每週一個 Python 模組 | functools

functools 是 Python 中很簡單但也很重要的模組，主要是一些 Python 高階函式相關的函式。 該模組的內容並不多，看 官方文件 也就知道了。 說到高階函式，這是函數語言程式設計正規化中很重要的一個概念，簡單地說， 就是一個可以接受函式作為引數或者以函式作為返回值的函式，因為 Python

每週一個 Python 模組 | itertools

系列文章列表： 每週一個 Python 模組 | functools Python 標準庫模組 itertools 提供了很多方便靈活的迭代器工具，熟練的運用可以極大的提高工作效率。 無限迭代器 itertools.count count(start=0, step=1) 複製程式碼 建立一個迭代器，

每週一個 Python 模組 | unittest

專欄地址：每週一個 Python 模組 unittest 是 Python 自帶的單元測試框架，可以用來作自動化測試框架的用例組織執行。 優點：提供用例組織與執行方法；提供比較方法；提供豐富的日誌、清晰的報告。 unittest 核心工作原理 unittest 中最核心的部分是：TestFixture

每週一個 Python 模組 | signal

專欄地址：每週一個 Python 模組 訊號是 Unix 系統中常見的一種程序間通訊方式（IPC），例如我們經常操作的 kill -9 pid，這裡的 -9對應的就是 SIGKILL 訊號，9 就是這個訊號的編號，SIGKILL 是它的名稱。 由於不同版本的 *nux 的實現會有差異，具體請參照系統 API

每週一個 Python 模組 | bisect

專欄地址：每週一個 Python 模組 bisect 模組，用於維護有序列表。實現了一個演算法用於插入元素到有序列表。在一些情況下，這比反覆排序列表或構造一個大的列表再排序的效率更高。Bisect 是二分法的意思，這裡使用二分法來排序，它會將一個元素插入到一個有序列表的合適位置，這使得不需要每次呼叫 sor

每週一個 Python 模組 | Queue

專欄地址：每週一個 Python 模組 Queue 是 Python 標準庫中的執行緒安全的佇列（FIFO）實現，提供了一個適用於多執行緒程式設計的先進先出的資料結構，即佇列，用來在生產者和消費者執行緒之間的資訊傳遞。 有一點需要注意，Python2 中模組名是 Queue，而 Python3 是 que

每週一個 Python 模組 | copy

專欄地址：每週一個 Python 模組 copy 模組包括兩個功能，copy() 和 deepcopy()，用於複製現有物件。 淺拷貝 copy() 建立的淺表副本是一個新容器，是對原始物件內容的引用。 import copy import functools @functools.total_o

如何在Linux系統下把一個python模組轉換成一個rpm安裝包

這樣做的目的一方面是解決那些不能訪問外網的主機安裝這些python模組的問題，另一方面是可以提高特定python模組的部署效率。 下文是根據使用需求，將一個python2.7使用的mysql-python模組製作為一個rpm安裝包，作為示例。類似的步驟可以在變換fpm選項引

Python的 enum 模組原始碼分析

成員名不允許重複 這部分我的第一個想法是去控制 __dict__ 中的 key 。但這樣的方式並不好， __dict__ 範圍大，它包含該類的所有屬性和方法。而不單單是列舉的名稱空間。我在原始碼中發現 enum 使用另一個方法。通過 __prep

如何看一個python的模組是否安裝了

pip list pip freeze pip show <module_name> pip search <module_name>   How to know if a python module is installed or not in the syste

Python開發學習寫出第一個Python程序

Python編程語言 Python開發學習 目標：了解Python，了解Python的特征，了解Python的應用，掌握Linux下Python開發環境的搭建，理解Windows下Python環境搭建，寫出第一個Python程序。 什麽是Python 一種解釋型的、面向對象的、帶有動態語義

最近開始努力學python 寫了一個python小代碼：判斷一個登陸程序，如果賬號密碼輸錯3次，鎖定賬號無法再登陸

登陸 readlines 輸入 連續 nbsp 努力 一個 取數據 lis 1 count = 0 2 username = ‘zhangsan‘ 3 userpassword = ‘111111‘ 4 5 f = open(‘lock.txt‘,‘r+‘

第一個PYTHON程序

問題 python3 標準 pytho 支持 hello print 現在 計算 　　學習PYTHON快一個月了，現在來補補入門標準程序Hello world! 這大概就是學習各種計算機語言的入學儀式。PYTHON寫起來特別簡單。如下所示： print(

2016年終總結--一個Python程序猿的跨界之旅

hbase 在家 年終 oop 的確 高性能 view sql 設計 時間過得真快。感覺15年年終總結剛寫完，16年就結束了。看了blog，16年就寫了可憐的8篇，對我來說16年還算順風順水。真正可能出乎意料的是年底我離開了呆了2年半的龍圖遊戲，臨時放棄

我的第一個Python小程序

接收 bigger all 類型 pre author code ger 知識點 猜年齡，如果大了提示小點，如果小了，提示大點 涉及的知識點： 1、變量 2、註釋 3、接收交互式的輸入 4、類型轉換 5、while循環 6、if..elif..else多條件分支語句 #

我的第一個python web開發框架（2）——一個簡單的小外包

span 技術 進行 target 最好 自己 blog height 描述 　　第一部分說明 　　第一部分大概有20來章，主要講的是一些開發常識、開發前中後期準備內容、開發環境與服務器部署環境安裝設置、python基礎框架結構與功能等內容，代碼會比較簡單。 　　

我的第一個python web開發框架（4）——數據庫結構設計與創建

數據結構 描述 分析器 設置 一個 由於 logs 記錄 開發框架 　　小白做好前端html設計後，馬上開始進入數據庫結構設計步驟。 　　 　　在開始之前，小白回憶了一下老大在公司裏培訓時講過的數據庫設計解說： 　　對於初學者來說，很多拿到原型時不知道怎麽設計數據表結

我的第一個python web開發框架（5）——開發前準備工作（了解編碼前需要知道的一些常識）

turn 框架 strong pep8 加密與解密 python開發 lan 二次 沒有 　　中午吃飯時間到了，小白趕緊向老菜坐的位置走過去。 　　小白：老大，中午請你吃飯。 　　老菜：哈哈...又遇到問題了吧，這次得狠狠宰你一頓才行。 　　小白：行行行，只要您賞臉，

Day1:第一個python小程序

col rip 3.6.2 寫代碼 技術分享 spa 選項 emp win Day1:第一個python小程序與開發工具Pycharm 一、Hello World C:\Users\wenxh>python Python 3.6.2 (v3.6.2:5fd33b5,