Python 如何用 dataclass 实现带验证的字段(不依赖 pydantic)

dataclass字段验证必须在__post_init__中实现,因其无原生校验机制;需手动检查如非空、邮箱含@、密码长度等,并用ValueError抛异常。

dataclass 字段验证必须靠 __post_init__

Python 原生 dataclass 不提供字段级校验机制,field(default=...)field(default_factory=...) 只管默认值,不拦非法输入。真正能插手初始化后、实例化完成前的唯一钩子是 __post_init__ —— 所有验证逻辑必须写在这里。

注意:它在 __init__ 之后立即执行,此时所有字段已赋值(包括你传进来的参数),所以可以安全访问 self.xxx

  • 不要在 __post_init__ 里调用 super().__post_init__()dataclass 没这个父类方法)
  • 如果用了 init=False 的字段,它不会出现在 __init__ 参数中,但会在 __post_init__ 里存在,可用来做派生字段或内部状态
  • 抛异常建议用 ValueError,符合 Python 惯例,也方便调用方捕获

字符串长度和非空验证怎么写

常见需求:用户名不能空、邮箱需含 @、密码至少 8 位。这些都得手动检查,没有声明式语法。

@dataclass
class User:
    name: str
    email: str
    password: str

    def __post_init__(self):
        if not self.name or not self.name.strip():
            raise ValueError("name cannot be empty")
        if "@" not in self.email:
            raise ValueError("email must contain '@'")
        if len(self.password) < 8:
            raise ValueError("password must be at least 8 characters")
  • self.name.strip() 要做,否则传入 " " 会绕过空判断
  • 邮箱简单用 "@" in self.email 是够用的起点,但别当真实邮箱校验 —— 它不防 "a@b@c" 或无域名的情况
  • 如果字段是 Optional[str],先判 is None,再判内容,顺序错了会抛 AttributeError

数值范围和类型兼容性容易踩的坑

dataclass 不做运行时类型强制,比如声明 age: int,但传 "25" 进来,字段值就是字符串,不会自动转。验证时得自己处理类型转换或拒绝。

  • 别依赖类型注解做校验:Python 运行时不读类型提示,age: int 对运行没约束力
  • 想支持字符串数字输入?得在 __post_init__ 里显式 int(self.age) 并捕获 ValueError,再重新赋值或报错
  • 范围检查如 if not (0 要放在类型确认之后,否则 self.age 可能是字符串,比较会静默失败(Python 3 中 str 和 int 比较抛 TypeError
  • 浮点数精度问题:用 math.isclose 判断相等,不用 == 直接比 0.1 + 0.2

验证失败时如何保留原始参数供调试

直接抛 ValueError("xxx") 有时不够,尤其字段多、嵌套深时,不知道到底是哪个参数触发了失败。可以在异常信息里带上下文。

def __post_init__(self):
    if len(self.password) < 8:
        raise ValueError(f"password too short: {repr(self.password)} (len={len(self.password)})")
  • repr() 包裹值,能看清空格、换行、None 等不可见字符
  • 如果字段来自外部 API(比如 JSON),建议在实例化前先用 dict 打印原始输入,验证失败时对比更准
  • 避免在 __post_init__ 里改字段值来“修复”输入(比如自动 strip()),这会让行为不透明;要么明确允许,要么

    严格拒绝
字段验证这件事,在原生 dataclass 里始终是手写逻辑+人工覆盖,没有魔法。最易忽略的是类型与值的分离 —— 注解不是契约,__post_init__ 也不是银弹,每条规则都得自己想清楚边界条件。