如何让Pydantic在字段更新时验证且构造时保留可选字段

问题描述 #

我有一个简单的Pydantic类，包含1个可选字段和1个带约束的必填字段。需求是：

• 带约束的字段在创建和更新时都能被验证
• 可选字段保持可选性，创建实例时无需传入

遇到的问题：

• 不设置validate_assignment=True时，创建实例可以不传可选字段，但更新带约束字段时不会触发验证（比如允许执行s3_target.target = 'BadPath'）
• 设置validate_assignment=True的dataclass配置后，创建实例时必须传入可选字段，不符合需求

代码示例（存在问题的写法）：

from pydantic.dataclasses import dataclass
from pydantic import BaseModel, constr

from pydantic.class_validators import Optional

class MyConfig:
    validate_assignment = True


@dataclass(config=MyConfig)
class S3Target(BaseModel):
    table_key: Optional[str] = None
    target: constr(regex=r'^s3://([^/]+)/(.*?([^/]+))/$')


s3_target = S3Target(target='s3://bucket/location/')
s3_target.target = 'BadPath'

解决方案 #

方案1：使用纯BaseModel（推荐） #

Pydantic的BaseModel本身支持字段验证和赋值验证，无需混用@dataclass装饰器，调整后即可满足需求：

from pydantic import BaseModel, constr
from typing import Optional  # Python <3.10 版本使用；Python 3.10+ 可直接写 str | None

class S3Target(BaseModel):
    # 启用赋值验证
    model_config = {"validate_assignment": True}
    
    table_key: Optional[str] = None  # 保持可选性，默认值为None
    # 带正则约束的必填字段，创建和更新都会验证
    target: constr(regex=r'^s3://([^/]+)/(.*?([^/]+))/$')


# 创建实例时无需传入table_key，正常通过
s3_target = S3Target(target='s3://bucket/location/')
# 下面这行代码会触发ValidationError，符合预期（阻止非法赋值）
# s3_target.target = 'BadPath'

方案2：使用Pydantic Dataclass（若坚持用dataclass） #

如果一定要用pydantic.dataclasses.dataclass，不要继承BaseModel（两者混合会导致字段处理逻辑冲突），正确写法如下：

from pydantic.dataclasses import dataclass
from pydantic import constr
from typing import Optional

class MyConfig:
    validate_assignment = True

@dataclass(config=MyConfig)
class S3Target:
    table_key: Optional[str] = None
    target: constr(regex=r'^s3://([^/]+)/(.*?([^/]+))/$')


# 创建实例无需传入table_key，正常通过
s3_target = S3Target(target='s3://bucket/location/')
# 非法赋值会触发验证错误，符合需求
# s3_target.target = 'BadPath'

关键修正点 #

1. 移除冗余继承/装饰器混合：避免同时使用@dataclass和继承BaseModel，两者的字段处理逻辑会冲突，导致可选字段被错误判定为必填。
2. 修正Optional导入：Optional应从typing模块导入（Python<3.10），或直接使用str | None（Python3.10+），而非pydantic.class_validators。
3. 正确配置验证开关：在BaseModel的model_config或dataclass的config中设置validate_assignment=True，确保赋值时触发字段约束验证。

内容的提问来源于stack exchange，提问作者inspector00