如何在 attrs 类中正确声明和使用类变量-Python教程-PHP中文网

如何在 attrs 类中正确声明和使用类变量

attrs 库会自动忽略 typing.ClassVar 注解的字段，因此不能直接通过注解定义类变量；需采用继承混入类或类创建后动态赋值的方式实现。

`attrs` 库会自动忽略 `typing.classvar` 注解的字段，因此不能直接通过注解定义类变量；需采用继承混入类或类创建后动态赋值的方式实现。

attrs 以简洁优雅的方式将类型注解转化为实例字段（即 __init__ 参数与实例属性），但其设计原则明确：所有被 @define 处理的字段均为实例级（instance-level）。这意味着 typing.ClassVar[T] 注解（如 my_class_var: ClassVar[str]）会被 attrs 主动跳过——既不参与初始化，也不生成实例属性，更不会自动挂载为类属性。这并非 bug，而是有意为之的设计取舍：attrs 专注实例数据管理，类变量应由 Python 原生机制承担。

✅ 正确添加类变量的两种推荐方式

方式一：通过混入（Mixin）类继承

将类变量定义在独立的基类中，再让 @define 类继承它。这种方式语义清晰、易于复用，且支持 IDE 类型推导（若配合 __class_getitem__ 或 typing.ClassVar 在基类中显式标注）：

from attrs import define, field

class ConfigMixin:
    DEFAULT_ROLE: str = "user"
    MAX_ATTEMPTS: int = 3

@define
class User(ConfigMixin):
    username: str = field()
    email: str = field()

# 使用示例
u = User("alice", "alice@example.com")
print(u.DEFAULT_ROLE)      # → "user"
print(User.DEFAULT_ROLE)   # → "user"（也可直接通过类访问）

⚠️ 注意：混入类中的变量是真正的类变量（非 attrs 字段），因此修改 User.DEFAULT_ROLE 会影响所有实例及子类，符合预期行为。

方式二：类定义后动态赋值

在 @define 装饰完成后，直接为类对象设置属性。适用于简单场景或需运行时计算的值：

from attrs import define, field

@define
class Product:
    name: str = field()
    price: float = field()

# 动态添加类变量
Product.CATEGORY = "electronics"
Product.TAX_RATE = 0.08

p = Product("Laptop", 999.99)
print(p.CATEGORY)   # → "electronics"
print(Product.TAX_RATE)  # → 0.08

❌ 为什么 `ClassVar` 注解无效？

attrs 的文档明确指出：“Annotated as typing.ClassVar, and attributes that are neither annotated nor set to a field() are ignored.”
这意味着 my_class_var: ClassVar[str] 被完全跳过处理——既不生成 __init__ 参数，也不注入 __dict__，甚至不会出现在 attrs.fields(Person) 的结果中。试图访问 p.my_class_var 自然抛出 AttributeError。