如何获取 Python 变量注释？

Question

在定义带注释字段的类/模块时，如何像在函数中一样获得注释？

class Test:
  def __init__(self):
    self.x : int
t = Test()

现在我需要来自getattr(t,'x')的'int'

Answer 1

使用基线 Python，如果不更改 Test 的定义，则无法执行您想要的操作。最简单的更改是在类级别注释属性：

class Test:
    x: int
    def __init__(self):
        # define self.x or not, but it needn't be annotated again

这实际上非常好； 默认情况下，假定类范围内的注释引用 instance 属性，而不是 class 属性（在类范围内赋值会创建一个类属性，但注释它没有）；你必须显式地use typing.ClassVar 来表明带注释的类型只是一个类属性。 PEP 526's section on class and instance variable annotations 定义了这些行为；它们是您可以依赖的东西，而不仅仅是实施的意外。

完成此操作后，typing.get_type_hints 将在您的示例中为 Test 和 t 返回 {'x': int}。

虽然这本身就足够了，但我会注意到，在当今许多此类情况下，只要您仍然要注释，您就可以使用 the dataclasses module 简化您的代码，获取为您定义的注释和基本功能最少的打字。您的案例的简单替换代码是：

import dataclasses

@dataclasses.dataclass
class Test:
    x: int

虽然您的案例没有展示完整的功能集（它基本上只是将 __init__ 替换为装饰器），但它的作用仍然超出了人们的想象。除了为您定义__init__（它希望收到一个注释为int 的x 参数）以及合适的__repr__ 和__eq__，您可以轻松定义默认值（只需在注释点指定默认值，或者对于更复杂或可变的情况，请指定 dataclasses.field），您可以将参数传递给 dataclass 以使其生成可排序或不可变的实例。

就您而言，主要优势是消除冗余； x 被注释和引用一次，而不是在类级别被注释一次，然后在初始化期间使用（并且可以选择再次注释）。

Answer 2

我不确定您是否可以轻松获得self.x 的注释。

假设你的代码：

class Test:
    def __init__(self):
        self.x: int = None

t = Test()

我尝试在Test 和t（我希望它在的地方）中寻找__annotations__，但运气不佳。

但是，您可以做的是这种解决方法：

class Test:
    x: int
    def __init__(self):
        # annotation from here seems to be unreachable from `__annotations__`
        self.x: str

t = Test()

print(Test.__annotations__)
# {'x': <class 'int'>}
print(t.__annotations__)
# {'x': <class 'int'>}

---

编辑

如果您希望能够检查mypy 中self.x 的类型，请检查answer from @ruohola。

---

编辑 2

请注意，mypy（至少为 v.0.560）确实会因在 class 和 __init__ 中注释 x 而感到困惑，即它看起来像self.x 被大胆忽略：

import sys

class Test:
    x: str = "0"
    def __init__(self):
        self.x: int = 1

t = Test()

print(Test.x, t.x)
# 0 1
print(Test.x is t.x)
# False

if "mypy" in sys.modules:
    reveal_type(t.x)
    # from mypyp: annotated_self.py:14: error: Revealed type is 'builtins.str'
    reveal_type(Test.x)
    # from mypy: annotated_self.py:15: error: Revealed type is 'builtins.str'

Test.x = 2
# from mypy: annotated_self.py:17: error: Incompatible types in assignment (expression has type "int", variable has type "str")

t.x = "3"
# no complaining from `mypy`
t.x = 4
# from mypy: annotated_self.py:19: error: Incompatible types in assignment (expression has type "int", variable has type "str")

print(Test.x, t.x)
# 2 4

Answer 3

如果您使用mypy，您可以使用reveal_type() 来检查任何表达式的类型注释。请注意，此函数仅在运行mypy 时可用，而在正常运行时不可用。 我还使用typing.TYPE_CHECKING，在正常运行文件时不会出错，因为这个特殊常量仅被第三方类型检查器假定为True。

test.py:

from typing import Dict, Optional, TYPE_CHECKING


class Test:
    def __init__(self) -> None:
        self.x: Optional[Dict[str, int]]


test = Test()
if TYPE_CHECKING:
    reveal_type(test.x)
else:
    print("not running with mypy")

在其上运行mypy 时的示例：

$ mypy test.py
test.py:10: error: Revealed type is 'Union[builtins.dict[builtins.str, builtins.int], None]'

而正常运行时：

$ python3 test.py
not running with mypy