如何在 attrs 子类中复用父类验证器并安全设置默认值

如何在 attrs 子类中复用父类验证器并安全设置默认值

本文介绍在使用 attrs 库时，如何让子类继承父类字段的验证逻辑（如类型检查与业务规则），同时为该字段声明安全的默认值，避免绕过验证或重复定义。

在使用 `attrs` 库构建类层次结构时，一个常见的需求是：子类想继承父类某个字段的全部验证逻辑，同时又想给它一个不同的默认值。这事儿听起来简单，但若操作不当，很容易掉进坑里——父类精心设计的验证器会瞬间失效，导致数据完整性出现漏洞。

问题出在哪呢？如果你在子类里简单地重写一个带默认值的同名字段，比如写成 `num_wheels: int = 4`，那么父类中通过 `field()` 配置的整套元数据（包括验证器 `validator` 和转换器 `converter`）就会被完全覆盖。后果就是，像 `Car(num_wheels=-1)` 或 `Car(num_wheels="four")` 这类非法输入，将再也无法被拦截，防护大门就此敞开。

那么，正确的做法是什么？核心原则是：复用父类已有的字段定义，仅覆盖其默认值，同时确保所有附加的元数据（尤其是验证器）得以保留。

attrs 库提供了 `field(default=...)` 和 `field(factory=...)` 两种设置默认值的方式，但要安全生效，通常需要配合 `attr.evolve()` 或重写 `__init__` 方法。不过，最简洁、也最符合 attrs 设计哲学的方式其实是下面这种：使用 `field(default=...)`，并确保子类不通过简单赋值来重新声明字段，而是显式调用 `attrs.field()` 来继承并仅覆盖默认值。

from attrs import define, field, validators

@define(kw_only=True)
class Vehicle:
    num_wheels: int = field(
        validator=[
            validators.instance_of(int),
            lambda inst, attr, value: _validate_positive(inst, attr, value)
        ]
    )

def _validate_positive(inst, attr, value):
    if value <= 0:
        raise ValueError(f"{attr.name} must be greater than 0")

@define(kw_only=True)  # 注意：为保持一致性，子类也建议显式声明 kw_only=True
class Car(Vehicle):
    # ✅ 正确做法：用 field(default=...) 复用父类字段，保留全部 validator
    num_wheels: int = field(default=4, converter=int)

@define(kw_only=True)
class Motorbike(Vehicle):
    num_wheels: int = field(default=2, converter=int)

实现起来不难，但有几个关键点必须警惕：

⚠️ 关键注意事项

• 切忌在子类中直接写 `num_wheels: int = 4`：这等同于创建了一个全新的字段，父类所有的 `field` 配置都会丢失。
• 必须显式使用 `field(default=...)`：这是 attrs 官方支持的、唯一能实现“继承并覆盖默认值”的机制。
• 建议在子类中也显式声明 `kw_only=True`：这能避免因父类参数顺序问题而影响初始化行为，保持一致性。
• 如果需要动态默认值（比如依赖其他属性），可以考虑改用 `field(factory=lambda: ...)`，但要注意，工厂函数内部无法访问 `self`。
• 验证器的触发时机是始终如一的：无论是在对象构造时、使用 `evolve` 方法时，还是手动给属性赋值时，验证都会生效。因此，无论是 `Car()`、`Car(num_wheels=3)` 还是 `Car(num_wheels=-1)`，都会受到同样的规则约束，非法值会立即引发 `ValueError`。

? 进阶提示

如果某个字段（比如 `num_wheels`）在语义上是一个类级别的常量（例如所有 `Car` 实例都固定为 4），那么更贴合语义的设计或许是将其改为 `ClassVar[int]`，并在 `__attrs_post_init__` 方法中进行校验。不过，这种做法会让字段脱离 attrs 的字段级验证流程，更适用于只读场景。而本文所介绍的方案，则完整保留了字段的可变性以及统一的强验证机制，是生产环境中更为推荐的实践。