如何使用其他方法从现有的dict创建Python Enum类?

问题描述 投票:3回答:2

比方说,我有一个预先存在的映射作为字典:

value_map = {'a': 1, 'b': 2}

我可以这样创建一个枚举类:

from enum import Enum
MyEnum = Enum('MyEnum', value_map)

并像这样使用它

a = MyEnum.a
print(a.value)
>>> 1
print(a.name)
>>> 'a'

但后来我想为我的新枚举类定义一些方法:

def double_value(self):
    return self.value * 2

当然,我可以这样做:

class MyEnum(Enum):
    a = 1
    b = 2
    @property
    def double_value(self):
        return self.value * 2

但正如我所说,我必须使用预定义的值映射字典,所以我不能这样做。怎么能实现这一目标?我试图继承另一个定义这个方法的类,就像mixin一样,但我无法弄明白。

python enums mixins
2个回答
3
投票

您可以使用mixin方法将基类型传递到函数API中,使用type参数:

>>> import enum
>>> value_map = {'a': 1, 'b': 2}
>>> class DoubledEnum:
...     @property
...     def double_value(self):
...         return self.value * 2
...
>>> MyEnum = enum.Enum('MyEnum', value_map, type=DoubledEnum)
>>> MyEnum.a.double_value
2

对于从不使用class语句的全功能方法,您可以使用type() function创建基本混合:

DoubledEnum = type('DoubledEnum', (), {'double_value': property(double_value)})
MyEnum = enum.Enum('MyEnum', value_map, type=DoubledEnum)

您也可以使用相同的方式使用enum.EnumMeta()元类,就像Python在创建class MyEnum(enum.Enum): ...子类时的方式:

  1. 使用元类__prepare__ hook创建一个类字典
  2. 调用元类,传入类名,基数(这里是(enum.Enum,))和步骤1中创建的类字典。

enum.EnumMeta使用的自定义字典子类并非真正设计用于易于重用;它实现了一个__setitem__钩子来记录元数据,但是没有覆盖dict.update()方法,所以在使用你的value_map字典时我们需要小心一点:

import enum

def enum_with_extras(name, value_map, bases=enum.Enum, **extras):
    if not isinstance(bases, tuple):
        bases = bases,
    if not any(issubclass(b, enum.Enum) for b in bases):
        bases += enum.Enum,
    classdict = enum.EnumMeta.__prepare__(name, bases)
    for key, value in {**value_map, **extras}.items():
        classdict[key] = value
    return enum.EnumMeta(name, bases, classdict)

然后将double_value=property(double_value)传递给该函数(连同枚举名称和value_map字典):

>>> def double_value(self):
...     return self.value * 2
...
>>> MyEnum = enum_with_extras('MyEnum', value_map, double_value=property(double_value))
>>> MyEnum.a
<MyEnum.a: 1>
>>> MyEnum.a.double_value
2

否则,您可以创建没有成员的枚举的子类(任何descriptor都不是成员,因此函数,属性,类方法等),因此您可以先定义一个没有成员的枚举:

class DoubledEnum(enum.Enum):
    @property
    def double_value(self):
        return self.value * 2

这是功能API(例如enum.Enum(..., type=DoubledEnum))和我编码为enum_with_extras()的元类方法的可接受的基类。


1
投票

您可以创建一个新的元类(使用元元类或工厂函数,如下所示),它派生自enum.EnumMeta(枚举的元类),并在创建类之前添加成员

import enum
import collections.abc


def enum_metaclass_with_default(default_members):
    """Creates an Enum metaclass where `default_members` are added"""
    if not isinstance(default_members, collections.abc.Mapping):
        default_members = enum.Enum('', default_members).__members__

    default_members = dict(default_members)

    class EnumMetaWithDefaults(enum.EnumMeta):
        def __new__(mcs, name, bases, classdict):
            """Updates classdict adding the default members and
            creates a new Enum class with these members
            """

            # Update the classdict with default_members
            # if they don't already exist
            for k, v in default_members.items():
                if k not in classdict:
                    classdict[k] = v

            # Add `enum.Enum` as a base class

            # Can't use `enum.Enum` in `bases`, because
            # that uses `==` instead of `is`
            bases = tuple(bases)
            for base in bases:
                if base is enum.Enum:
                    break
            else:
                bases = (enum.Enum,) + bases

            return super(EnumMetaWithDefaults, mcs).__new__(mcs, name, bases, classdict)

    return EnumMetaWithDefaults


value_map = {'a': 1, 'b': 2}


class MyEnum(metaclass=enum_metaclass_with_default(value_map)):
    @property
    def double_value(self):
        return self.value * 2


assert MyEnum.a.double_value == 2

另一种解决方案是直接尝试更新locals(),因为当您尝试分配值时,它会替换为创建枚举值的映射。

import enum


value_map = {'a': 1, 'b': 2}


def set_enum_values(locals, value_map):
    # Note that we can't use `locals.update(value_map)`
    # because it's `locals.__setitem__(k, v)` that
    # creates the enum value, and `update` doesn't
    # call `__setitem__`.
    for k, v in value_map:
        locals[k] = v


class MyEnum(enum.Enum):
    set_enum_values(locals(), value_map)

    @property
    def double_value(self):
        return self.value * 2


assert MyEnum.a.double_value == 2

这似乎已经足够明确,a = 1最有可能与locals()['a'] = 1相同,但它可能会在未来发生变化。第一个解决方案更强大,更少hacky(我没有在其他Python实现中测试它,但它可能工作相同)

© www.soinside.com 2019 - 2024. All rights reserved.