Enumの代わりにEnumMetaをサブクラス化する必要があるのはいつですか？

サブクラス化に関してこれまでに見た最良の（そして唯一の）ケースEnumMetaは、次の4つの質問から来ています。

• 動的メンバーで列挙型を定義するためのよりPython的な方法

• 無効な列挙型属性の割り当てを防ぐ

• 抽象Enumクラスを作成します

• 列挙型メンバーにアクセスしたときに関数を呼び出す

ここでは、動的メンバーのケースについてさらに詳しく説明します。

まず、サブクラス化しないときに必要なコードを見てください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方法 ^{1 2}

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

上記のコードは1回限りの列挙には問題ありませんが、JSONファイルから列挙を作成することが一般的だった場合はどうでしょうか。代わりにこれを実行できるかどうか想像してみてください。

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パスを値^3にマッピングする辞書です
• _init_さまざまな値コンポーネントの属性名を指定します（使用している場合aenum）

JSONデータはhttps://github.com/lukes/ISO-3166-Countries-with-Regional-Codesから取得されます-ここに短い抜粋があります：

[{"name"： "Afghanistan"、 "alpha-2"： "AF"、 "country-code"： "004"}、

{"name"： "ÅlandIslands"、 "alpha-2"： "AX"、 "country-code"： "248"}、

{"name"： "Albania"、 "alpha-2"： "AL"、 "country-code"： "008"}、

{"name"： "Algeria"、 "alpha-2"： "DZ"、 "country-code"： "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 stdlibEnum、enum34backport、およびAdvanced Enumeration（aenum）ライブラリの作成者です。

²これにはが必要aenum 2.0.5+です。

³キーは数値であり、複数の値がEnum必要な場合に複数の値を順番に保持します。