Python 中enum的使用方法总结
作者:Moelimoe 发布时间:2022-11-10 03:13:14
前言:
枚举(enumeration
)在许多编程语言中常被表示为一种基础的数据结构使用,枚举帮助组织一系列密切相关的成员到同一个群组机制下,一般各种离散的属性都可以用枚举的数据结构定义,比如颜色、季节、国家、时间单位等
在Python中没有内置的枚举方法,起初模仿实现枚举属性的方式是
class Directions:
? ? NORTH = 1
? ? EAST = 2
? ? SOUTH = 3
? ? WEST = 4
使用成员:
Direction.EAST
Direction.SOUTH
检查成员:
>>> print("North的类型:", type(Direction.NORTH))
>>> print(isinstance(Direction.EAST, Direction))
North的类型: <class 'int'>
False
成员NORTH的类型是int,而不是Direction
,这个做法只是简单地将属性定义到类中
Python
标准库enum实现了枚举属性的功能,接下来介绍enum的在实际工作生产中的用法
1.为什么要用enum,什么时候使用enum?
enum
规定了一个有限集合的属性,限定只能使用集合内的值,明确地声明了哪些值是合法值,,如果输入不合法的值会引发错误,只要是想要从一个限定集合取值使用的方式就可以使用enum
来组织值。
2.enum的定义/声明
from enum import Enum
class Directions(Enum):
? ? NORTH = 1
? ? EAST = 2
? ? SOUTH = 3
? ? WEST = 4
使用和类型检查:
>>> Directions.EAST
<Directions.EAST: 2>
>>> Directions.SOUTH
<Directions.SOUTH: 3>
>>> Directions.EAST.name
'EAST'
>>> Directions.EAST.value
2
>>> print("South的类型:", type(Directions.SOUTH))
South的类型: <enum 'Directions'>
>>> print(isinstance(Directions.EAST, Directions))
True
>>>?
检查示例South
的的类型,结果如期望的是Directions
。name
和value
是两个有用的附加属性。
实际工作中可能会这样使用:
fetched_value = 2 ?# 获取值
if Directions(fetched_value) is Directions.NORTH:
?? ?...
elif Directions(fetched_value) is Directions.EAST:
?? ?...
else:
?? ?...
输入未定义的值时:
>>> Directions(5)
ValueError: 5 is not a valid Directions
3.遍历成员
>>> for name, value in Directions.__members__.items():
... ? ? print(name, value)
...
NORTH Directions.NORTH
EAST Directions.EAST
SOUTH Directions.SOUTH
WEST Directions.WEST
4.继承Enum的类中定义方法
可以用于将定义的值转换为获取需要的值
from enum import Enum
class Directions(Enum):
? ? NORTH = 1
? ? EAST = 2
? ? SOUTH = 3
? ? WEST = 4
? ? def angle(self):
? ? ? ? right_angle = 90.0
? ? ? ? return right_angle * (self.value - 1)
? ? @staticmethod
? ? def angle_interval(direction0, direction1):
? ? ? ? return abs(direction0.angle() - direction1.angle())
>>> east = Directions.EAST
>>> print("SOUTH Angle:", east.angle())
SOUTH Angle: 90.0
>>> west = Directions.WEST
>>> print("Angle Interval:", Directions.angle_interval(east, west))
Angle Interval: 180.0
5.将Enum类属性的值定义为函数或方法
from enum import Enum
from functools import partial
def plus_90(value):
? ? return Directions(value).angle + 90
class Directions(Enum):
? ? NORTH = 1
? ? EAST = 2
? ? SOUTH = 3
? ? WEST = 4
? ? PLUS_90 = partial(plus_90)
? ? def __call__(self, *args, **kwargs):
? ? ? ? return self.value(*args, **kwargs)
? ? @property
? ? def angle(self):
? ? ? ? right_angle = 90.0
? ? ? ? return right_angle * (self.value - 1)
print(Directions.NORTH.angle)
print(Directions.EAST.angle)
south = Directions(3)
print("SOUTH angle:", south.angle)
print("SOUTH angle plus 90: ", Directions.PLUS_90(south.value))
输出:
0.0
90.0
SOUTH angle: 180.0
SOUTH angle plus 90: 270.0
key: 1.将函数方法用partial包起来;2.定义__call__
方法。
忽略大小写:
class TimeUnit(Enum):
? ? MONTH = "MONTH"
? ? WEEK = "WEEK"
? ? DAY = "DAY"
? ? HOUR = "HOUR"
? ? MINUTE = "MINUTE"
? ??
? ? @classmethod
? ? def _missing_(cls, value: str):
? ? ? ? for member in cls:
? ? ? ? ? ? if member.value == value.upper():
? ? ? ? ? ? ? ? return member
print(TimeUnit("MONTH"))
print(TimeUnit("Month"))
继承父类Enum
的_missing_
方法,在值的比较时将case改为一致即可
输出:
TimeUnit.MONTH
TimeUnit.MONTH
6.自定义异常处理
第一种,执行SomeEnum
(“abc”)时想要引发自定义错误,其中"abc"是未定义的属性值
class TimeUnit(Enum):
? ? MONTH = "MONTH"
? ? WEEK = "WEEK"
? ? DAY = "DAY"
? ? HOUR = "HOUR"
? ? MINUTE = "MINUTE"
? ? @classmethod
? ? def _missing_(cls, value: str):
? ? ? ? raise Exception("Customized exception")
print(TimeUnit("MONTH"))
TimeUnit("abc")
输出:
TimeUnit.MONTH
ValueError: 'abc' is not a valid TimeUnit
...
Exception: Customized exception
第二种:执行SomeEnum.__getattr__
(“ABC”)时,想要引发自定义错误,其中"ABC"是未定义的属性名称,需要重写一下EnumMeta中的__getattr__方法,然后指定实例Enum对象的的metaclass
from enum import Enum, EnumMeta
from functools import partial
class SomeEnumMeta(EnumMeta):
? ? def __getattr__(cls, name: str):
? ? ? ? value = cls.__members__.get(name.upper()) ? # (这里name是属性名称,可以自定义固定传入大写(或小写),对应下面的A1是大写)
? ? ? ? if not value:
? ? ? ? ? ? raise Exception("Customized exception")
? ? ? ? return value
class SomeEnum1(Enum, metaclass=SomeEnumMeta):
? ? A1 = "123"
class SomeEnum2(Enum, metaclass=SomeEnumMeta):
? ? A1 = partial(lambda x: x)
? ? def __call__(self, *args, **kwargs):
? ? ? ? return self.value(*args, **kwargs)
print(SomeEnum1.__getattr__("A1"))
print(SomeEnum2.__getattr__("a1")("123"))
print(SomeEnum2.__getattr__("B")("123"))
输出:
SomeEnum1.A1
123
...
Exception: Customized exception
7.enum的进阶用法
Functional APIs
动态创建和修改Enum对象,可以在不修改原定义好的Enum类的情况下,追加修改,这里借用一个说明示例,具体的场景使用案例可以看下面的场景举例
>>> # Create an Enum class using the functional API
... DirectionFunctional = Enum("DirectionFunctional", "NORTH EAST SOUTH WEST", module=__name__)
... # Check what the Enum class is
... print(DirectionFunctional)
... # Check the items
... print(list(DirectionFunctional))
... print(DirectionFunctional.__members__.items())
...?
<enum 'DirectionFunctional'>
[<DirectionFunctional.NORTH: 1>, <DirectionFunctional.EAST: 2>, <DirectionFunctional.SOUTH: 3>, <DirectionFunctional.WEST: 4>]
dict_items([('NORTH', <DirectionFunctional.NORTH: 1>), ('EAST', <DirectionFunctional.EAST: 2>), ('SOUTH', <DirectionFunctional.SOUTH: 3>), ('WEST', <DirectionFunctional.WEST: 4>)])
>>> # Create a function and patch it to the DirectionFunctional class
... def angle(DirectionFunctional):
... ? ? right_angle = 90.0
... ? ? return right_angle * (DirectionFunctional.value - 1)
...?
...?
... DirectionFunctional.angle = angle
...?
... # Create a member and access its angle
... south = DirectionFunctional.SOUTH
... print("South Angle:", south.angle())
...?
South Angle: 180.0
注:这里没有使用类直接声明的方式来执行枚举(定义时如果不指定值默认是从1开始的数字,也就相当于NORTH = auto(),auto是enum中的方法),仍然可以在后面为这个动态创建的DirectionFunctional
创建方法,这种在运行的过程中修改对象的方法也就是python
的monkey patching
。
Functional APIs的用处和使用场景举例:
在不修改某定义好的Enum类的代码块的情况下,下面示例中是Arithmethic
类,可以认为是某源码库我们不想修改它,然后增加这个Enum类的属性,有两种方法:
1.enum.Enum对象的属性不可以直接被修改,但我们可以动态创建一个新的Enum类,以拓展原来的Enum对象
例如要为下面的Enum对象Arithmetic增加一个取模成员MOD="%",但是又不能修改Arithmetic类中的代码块:
# enum_test.py
from enum import Enum
class Arithmetic(Enum):
? ? ADD = "+"
? ? SUB = "-"
? ? MUL = "*"
? ? DIV = "/"
就可以使用enum的Functional APIs方法:
# functional_api_test.py
from enum import Enum
DynamicEnum = Enum("Arithmetic", {"MOD": "%"}, module="enum_test", qualname="enum_test.Arithmetic")
print(DynamicEnum.MOD)
print(eval(f"5 {DynamicEnum.MOD.value} 3"))
输出:
Arithmetic.MOD
2
注意:动态创建Enum对象时,要指定原Enum类所在的module名称: "Yourmodule",否则执行时可能会因为找不到源无法解析,qualname要指定类的位置:"Yourmodule.YourEnum",值用字符串类型
2.使用aenum.extend_enum可以动态修改enum.Enum对象
为enum.Enum
类Arithmetic
增加一个指数成员EXP="**",且不修改原来的Arithmetic类的代码块:
# functional_api_test.py
from aenum import extend_enum
from enum_test import Arithmetic
extend_enum(Arithmetic, "EXP", "**")
print(Arithmetic, list(Arithmetic))
print(eval(f"2 {Arithmetic.EXP.value} 3"))
输出:
<enum 'Arithmetic'> [<Arithmetic.ADD: '+'>, <Arithmetic.SUB: '-'>, <Arithmetic.MUL: '*'>, <Arithmetic.DIV: '/'>, <Arithmetic.EXP: '**'>]
8
来源:https://blog.csdn.net/Moelimoe/article/details/121435602
猜你喜欢
- 困扰我很久问题终于在昨天被解决了。其实问题很简单<% =now %>老是显示12小时制,总是出现上午、下午。这个问题虽然很小,但
- 前言:网上找的地铁线路图大多数都不太清晰,而且有水印,对本人这种视力不好的人来说看起来是真的不方便。所以能不能制作属于自己的地铁线路图呢?好
- 目录1.列表2.使用格式3.一些很有用的函数4.元组 tuple5.元组的常用函数1.列表python没有数组,而是引入了列表(list),
- 在Python 2.7中,一个float的repr返回最接近十七位数的十进制数;这足以精确地识别每个可能的IEEE浮点值.浮点数的str类似
- 这里以安装简单的nonebot库为例子欧克,简明扼要,拿走点赞哟:大家想要的豆瓣源如下:因为有几个,但在这里还是建议使用国内的豆瓣源,本人感
- 一、队列基本操作from queue import Queueq = Queue(5) # 创建一个容量为5的队列。如果给一个小
- 又发一个js版幻灯片,接口比较少,但功能和外观都还不错的,可自定义切换时间:)method: adRotator.initialize(容器
- 方法一1. 下载MySQL源码分发包,不用区分操作系统,我们需要的东西是一样的;2. 重命名自己的mysql的data目录下的mysql文件
- 前言最近在回答问答python区的问题的时候,发现很多人对于这个break和continue分不清。所以,今天我就写篇文章来讲一下(绝对不是
- 本文实例讲述了Symfony2实现从数据库获取数据的方法。分享给大家供大家参考,具体如下:假设有一张表:test, 字段:name,colo
- 简介本文主要介绍python数组循环语法。主要方式有元素遍历,索引遍历,enumerate, zip, list内部等。普通循环list1
- 序Python易用,但用好却不易,其中比较头疼的就是包管理和Python不同版本的问题,特别是当你使用Windows的时候。为了解决这些问题
- Juan Pablo De Gregorio 的 原文很多人都问我如何为一本杂志、一份报纸、一张海报、一份简报或是一份出版物选择
- 1.按列取、按索引/行取、按特定行列取import numpy as npfrom pandas import DataFrameimpor
- 说明1、通过特征本身的方差来筛选特征。特征的方差越小,特征的变化越不明显。2、变化越不明显的特征对我们区分标签没有太大作用,因此应该消除这些
- 字符函数——返回字符值这些函数全都接收的是字符族类型的参数(CHR除外)并且返回字符值.除了特别说明的之外,这些函数大部分返回VARCHAR
- 随着SaaS服务的流行,越来越多的人选择在各个平台上编写文档,制作表格并进行分享。同时,随着Markdown语法的破圈,很多平台开始集成支持
- 如果您刚刚开始学习PHP,可能有许多函数需要研究,今天我们就来学习一下PHP Header()的使用方法,更多的使用说明,请您参照PHP中文
- 方法1:自定义异常# -*- coding:utf-8 -*-"""功能:python跳出循环"&q
- 〝 古人学问遗无力,少壮功夫老始成 〞python之tkinter库弹窗messagebox,常码字不易,出精品更难,没有特别幸运,那么请先