Автоматическая установка значения элемента перечисления для его имени

Я возился с библиотекой enum python и столкнулся с головоломкой. В документах они приводят пример перечисления автоматического нумерации, в котором что-то определено:

class Color(AutoNumber):
    red = ()
    green = ()
    ...

Я хочу создать аналогичный класс, но значение будет автоматически задано из имени элемента и сохранить функциональность, которую вы получаете от выполнения str и enum материал mixin

Так что-то вроде:

class Animal(MagicStrEnum):
    horse = ()
    dog = ()

Animal.dog == 'dog' # True

Я просмотрел исходный код модуля enum и попробовал множество вариаций, связанных с __new__ и EnumMeta class

Ответ 1

Обновление: 2017-03-01

В Python 3.6 (и Aenum 2.0 ¹) были добавлены классы Flag и IntFlag; частично это был новый помощник auto() который упрощает эту задачу:

>>> class AutoName(Enum):
...     def _generate_next_value_(name, start, count, last_values):
...         return name
...
>>> class Ordinal(AutoName):
...     NORTH = auto()
...     SOUTH = auto()
...     EAST = auto()
...     WEST = auto()
...
>>> list(Ordinal)
[<Ordinal.NORTH: 'NORTH'>, <Ordinal.SOUTH: 'SOUTH'>, <Ordinal.EAST: 'EAST'>, <Ordinal.WEST: 'WEST'>]

Оригинальный ответ

Сложность использования класса AutoStr заключается в том, что имя члена перечисления не передается в код, который его создает, поэтому оно недоступно для использования. Другая проблема заключается в том, что str является неизменным, поэтому мы не можем изменять эти типы перечислений после их создания (например, с помощью декоратора классов).

Проще всего использовать Функциональный API:

Animal = Enum('Animal', [(a, a) for a in ('horse', 'dog')], type=str)

что дает нам:

>>> list(Animal)
[<Animal.horse: 'horse'>, <Animal.dog: 'dog'>]

>>> Animal.dog == 'dog'
True

Следующее, что проще всего сделать, если вы захотите создать базовый класс для будущего использования перечисления, это будет что-то вроде моего DocEnem:

class DocEnum(Enum):
    """
    compares equal to all cased versions of its name
    accepts a doctring for each member
    """
    def __new__(cls, *args):
        """Ignores arguments (will be handled in __init__)"""
        obj = object.__new__(cls)
        obj._value_ = None
        return obj

    def __init__(self, doc=None):
        # first, fix _value_
        self._value_ = self._name_.lower()
        self.__doc__ = doc

    def __eq__(self, other):
        if isinstance(other, basestring):
            return self._value_ == other.lower()
        elif not isinstance(other, self.__class__):
            return NotImplemented
        return self is other

    def __hash__(self):
        # keep DocEnum hashable
        return hash(self._value_)

    def __ne__(self, other):
        return not self == other

и в использовании:

class SpecKind(DocEnum):
    REQUIRED = "required value"
    OPTION = "single value per name"
    MULTI = "multiple values per name (list form)"
    FLAG = "boolean value per name"
    KEYWORD = 'unknown options'

Обратите внимание, что в отличие от первого варианта, DocEnum члены не являются str s.

Если вы хотите сделать это трудным путем: EnumMeta подкласс EnumMeta и EnumMeta новый словарь класса Enum перед созданием членов:

from enum import EnumMeta, Enum, _EnumDict

class StrEnumMeta(EnumMeta):
    def __new__(metacls, cls, bases, oldclassdict):
        """
        Scan through 'oldclassdict' and convert any value that is a plain tuple
        into a 'str' of the name instead
        """
        newclassdict = _EnumDict()
        for k, v in oldclassdict.items():
            if v == ():
                v = k
            newclassdict[k] = v
        return super().__new__(metacls, cls, bases, newclassdict)

class AutoStrEnum(str, Enum, metaclass=StrEnumMeta):
    "base class for name=value str enums"

class Animal(AutoStrEnum):
    horse = ()
    dog = ()
    whale = ()

print(Animal.horse)
print(Animal.horse == 'horse')
print(Animal.horse.name, Animal.horse.value)

Что дает нам:

Animal.horse
True
horse horse

¹ Раскрытие информации: я являюсь автором Python stdlib Enum, enum34 и библиотеки Advanced Enumeration (aenum).

Ответ 2

Возможно, вы ищете атрибут name, который автоматически предоставляется Enum class

>>> class Animal(Enum):
...     ant = 1
...     bee = 2
...     cat = 3
...     dog = 4
...

>>> Animal.ant.name == "ant"
True

Хотя, если вы действительно хотите стрелять в ногу. И я уверен, что это представит целый мир gotchas (я устранил самый очевидный).

from enum import Enum, EnumMeta, _EnumDict

class AutoStrEnumDict(_EnumDict):
    def __setitem__(self, key, value):
        super().__setitem__(key, key)

class AutoStrEnumMeta(EnumMeta):
    @classmethod
    def __prepare__(metacls, cls, bases):
        return AutoStrEnumDict()
    def __init__(self, name, bases, attrs):
        super().__init__(name, bases, attrs)
        # override Enum.__str__
        # can't put these on the class directly otherwise EnumMeta overwrites them
        # should also consider resetting __repr__, __format__ and __reduce_ex__
        if self.__str__ is not str.__str__:
            self.__str__ = str.__str__

class AutoStrNameEnum(str, Enum, metaclass=AutoStrEnumMeta):
    pass

class Animal(AutoStrNameEnum):
    horse = ()
    dog = ()

print(Animal.horse)
assert Animal.horse == "horse"
assert str(Animal.horse) == "horse" 
# and not equal to "Animal.horse" (the gotcha mentioned earlier)