如何为attrs验证器函数添加类型注解且不破坏运行时功能？

问题分析 #

你遇到的是静态类型检查和运行时行为的典型冲突：

• mypy的--strict模式要求给Attribute指定泛型参数（比如Attribute[int]），这样它才能验证属性值类型和验证器预期是否匹配；
• 但Python运行时中，attrs.Attribute并不是真正的泛型类（它的泛型支持仅针对类型检查工具），直接写Attribute[int]会触发TypeError: 'type' object is not subscriptable。

下面给你两种可行的解决办法：

解决方案1：使用from __future__ import annotations #

这是最简便的处理方式，通过导入annotations特性，让Python把所有类型注解当作字符串处理，运行时不会解析Attribute[int]，但mypy依然能正确识别这个类型注解。

代码示例：

from __future__ import annotations
from attrs import Attribute, define, field

def is_odd(inst: object, attr: Attribute[int], value: int) -> None:
    if value % 2 != 1:
        raise ValueError("Only odd values allowed")

@define
class Foo:
    bar: int = field(validator=is_odd)

# 运行正常
Foo(1)
# Foo(2)  # 会抛出ValueError，符合预期

生效原因 #

from __future__ import annotations是Python 3.7+的特性，它会让所有函数、变量的类型注解以字符串形式存储，直到类型检查工具（比如mypy）去解析它们。运行时Python不会尝试计算Attribute[int]，自然就不会触发下标错误。

解决方案2：使用泛型类实现验证器 #

如果你不想依赖future特性，可以把验证器封装成泛型类，这样既满足mypy的泛型检查要求，又能在运行时正常实例化。

代码示例：

from typing import TypeVar, Generic
from attrs import Attribute, define, field

# 定义绑定到int的类型变量，确保验证器只处理整数类型属性
T = TypeVar("T", bound=int)

class OddValidator(Generic[T]):
    def __call__(self, inst: object, attr: Attribute[T], value: T) -> None:
        if value % 2 != 1:
            raise ValueError("Only odd values allowed")

@define
class Foo:
    # 实例化泛型验证器，指定类型参数为int
    bar: int = field(validator=OddValidator[int]())

# 运行正常
Foo(1)
# Foo(2)  # 会抛出ValueError，符合预期

这种方式的优势是验证器可以复用在不同类型的属性上（只需调整TypeVar的绑定范围），扩展性更强。

验证效果 #

两种方案都能通过mypy --strict的检查：

Success: no issues found in 1 source file

同时运行时不会抛出TypeError，验证逻辑也能正常工作。

内容的提问来源于stack exchange，提问作者Jean-Paul Calderone