有没有办法为 python 枚举指定默认值？

Question

给定以下枚举：

class MyEnum(IntEnum):

    A = 0
    B = 1
    C = 2

如何指定默认值。我希望能够做到：

my_val = MyEnum()

并且有my_val 是<MyEnum.A: 0>

这可能吗？我试过自定义__new__、__init__、__call__，但我无法让它工作。

Answer 1

falsetru's answer 将是如果需要满足 0 参数情况的方法。

如果只是在给定值不存在时返回默认值，我们可以覆盖 Enum 类中的_missing_ 钩子（由于Python 3.6）：

from enum import IntEnum


class MyEnum(IntEnum):
    A = 0
    B = 1
    C = 2

    @classmethod
    def _missing_(cls, value):
        return MyEnum.A

assert MyEnum(0) is MyEnum.A
assert MyEnum(1) is MyEnum.B
assert MyEnum(-1) is MyEnum.A
assert MyEnum(None) is MyEnum.A

Answer 2

MyEnum(..) 由EnumMeta.__call__ 处理。您需要覆盖该方法：

from enum import EnumMeta, IntEnum


class DefaultEnumMeta(EnumMeta):
    default = object()

    def __call__(cls, value=default, *args, **kwargs):
        if value is DefaultEnumMeta.default:
            # Assume the first enum is default
            return next(iter(cls))
        return super().__call__(value, *args, **kwargs)
        # return super(DefaultEnumMeta, cls).__call__(value, *args, **kwargs) # PY2


class MyEnum(IntEnum, metaclass=DefaultEnumMeta):
    # __metaclass__ = DefaultEnumMeta  # PY2 with enum34
    A = 0
    B = 1
    C = 2


assert MyEnum() is MyEnum.A
assert MyEnum(0) is MyEnum.A
assert MyEnum(1) is not MyEnum.A

Answer 3

更新

截至aenum 2.2.1¹ 支持调用不带值的枚举：

from aenum import Enum, no_arg

class Color(Enum):
    black = 0
    red = 1
    green = 2
    blue = 3
    #
    @classmethod
    def _missing_value_(cls, value):
        if value is no_arg:
            return cls.black

并在使用中：

>>> Color(1)
<Color.red: 1>

>>> Color()
<Color.black: 0>

>>> Color(4)
Traceback (most recent call last):
  ...
ValueError: 4 is not a valid Color

---

原答案

如果你不控制Enums，那么做：

my_val = list(MyEnum)[0]

或者，如果Enum 可能为空：

my_val = len(MyEnum) and list(MyEnum)[0] or None

如果你确实控制了Enums，那么添加一个get_default 方法：

class MyEnum(Enum):
    def get_default(self):
        return self.A

或者，更简单，将default 设为别名：

class MyEnum(Enum):
    A = 0
    B = 1
    C = 2
    default = A

您也可以将第一个方法包装到一个函数中：

def default_member(enum):
    return list(enum)[0]

---

¹ 披露：我是Python stdlib Enum、enum34 backport 和Advanced Enumeration (aenum) 库的作者。

Answer 4

你为什么不直接使用standard syntax？

my_val = MyEnum.A

---

如果您真的想这样做，您可能必须编写自己的枚举元覆盖类。您可以查看implementation in cpython 的此示例，以便为枚举分配一个等于值映射中第一个值的默认值。

Answer 5

我也偶然发现了这个问题。发布我的 Python 3.9.5 解决方案

from enum import unique, Enum, EnumMeta

class PrinterModelMeta(EnumMeta):
    def __call__(cls, value=-1, *args, **kwargs):
        if value == -1:
            value = PrinterModel.detect_model()
        return super().__call__(value, *args, **kwargs)


@unique
class PrinterModel(Enum, metaclass=PrinterModelMeta):
    # FORBIDDEN = -1
    MODEL0 = 0
    MODEL1 = 1
    MODEL2 = 2

    @classmethod
    def detect_model(cls) -> int:
        model = None
        panel_name = cls.panel_name()
        if panel_name == "model-aaa":
            model = PrinterModel.MODEL0
        if panel_name == "model-bbb":
            model = PrinterModel.MODEL1
        if panel_name == "model-ccc":
            model = PrinterModel.MODEL2

        logger = logging.getLogger(__name__)
        if model is None:
            raise UnknownPrinterModel()
        else:
            return model.value

    @classmethod
    def panel_name(cls) -> str:
        path = Path("/sys/bus/i2c/devices/1-000f/of_node") / "panel-name"
        return path.read_text()[:-1] if path.exists() else None