一文读懂Python 枚举


Posted in Python onAugust 25, 2020

enum 是一组绑定到唯一常数值的符号名称,并且具备可迭代性和可比较性的特性。我们可以使用 enum 创建具有良好定义的标识符,而不是直接使用魔法字符串或整数,也便于开发工程师的代码维护。

创建枚举

我们可以使用 class 语法创建一个枚举类型,方便我们进行读写,另外,根据函数 API 的描述定义,我们可以创建一个 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 实例,并为您选择适当的值。如果您将 auto 与其他值混合,则必须小心。 枚举类型中,不可以设置相同名称的 name,可以有相同的 value。

enum 自带属性 namevalue,日常工作中使用最多的也是这两个属性,我们打印看看结果:

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

# 创建
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))

打印结果:

OK : 200
BAD_REQUEST : 400
FORBIDDEN : 403
NOT_FOUND : 404
REQUEST_TIMEOUT : 408
SERVICE_UNAVAILABLE : 500
OTHER : <object object at 0x000002863E1D7B10>

可以看出,遍历的每一个 status 是一个独立的枚举成员,拥有 namevalue 属性。

另外,我们也可以使用如下形式来进行枚举遍历:

for name, member in HttpStatus.__members__.items():
  print('{} : {}'.format(name, member))

枚举成员与属性访问

通过枚举 value 进行访问,访问需要使用元组()的形式

print(HttpStatus(200))   # HttpStatus.OK

通过枚举 name 进行访问,访问需要使用列表[]的形式

print(HttpStatus['OK'])   # HttpStatus.OK

将属性赋予另一个 enum 成员

number = HttpStatus.OK
print(number)        # HttpStatus.OK

枚举值唯一

上面我们创建的枚举类中,value 值是可以重复的,如果我们不想枚举类中的值重复可以是用装饰器 @unique,举例如下:

from enum import Enum, unique

# 创建
@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

我们查看源代码,发现加入此装饰器的枚举类型,unique 方法会将其 __members__.items() 进行遍历,追加到 duplicates 列表中,如果发现列表不为空,则抛出如上异常信息。

枚举自动赋值

此功能用于我们在使用枚举时,只在意枚举的标识符的含义而不在意值的情况下,但是如果需要与字符串或整数混合使用就要额外注意。下面贴上官方的示例:

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')

可以发现,使用 auto() 得到的是整数自增型,如果我们需要别的方式,只需要在我们的枚举类中,重写 _generate_next_value_ 方法。

枚举比较

枚举对象可以进行比较,但是不能进行值比较,如果需要进行值比较则需要枚举对象继承 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()

上面的测试例子当中,我们创建了两个继承类型不一样的枚举类,可以看到继承了 IntEnum Season 可以进行值的比较,而继承了 EnumPart 则不能进行值比较,并且 IntEnum 类型与 Enum 类型也不能进行比较,即使属性和值一样。

枚举方法

枚举中可以定义枚举类自身特有的方法,也可以复写一些已经在基类中定义好的方法,比如: __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__ 方法去对应元组中的值,我们也复写了 __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

从输出结果看,我们自定义和复写的方法都已经成功的应用到了 Mood 类中。

枚举继承

不同于 java 中的枚举类, python 中的枚举类是可以被继承的,但是被继承的枚举类规定其不能定义任何成员,但可以定义抽象方法。举例如下:

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!')

测试用例可以完美运行,我们可以发现:第一个方法中,抛出了 TypeError 的异常;第二个测试方法中,MoreColor 继承了 Color, Color 继承了 Shade, 并且我们可以通过子类调用父类中的方法。

总结

本节主要介绍了 enum 模块的基础知识,包含枚举的创建、枚举成员和属性的访问、枚举方法的创建、枚举的继承等。其中新版中的 _ignore_、_order_、_missing_ 等可以学习官网的例子,另外 enum 的子类 IntEnum、IntFlag等也是我们比较常用的枚举基类,本文中简单的介绍了 IntEnum, 而 IntFlag 相比与 IntEnum 多了 &, |, ^, ~ 的操作,其他的子类大家感兴趣也可以了解。

代码地址

示例代码:Python-100-days-day036

以上就是一文读懂Python 枚举的详细内容,更多关于Python 枚举的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
简单介绍Python下自己编写web框架的一些要点
Apr 29 Python
浅析Python中yield关键词的作用与用法
Nov 29 Python
Python配置mysql的教程(推荐)
Oct 13 Python
利用python将图片转换成excel文档格式
Dec 30 Python
Python随机生成身份证号码及校验功能
Dec 04 Python
Python地图绘制实操详解
Mar 04 Python
对Python中画图时候的线类型详解
Jul 07 Python
Python队列、进程间通信、线程案例
Oct 25 Python
python生成任意频率正弦波方式
Feb 25 Python
Python线程threading模块用法详解
Feb 26 Python
python实现ping命令小程序
Dec 28 Python
Jupyter Notebook 安装配置与使用详解
Jan 06 Python
详解python变量与数据类型
Aug 25 #Python
python获取百度热榜链接的实例方法
Aug 25 #Python
利用Python如何制作贪吃蛇及AI版贪吃蛇详解
Aug 24 #Python
python实现自动清理重复文件
Aug 24 #Python
anaconda3安装及jupyter环境配置全教程
Aug 24 #Python
Python+pyftpdlib实现局域网文件互传
Aug 24 #Python
实例代码讲解Python 线程池
Aug 24 #Python
You might like
PHP 各种排序算法实现代码
2009/08/20 PHP
php5.2 Json不能正确处理中文、GB编码的解决方法
2014/03/28 PHP
分享php多功能图片处理类
2016/05/15 PHP
javascript 事件处理、鼠标拖动效果实现方法详解
2012/05/11 Javascript
用js获取电脑信息(是使用与IE浏览器)
2013/01/15 Javascript
jQuery获得内容和属性方法及示例
2013/12/02 Javascript
JavaScript也谈内存优化
2014/06/06 Javascript
js中的getAttribute方法使用示例
2014/08/01 Javascript
js实现点击添加一个input节点
2014/12/05 Javascript
node.js中的fs.fsyncSync方法使用说明
2014/12/15 Javascript
jQuery mobile 移动web(4)
2015/12/20 Javascript
又一枚精彩的弹幕效果jQuery实现
2016/07/25 Javascript
js实现textarea限制输入字数
2017/02/13 Javascript
JavaScript模块详解
2017/12/18 Javascript
Vue组件全局注册实现警告框的实例详解
2018/06/11 Javascript
Vue2.0中三种常用传值方式(父传子、子传父、非父子组件传值)
2018/08/16 Javascript
layer.js open 隐藏滚动条的例子
2019/09/05 Javascript
简单了解Vue computed属性及watch区别
2020/07/10 Javascript
python中MethodType方法介绍与使用示例
2017/08/03 Python
分析python请求数据
2018/08/19 Python
Python调用REST API接口的几种方式汇总
2020/10/19 Python
Columbia美国官网:美国著名的户外服装品牌
2016/11/24 全球购物
党委书记岗位职责
2013/11/24 职场文书
简历中求职的个人自我评价
2013/12/03 职场文书
竞选学生会主席演讲稿
2014/04/24 职场文书
3的组成教学反思
2014/04/30 职场文书
暑期培训班招生方案
2014/08/26 职场文书
2014年优秀党员材料
2014/12/18 职场文书
先进典型事迹材料
2014/12/29 职场文书
教师见习总结范文
2015/06/23 职场文书
2016教师学习教育法心得体会
2016/01/19 职场文书
奇妙的 CSS shapes(CSS图形)
2021/04/05 HTML / CSS
Java基础之详解HashSet的使用方法
2021/06/30 Java/Android
灵能百分百第三季什么时候来?
2022/03/15 日漫
Java存储没有重复元素的数组
2022/04/29 Java/Android
Hive HQL支持2种查询语句风格
2022/06/25 数据库