一文讀懂Python 枚舉
enum 是一組綁定到唯一常數(shù)值的符號名稱,并且具備可迭代性和可比較性的特性。我們可以使用 enum 創(chuàng)建具有良好定義的標(biāo)識符,而不是直接使用魔法字符串或整數(shù),也便于開發(fā)工程師的代碼維護(hù)。
創(chuàng)建枚舉
我們可以使用 class 語法創(chuàng)建一個枚舉類型,方便我們進(jìn)行讀寫,另外,根據(jù)函數(shù) API 的描述定義,我們可以創(chuàng)建一個 enum 的子類,如下:
from enum import Enum class HttpStatus(Enum): OK = 200 BAD_REQUEST = 400 FORBIDDEN = 403 NOT_FOUND = 404 REQUEST_TIMEOUT = 408 SERVICE_UNAVAILABLE = 500
注意: 枚舉屬性值可以是任何東西: int, str 等。如果確切的值不重要,您可以使用 auto 實例,并為您選擇適當(dāng)?shù)闹怠H绻鷮?auto 與其他值混合,則必須小心。 枚舉類型中,不可以設(shè)置相同名稱的 name,可以有相同的 value。
enum 自帶屬性 name 和 value,日常工作中使用最多的也是這兩個屬性,我們打印看看結(jié)果:
print('Member: {}'.format(HttpStatus.OK)) # Member: HttpStatus.OK
print('Member name: {}'.format(HttpStatus.OK.name)) # Member name: OK
print('Member value: {}'.format(HttpStatus.OK.value)) # Member value: 200
print(repr(HttpStatus.OK)) # <enum 'HttpStatus'>
print(type(HttpStatus.OK)) # <HttpStatus.OK: 200>
print(isinstance(HttpStatus.OK, HttpStatus)) # True
枚舉迭代
枚舉支持迭代和遍歷順序。舉個例子:
from enum import Enum, auto
# 創(chuàng)建
class HttpStatus(Enum):
OK = 200
BAD_REQUEST = 400
FORBIDDEN = 403
NOT_FOUND = 404
REQUEST_TIMEOUT = 408
SERVICE_UNAVAILABLE = 500
OTHER = auto.value
# 迭代
for status in HttpStatus:
print('{} : {}'.format(status.name, status.value))
打印結(jié)果:
OK : 200
BAD_REQUEST : 400
FORBIDDEN : 403
NOT_FOUND : 404
REQUEST_TIMEOUT : 408
SERVICE_UNAVAILABLE : 500
OTHER : <object object at 0x000002863E1D7B10>
可以看出,遍歷的每一個 status 是一個獨立的枚舉成員,擁有 name 和 value 屬性。
另外,我們也可以使用如下形式來進(jìn)行枚舉遍歷:
for name, member in HttpStatus.__members__.items():
print('{} : {}'.format(name, member))
枚舉成員與屬性訪問
通過枚舉 value 進(jìn)行訪問,訪問需要使用元組()的形式
print(HttpStatus(200)) # HttpStatus.OK
通過枚舉 name 進(jìn)行訪問,訪問需要使用列表[]的形式
print(HttpStatus['OK']) # HttpStatus.OK
將屬性賦予另一個 enum 成員
number = HttpStatus.OK print(number) # HttpStatus.OK
枚舉值唯一
上面我們創(chuàng)建的枚舉類中,value 值是可以重復(fù)的,如果我們不想枚舉類中的值重復(fù)可以是用裝飾器 @unique,舉例如下:
from enum import Enum, unique # 創(chuàng)建 @unique class HttpStatus(Enum): OK = 200 BAD_REQUEST = 400 FORBIDDEN = 403 NOT_FOUND = 404 REQUEST_TIMEOUT = 408 SERVICE_UNAVAILABLE = 500 OTHER = 200
我們運行后,報如下異常:
ValueError: duplicate values found in <enum 'HttpStatus'>: OTHER -> OK
我們查看源代碼,發(fā)現(xiàn)加入此裝飾器的枚舉類型,unique 方法會將其 __members__.items() 進(jìn)行遍歷,追加到 duplicates 列表中,如果發(fā)現(xiàn)列表不為空,則拋出如上異常信息。
枚舉自動賦值
此功能用于我們在使用枚舉時,只在意枚舉的標(biāo)識符的含義而不在意值的情況下,但是如果需要與字符串或整數(shù)混合使用就要額外注意。下面貼上官方的示例:
import unittest
from enum import auto, Enum
class TestEnum(unittest.TestCase):
def test_auto_number(self):
class Color(Enum):
red = auto()
blue = auto()
green = auto()
self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
self.assertEqual(Color.red.value, 1)
self.assertEqual(Color.blue.value, 2)
self.assertEqual(Color.green.value, 3)
def test_auto_name(self):
class Color(Enum):
def _generate_next_value_(self, start, count, last):
return self
red = auto()
blue = auto()
green = auto()
self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
self.assertEqual(Color.red.value, 'red')
self.assertEqual(Color.blue.value, 'blue')
self.assertEqual(Color.green.value, 'green')
可以發(fā)現(xiàn),使用 auto() 得到的是整數(shù)自增型,如果我們需要別的方式,只需要在我們的枚舉類中,重寫 _generate_next_value_ 方法。
枚舉比較
枚舉對象可以進(jìn)行比較,但是不能進(jìn)行值比較,如果需要進(jìn)行值比較則需要枚舉對象繼承 IntEnum 對象,舉個例子:
import unittest
from enum import Enum, IntEnum
class TestEnum(unittest.TestCase):
class Season(IntEnum):
SPRING = 1
SUMMER = 2
AUTUMN = 3
WINTER = 4
def test_comparisons(self):
season = self.Season
self.assertEqual(season.SPRING, 1)
class Part(Enum):
SPRING = 1
CLIP = 2
BARREL = 3
self.assertNotEqual(Part.SPRING, 1)
self.assertNotEqual(Part.SPRING, season.SPRING)
TestEnum().test_comparisons()
上面的測試?yán)赢?dāng)中,我們創(chuàng)建了兩個繼承類型不一樣的枚舉類,可以看到繼承了 IntEnum 的 Season 可以進(jìn)行值的比較,而繼承了 Enum 的 Part 則不能進(jìn)行值比較,并且 IntEnum 類型與 Enum 類型也不能進(jìn)行比較,即使屬性和值一樣。
枚舉方法
枚舉中可以定義枚舉類自身特有的方法,也可以復(fù)寫一些已經(jīng)在基類中定義好的方法,比如: __init__, __str__, __repr__ , __hash__ ,__format__ 等。舉個例子:
from enum import Enum
class Mood(Enum):
FUNKY = (1, "hello")
HAPPY = (3, "world")
def describe(self):
return self.name, self.value
def __init__(self, num, nice):
self.num = num
self.nice = nice
def __str__(self):
return 'my custom str! {0}'.format(self.value)
@classmethod
def favorite_mood(cls):
return cls.HAPPY
@property
def testValue(self):
return self.nice + ':' + str(self.num)
上面我們定義了一個枚舉類,其中 value 是一個枚舉類型,我們可以定義 __init__ 方法去對應(yīng)元組中的值,我們也復(fù)寫了 __str__ 方法。
打印方法看看效果:
print(Mood.favorite_mood()) # my custom str! (3, 'world')
print(Mood.HAPPY.describe()) # ('HAPPY', (3, 'world'))
print(str(Mood.FUNKY)) # my custom str! (1, 'hello')
print(Mood.FUNKY.testValue) # hello:1
從輸出結(jié)果看,我們自定義和復(fù)寫的方法都已經(jīng)成功的應(yīng)用到了 Mood 類中。
枚舉繼承
不同于 java 中的枚舉類, python 中的枚舉類是可以被繼承的,但是被繼承的枚舉類規(guī)定其不能定義任何成員,但可以定義抽象方法。舉例如下:
class EnumExtend(unittest.TestCase):
def test_extending(self):
class Shade(Enum):
def shade(self):
print(self.name)
class Color(Shade):
red = 1
green = 2
blue = 3
with self.assertRaises(TypeError):
class MoreColor(Color):
cyan = 4
magenta = 5
yellow = 6
def test_extending2(self):
class Shade(Enum):
def shade(self):
return self.name
class Color(Shade):
def hex(self):
return '%s nice!' % self.value
class MoreColor(Color):
cyan = 4
magenta = 5
yellow = 6
self.assertEqual(MoreColor.magenta.shade(), 'magenta')
self.assertEqual(MoreColor.magenta.hex(), '5 nice!')
測試用例可以完美運行,我們可以發(fā)現(xiàn):第一個方法中,拋出了 TypeError 的異常;第二個測試方法中,MoreColor 繼承了 Color, Color 繼承了 Shade, 并且我們可以通過子類調(diào)用父類中的方法。
總結(jié)
本節(jié)主要介紹了 enum 模塊的基礎(chǔ)知識,包含枚舉的創(chuàng)建、枚舉成員和屬性的訪問、枚舉方法的創(chuàng)建、枚舉的繼承等。其中新版中的 _ignore_、_order_、_missing_ 等可以學(xué)習(xí)官網(wǎng)的例子,另外 enum 的子類 IntEnum、IntFlag等也是我們比較常用的枚舉基類,本文中簡單的介紹了 IntEnum, 而 IntFlag 相比與 IntEnum 多了 &, |, ^, ~ 的操作,其他的子類大家感興趣也可以了解。
代碼地址
以上就是一文讀懂Python 枚舉的詳細(xì)內(nèi)容,更多關(guān)于Python 枚舉的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Python openpyxl 遍歷所有sheet 查找特定字符串的方法
今天小編就為大家分享一篇Python openpyxl 遍歷所有sheet 查找特定字符串的方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-12-12
Python?ArcPy實現(xiàn)批量對大量遙感影像相減做差
這篇文章主要為大家介紹了如何基于Python中ArcPy模塊實現(xiàn)對大量柵格遙感影像文件批量進(jìn)行相減做差,文中的示例代碼講解詳細(xì),感興趣的可以了解一下2023-06-06
python函數(shù)參數(shù)*args**kwargs用法實例

