Question

在this article中，Nick Coghlan谈到了PEP 435 Enum type中的一些设计决策，以及EnumMeta如何进行子类化以提供不同的Enum体验。

然而，我给出的关于使用元类的建议（我是主要的stdlib Enum作者）是不应该没有一个很好的理由 - 例如无法完成你需要的东西与类装饰器，或隐藏任何丑陋的专用功能;在我自己的工作中，我在创建__new__类时只使用__init__，Enum和/或普通的类/实例方法就可以做我需要的任何事情：

然后有这个谨慎的故事，在钻研Enum时要小心，有和没有元类子类：

Is it possible to override __new__ in an enum to parse strings to an instance?

考虑到所有这些，我什么时候需要摆弄EnumMeta本身？

Answer 1

到目前为止我为子类EnumMeta所见的最佳（也是唯一）案例来自这三个问题：

我们将在此进一步检查动态成员案例。

首先，看一下不要继承EnumMeta时所需的代码：

stdlib方式

from enum import Enum
import json

class BaseCountry(Enum):
    def __new__(cls, record):
        member = object.__new__(cls)
        member.country_name = record['name']
        member.code = int(record['country-code'])
        member.abbr = record['alpha-2']
        member._value_ = member.abbr, member.code, member.country_name
        if not hasattr(cls, '_choices'):
            cls._choices = {}
        cls._choices[member.code] = member.country_name
        cls._choices[member.abbr] = member.country_name
        return member                
    def __str__(self):
        return self.country_name

Country = BaseCountry(
        'Country',
        [(rec['alpha-2'], rec) for rec in json.load(open('slim-2.json'))],
        )

aenum方式 ¹ ²

from aenum import Enum, MultiValue
import json

class Country(Enum, init='abbr code country_name', settings=MultiValue):
    _ignore_ = 'country this'  # do not add these names as members
    # create members
    this = vars()
    for country in json.load(open('slim-2.json')):
        this[country['alpha-2']] = (
                country['alpha-2'],
                int(country['country-code']),
                country['name'],
                )
    # have str() print just the country name
    def __str__(self):
        return self.country_name

上面的代码适用于一次性枚举 - 但是如果从JSON文件创建Enums对你来说很常见呢？想象一下，如果你能做到这一点：

class Country(JSONEnum):
    _init_ = 'abbr code country_name'  # remove if not using aenum
    _file = 'some_file.json'
    _name = 'alpha-2'
    _value = {
            1: ('alpha-2', None),
            2: ('country-code', lambda c: int(c)),
            3: ('name', None),
            }

如你所见：

_file是要使用的json文件的名称
_name是应该用于名称
_value是一个字典映射到值³
_init_指定不同值组件的属性名称（如果使用aenum）

JSON数据来自https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes - 这是一个简短的摘录：

[{ “名称”： “阿富汗”， “α-2”： “AF”， “国家代码”： “004”}，

{“name”：“ÅlandIslands”，“alpha-2”：“AX”，“country-code”：“248”}，

{ “名称”： “阿尔巴尼亚”， “α-2”： “AL”， “国家代码”： “008”}，

{ “名称”： “阿尔及利亚”， “α-2”： “DZ”， “国家代码”： “012”}]

以下是JSONEnumMeta类：

class JSONEnumMeta(EnumMeta):

    @classmethod
    def __prepare__(metacls, cls, bases, **kwds):
        # return a standard dictionary for the initial processing
        return {}

    def __init__(cls, *args , **kwds):
        super(JSONEnumMeta, cls).__init__(*args)

    def __new__(metacls, cls, bases, clsdict, **kwds):
        import json
        members = []
        missing = [
               name
               for name in ('_file', '_name', '_value')
               if name not in clsdict
               ]
        if len(missing) in (1, 2):
            # all three must be present or absent
            raise TypeError('missing required settings: %r' % (missing, ))
        if not missing:
            # process
            name_spec = clsdict.pop('_name')
            if not isinstance(name_spec, (tuple, list)):
                name_spec = (name_spec, )
            value_spec = clsdict.pop('_value')
            file = clsdict.pop('_file')
            with open(file) as f:
                json_data = json.load(f)
            for data in json_data:
                values = []
                name = data[name_spec[0]]
                for piece in name_spec[1:]:
                    name = name[piece]
                for order, (value_path, func) in sorted(value_spec.items()):
                    if not isinstance(value_path, (list, tuple)):
                        value_path = (value_path, )
                    value = data[value_path[0]]
                    for piece in value_path[1:]:
                        value = value[piece]
                    if func is not None:
                        value = func(value)
                    values.append(value)
                values = tuple(values)
                members.append(
                    (name, values)
                    )
        # get the real EnumDict
        enum_dict = super(JSONEnumMeta, metacls).__prepare__(cls, bases, **kwds)
        # transfer the original dict content, _items first
        items = list(clsdict.items())
        items.sort(key=lambda p: (0 if p[0][0] == '_' else 1, p))
        for name, value in items:
            enum_dict[name] = value
        # add the members
        for name, value in members:
            enum_dict[name] = value
        return super(JSONEnumMeta, metacls).__new__(metacls, cls, bases, enum_dict, **kwds)

# for use with both Python 2/3
JSONEnum = JSONEnumMeta('JsonEnum', (Enum, ), {})

一些注意事项：

JSONEnumMeta.__prepare__返回正常的dict
EnumMeta.__prepare__用于获取_EnumDict的实例 - 这是获取
的正确方法
带有前导下划线的键首先传递给真实的_EnumDict，因为在处理枚举成员时可能需要它们
枚举成员的顺序与文件中的顺序相同

¹披露：我是Python stdlib Enum，enum34 backport和Advanced Enumeration (aenum)图书馆的作者。

²这需要aenum 2.0.5+。

³如果Enum需要多个值，则键是数字的，以保持多个值。

什么时候应该将EnumMeta子类化为Enum？

1 个答案: