枚举 class 实例的属性值的类型注释

Question

在 python 中，我有以下枚举 class 的实例：

class Colour(Enum):
    Red = "1"
    Blue = "2"
    Green = "3"

我有一个 function，它采用此 class 的属性值，即Colour.Red.value 、 Colour.Blue.value或Colour.Green.value之一：

def myfunc(input_str):
    return(input_str)

在这种情况下，如何为input_str定义类型注释？

Pylance 在使用input_str: Literal[Colour.Red.value, Colour.Blue.value, Colour.Green.value] : "Type arguments for "Literal" must be None, a literal value (int, bool, str,或字节），或枚举值”。 我从PEP-0586了解到Literal[Colour.Red, Colour.Blue, Colour.Green]是允许的，但这似乎不适合我的用例。

Answer 1

没有必要人为地限制自己，要求函数专门只接受枚举值。

如果你想让myfunc对Colour枚举成员的值做一些事情，你仍然应该让它把枚举成员作为参数：

from enum import Enum
from typing import Literal


class Colour(Enum):
    Red = "1"
    Blue = "2"
    Green = "3"


def f(colour: Colour) -> None:
    print(colour.value.center(5, "-"))


def g(colour: Literal[Colour.Blue, Colour.Green]) -> None:
    print(colour.value * 5)


f(Colour.Red)
g(Colour.Green)

Output：

--1--
33333

此外，如果需要，您可以将str作为枚举成员的超类型专门混入。 然后，出于大多数意图和目的，它们基本上可以被视为字符串。

在此代码中，我不访问成员.value ：

from enum import Enum
from typing import Literal


class Colour(str, Enum):  # notice the order of inheritance
    Red = "1"
    Blue = "2"
    Green = "3"


def f(colour: Colour) -> None:
    print(colour.center(5, "-"))  # `colour` is of type `str`


def g(colour: Literal[Colour.Blue, Colour.Green]) -> None:
    print(colour * 5)  # `colour` is of type `str`


f(Colour.Red)
g(Colour.Green)

同样是 output。

inheritance 的顺序实际上保证了所有str方法都将存在并按预期在所有枚举成员上工作。

如果您不能在任何地方使用这些枚举成员来代替“常规” str对象，我会感到惊讶。

如果执行isinstance(Colour.Red, str) ，则可以验证类型。 成员现在是str的子类型。 如果你想为成员使用一些其他的具体数据类型，你也可以使用它。