py-enum 2.1.1

enums for choices fields

py-enum

A python ChoiceEnum module for python3.

继承原生的 ·enum.Enum· 而来，扩展类ChoiceEnum用于以下场景：

• argparse使用 add_argument 的参数 choices
• Django中 models.CharField 的参数 choices
• Django REST framework ChoiceField 的参数 choices

1. 安装

pip install py-enum

可查看版本变更记录ChangeLog

2. 使用(Usage)

2.1 用ChoiceEnum定义枚举

# 导入
from py_enum import ChoiceEnum

# 定义
class Color(ChoiceEnum):
    RED = (1, '红色')
    GREEN = (2, '绿色')
    BLUE = (3, '蓝色', {'value': 'blue'})

class Status(ChoiceEnum):
    PROCESSING = ('processing', '处理中')
    APPROVED = ('approved', '已审批')
    CANCELED = ('canceled', '已取消')
    CLOSED = ('closed', '已关闭')

定义如上，按照Key = (value, label, extra)的形式进行定义，value定义的值；label是对值的描述；第三个参数是extra，额外信息，可以任意类型。

2.2 基础用法

Color.RED  # Color.RED
Color.RED.value  # 1
type(Color.RED)  # <enum 'Color'>
str(Color.RED)  # (1, 红色)
len(colors) == 3  # true
Color.RED.value in Color  # true
1 in Color  # true
0 not in Color  # true

# 以下是在原生基础上扩展的属性和方法
Color.values  # [1, 2, 3]
Color.names  # ['RED', 'GREEN', 'BLUE']
Color.labels  # ['红色', '绿色', '蓝色']
Color.choices  # [(1, '红色'), (2, '绿色'), (3, '蓝色')]

Color.get_label(Color.RED.value)  # '红色'
Color.get_extra(Color.BLUE.value)  # {'value': 'blue'}

for member in Color:
    print(member.value, member.label)  # 直接遍历value和label
# 1, '红色'
# 2, '绿色'
# 3, '蓝色'

Color.to_js_enum()
# 输出dict数据，可以通过接口序列化后给前端使用，结合js-enumerate前端枚举库
"""
[
    {"key": "RED", "value": 1, "label": "红色"},
    {"key": "GREEN", "value": 2, "label": "绿色"},
    {"key": "BLUE", "value": 3, "label": "蓝色", "extra": {"value": "blue"}}
]
"""

2.3 枚举对象实例化

member = Color(Color.RED.value)  # 或者 Color(1)
member.value == 1  # true
member.name == 'RED'  # true
member.label == '红色'  # true
member.option == (1, '红色')  # true
member.extra == None  # true，因为没有定义
# 以上几个属性无法修改，直接赋值会抛出AttributeError异常
member.value in Color  # true

2.4 在Python argparse中使用

import argparse

parser = argparse.ArgumentParser(description='test ChoiceEnum use in argparse.')
parser.add_argument('--color', type=int, choices=Color, required=True)
args = parser.parse_args(['--color', str(Color.RED.value)])
# args.color == Color.RED.value

2.5 在Django中使用

from django.db import models

class ColorModel(models.Model):
    color = models.IntegerField(verbose_name='颜色', choices=Color.choices, default=Color.RED.value)

instance = ColorModel.objects.create()
assert instance.color == colors.RED.value
instance.color = colors.BLUE.value
instance.save()

2.6 在DRF中使用

from rest_framework import serializers

class ColorSerializer(serializers.Serializer):
    color = serializers.ChoiceField(help_text='选择颜色', choices=Color.choices, default=Color.RED.value)

s = ColorSerializer()
s = ColorSerializer(data={'status': status.CLOSED.value})
assert s.is_valid() is True
s = ColorSerializer(data={'status': 1})
assert s.is_valid() is True
s = ColorSerializer(data={'status': 0})
assert s.is_valid() is False  # 值不在枚举定义范围内，校验不通过

3. 对比

• ChoiceEnum和Django的 models.Choices 的优势在于低版本Django也能使用，且普通Python项目脚本也能使用
• 新增了额外的特性
  • 额外多出了ChoiceEnum.extra的用法，对不同枚举成员做映射配置相关场景可以使用
  • 增加方法ChoiceEnum.to_js_enum返回数组数据，可以用于前端枚举库 js-enumerate 初始化使用