python类型提示数据级属性的注释

Question

我有一个dataclass，我将其用作常数存储。

@dataclass
class MyClass:
    CONSTANT_1 = "first"
    CONSTANT_2 = "second"

我有一个函数：

def my_func(value: ?):
   print(value)

我想向我的功能添加注释，以指定可能的 value 是 myclass

如何做的属性之一（我使用的是Python 3.10）？

Answer 1

希望我不要误解问问，请告诉我是否这样。但是我认为在这种情况下，最好使用 enum a>类型为Python。

这是一个简单的示例：

from enum import Enum


class MyEnum(Enum):
    CONSTANT_1 = "first"
    CONSTANT_2 = "second"

然后回答第二部分，为注释？变成myenum。这意味着这种类型的任何枚举成员，而不是类型（类）本身。

def my_func(value: MyEnum):
    print(value, value.name, value.value)

将所有这些放在一起，就像：

from enum import Enum


class MyEnum(Enum):
    CONSTANT_1 = "first"
    CONSTANT_2 = "second"


def my_func(value: MyEnum):
    # technically you can remove this check
    if not isinstance(value, MyEnum):
        return

    print(value, value.name, value.value)

# note below: only type checker or ide complain, but code still runs fine

my_func('hello')            # not OK!
my_func('second')           # not OK!
my_func(MyEnum)             # not OK!
my_func(MyEnum.CONSTANT_1)  # OK

Answer 2

我想您在问一个 xy问题。从您的评论中的响应来看，您似乎想要的是：

• 具有类似类的界面来保持一堆恒定的值。
• 将论点限制为仅采用上述值。

如rv.kvetch的答案，常规的做法是使用枚举。我不确定您的意思是“想跳过.value”，value枚举字段只是为您提供了与该枚举相关的内容，我会说这一点都不重要。以下是一个示例：

class StrEnum(enum.Enum):
  FIRST = "first"
  SECOND = "second"

class StrEnum2(enum.Enum):
  FIRST = "first"
  SECOND = "second"

print(StrEnum.FIRST.value)  # first
print(StrEnum2.FIRST.value)  # first
print(StrEnum.FIRST.value == StrEnum2.FIRST.value)  # True
print(StrEnum.FIRST == StrEnum2.FIRST)  # False

class IntEnum(enum.Enum):
  FIRST = enum.auto()
  SECOND = enum.auto()

print(IntEnum.FIRST.value)  # 1
print(IntEnum.SECOND.value)  # 2

我想与此示例显示的是两件事：

1. 如果您只是在比较枚举，您真的不需要value。
2. 您甚至不需要手动为枚举分配值；您可以使用enum.auto（）自动分配其唯一值。

因为归根结底，枚举本身已经代表了有效选择之间的选择，因此它具有什么价值都没关系。

---

也就是说，如果您想要的只是对参数可以键入的值进行类型限制，而不必使用枚举，那么您可以使用文字类型。参见此答案细节。就您的示例而言，您可以做类似的事情：

from typing import Literal, Final

def my_func(value: Literal["first", "second"]):
   print(value)

my_func("first")  # ok
my_func("not first")  # bad
x = "first"
y: Final = "first"
my_func(x)  # bad, because `x` is not final
my_func(y)  # ok

但是请注意，类型的注释并不能真正阻止您调用具有无效值的函数，这只是IDE和类型检查器的提示。