AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

每周一个 Python 模块 | enum

2022-04-22 100
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 枚举类型可以看作是一种标签或是一系列常量的集合，通常用于表示某些特定的有限集合，例如星期、月份、状态等。Python 的原生类型（Built-in types）里并没有专门的枚举类型，但是我们可以通过很多方法来实现它，例如字典、类等：

枚举类型可以看作是一种标签或是一系列常量的集合，通常用于表示某些特定的有限集合，例如星期、月份、状态等。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
复制代码


这个例子和上面用元组是等价的。


文章标签：
Python
关键词：
Python模块
Python enum
alwaysbeta
目录
相关文章
dufadayang
|
27天前
|
开发者 Python
如何在Python中管理模块和包的依赖关系？
在实际开发中，通常会结合多种方法来管理模块和包的依赖关系，以确保项目的顺利进行和可维护性。同时，要及时更新和解决依赖冲突等问题，以保证代码的稳定性和可靠性
dufadayang
44 4
米果粒
|
7天前
|
Python
Python Internet 模块
Python Internet 模块。
米果粒
102 74
bruce_xiaowei
|
25天前
|
算法 数据安全/隐私保护 开发者
马特赛特旋转算法：Python的随机模块背后的力量
马特赛特旋转算法是Python `random`模块的核心，由松本真和西村拓士于1997年提出。它基于线性反馈移位寄存器，具有超长周期和高维均匀性，适用于模拟、密码学等领域。Python中通过设置种子值初始化状态数组，经状态更新和输出提取生成随机数，代码简单高效。
bruce_xiaowei
104 63
我是快乐的嘟嘟
|
27天前
|
测试技术 Python
手动解决Python模块和包依赖冲突的具体步骤是什么？
需要注意的是，手动解决依赖冲突可能需要一定的时间和经验，并且需要谨慎操作，避免引入新的问题。在实际操作中，还可以结合使用其他方法，如虚拟环境等，来更好地管理和解决依赖冲突😉。
我是快乐的嘟嘟
109 58
我是快乐的嘟嘟
|
27天前
|
持续交付 Python
如何在Python中自动解决模块和包的依赖冲突？
完全自动解决所有依赖冲突可能并不总是可行，特别是在复杂的项目中。有时候仍然需要人工干预和判断。自动解决的方法主要是提供辅助和便捷，但不能完全替代人工的分析和决策😉。
我是快乐的嘟嘟
111 49
小白的大数据之旅
|
1月前
|
JSON Linux 数据格式
Python模块：从入门到精通，只需一篇文章！
Python中的模块是将相关代码组织在一起的单元，便于重用和维护。模块可以是Python文件或C/C++扩展，Python标准库中包含大量模块，如os、sys、time等，用于执行各种任务。定义模块只需创建.py文件并编写代码，导入模块使用import语句。此外，Python还支持自定义模块和包，以及虚拟环境来管理项目依赖。
小白的大数据之旅
44 8
Python模块：从入门到精通，只需一篇文章！
dufadayang
|
27天前
|
Python
Python的模块和包
总之，模块和包是 Python 编程中非常重要的概念，掌握它们可以帮助我们更好地组织和管理代码，提高开发效率和代码质量
dufadayang
38 5
我是快乐的嘟嘟
|
27天前
|
数据可视化 Python
如何在Python中解决模块和包的依赖冲突？
解决模块和包的依赖冲突需要综合运用多种方法，并且需要团队成员的共同努力和协作。通过合理的管理和解决冲突，可以提高项目的稳定性和可扩展性
我是快乐的嘟嘟
57 3
vohelon
|
1月前
|
Python
在Python中，可以使用内置的`re`模块来处理正则表达式
在Python中，可以使用内置的`re`模块来处理正则表达式
vohelon
47 5
kaixin321-44007
|
1月前
|
Java 程序员 开发者
Python的gc模块
Python的gc模块
kaixin321-44007
27 2

热门文章

最新文章

  • 1
    3、Python与设计模式--建造者模式
  • 2
    python-opencv表格识别
  • 3
    Python处理JSON文件数据各类操作一文详解+实例代码
  • 4
    Python常用函数--return 语句
  • 5
    LLDB中的Python脚本
  • 6
    用Python破解WiFi密码，只需要1行代码，太刺激了！
  • 7
    Python正则表达式指南中半部
  • 8
    Python基础--dict(或对象)与json之间的区别和互相转化
  • 9
    Python的for循环如何同时输出两个或者多个值，报错ValueError: too many values to unpack (expected 3)
  • 10
    Python——tuple操作
  • 1
    Python 密码学实用指南（全）（2）
    40
  • 2
    【python】习题 第10周
    61
  • 3
    【python】习题第8周
    56
  • 4
    【python】习题第7周（上）
    88
  • 5
    【python】习题 6-10周（下）
    58
  • 6
    【python】习题 6-10周（中）
    66
  • 7
    Python 入门指南（七）（4）
    48
  • 8
    【python】习题 1-5周（中）
    90
  • 9
    【python】习题 1-5周（上）
    51
  • 10
    Python 入门指南（七）（2）
    60

    • 相关课程

    更多
  • Python爬虫实战
  • Python开发基础入门
  • Python常用数据科学库
  • Python网络爬虫实战
  • Python完全自学手册图文教程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • From Python Scikit-Learn to Sc
  • Data Pre-Processing in Python:
  • 双剑合璧-Python和大数据计算平台的结合

    • 相关实验场景

    更多
  • 用Python画圣诞树
  • Python选择及循环结构
  • 云端Python及基本操作
  • Python网络通信程序典型应用
  • Python新手入门（Anolis OS）
  • Python新手入门

    • 推荐镜像

    更多
  • python-release
  • nodejs-release
  • debian-cd
    • 下一篇
    DataWorks售前咨询