如何在 Python 中表示枚举 [重复]

Question

我知道，我知道，here 和 there 已经有类似的问题了。但他们的问题和答案并不是我想要的。此外，它们是锁定问题，因此我无法为它们添加新答案。 SMH。

首先，让我们澄清问题以了解其范围。在像这样在其他静态语言中使用枚举时：

public enum Size
{
    SMALL=0,
    MIDIUM=1,
    LARGE=2,
    BIG=2  // There can possibly be an alias
}

我们希望它能帮助我们：

1. 在引用值时防止拼写错误。例如，var foo = Size.SMALL 是有效的，var bar = Size.SMAL 应该会产生一个糟糕的错误。
2. 枚举值可以支持字符串，如HTTP404 = "Not Found", HTTP200 = "OK", ...。 （因此，那些基于range(N) 的实现是不可接受的。）
3. 将参数定义为特定的 Enum 类型时，它作为一种规则，只接受该类型的值。例如，public void Foo(Size size) {...}

4. 我还希望这些值在我的 Enum 解决方案中成为一等公民。这意味着，我的函数def parser(value_from_the_wire): ... 想使用一些本机值（例如整数或字符串等），而不是使用 Enum 成员。这是 Python 3 中标准枚举中的棘手部分：

   • assert 2 == MY_ENUM.MY_VALUE 仅在 MY_ENUM 派生自 IntEnum 时才有效（并且没有默认的 StrEnum，尽管自己子类化并不困难）
   • assert 2 in MY_ENUM 不起作用，即使 MY_ENUM 派生自 IntEnum。

Answer 1

TL;DR：使用venum

所以我的 Python 解决方案要满足问题中的 3 个标准，它基于 namedtuple，并且实现似乎比新的 built-in Enum in Python 3 更简单。

from collections import namedtuple

def enum(name=None, **kwargs):
    """
    :param name: An optional type name, which only shows up when debugging by print(...)
    """
    # This actual implementation below is just a one-liner, even within 80-char
    return namedtuple(name or "Const_%d" % id(kwargs), kwargs.keys())(**kwargs)

现在使用很简单。

# definition syntax
SIZE = enum("Size", SMALL=0, MEDIUM=1, LARGE=2, BIG=2)

# usage on referencing
print(SIZE.SMALL)   # got 0, instead of <SIZE.SMALL: 0>
try:
    print(SIZE.SMAL)    # got AttributeError
    assert False, "should not arrive this line"
except AttributeError:
    pass

# usage on comparison and contains-check
assert SIZE.MEDIUM == 1  # works. It won't work when using standard Enum (unless using IntEnum)
assert 1 in SIZE  # works. It won't work when using standard Enum (unless you wrote it as SIZE(1)).

# usage on regulating input value
def t_shirt_size(size):

    if size not in SIZE:
        raise ValueError("Invalid input value")

    print("Placing order with size: %s" % size)

t_shirt_size(SIZE.MEDIUM)   # works
t_shirt_size(2)             # also want this to work
try:
    t_shirt_size(7)             # got AssertionError
    assert False, "This line should not be reached!"
except ValueError:
    pass

编辑 1：我实际上知道有一个 standard Enum module in Python 3，从功能上讲，它在很大程度上是我下面的单行实现的超集。但是，有一种情况是标准 Enum 不适合我的需要。我希望这些价值观在我的枚举中成为一等公民；我希望我的 t_shirt_size(...) 函数接受一个真正的值，而不仅仅是一个枚举成员。标准枚举方法不允许这两种用法：assert SIZE.MEDIUM == 1 或 assert 1 in SIZE。

编辑 2：鉴于人们倾向于将此主题定型为重复，我计划将我的方法实际实现为具有大量文档的独立模块。我什至给它起了一个很酷的名字，venum，V 代表价值。就在那个时候，我在pypi中查看了名字，发现已经有一个同名的包，使用与我相同的方法，documented well。这样就解决了。我会简单地pip install venum 代替。 :-)

Answer 2

用 Python 3 的 Enum 实现：

from enum import IntEnum


class SIZE(Enum):

    SMALL = 0
    MEDIUM = 1
    LARGE = 2
    BIG = 2

    @classmethod
    def contains(cls, value):
        return any([e.value == value for e in cls])

并使用：

print(SIZE.SMALL)   # got <SIZE.SMALL: 0>
print(SIZE.SMAL)    # got AttributeError

def t_shirt_size(size):
    assert size in SIZE, "Invalid input value"
    place_order_with_size(size)

t_shirt_size(SIZE.MEDIUM)   # works
t_shirt_size(7)             # got AssertionError