pydantic v2 如何让字段值根据另一个字段自动计算

Pydantic v2 中推荐用 @computed_field 实现字段动态计算,该字段只读、运行时计算、不参与初始化和默认序列化;若需存入模型并序列化,则用 @field_validator(mode="after") 补全字段。

Pydantic v2 中不能直接像 v1 那样用 @validator 在赋值时动态计算字段,但可以通过 @field_validator(配合 mode="before""after")或更推荐的方式——使用 @computed_field 来实现“根据其他字段自动计算”的需求。

@computed_field 声明派生字段(推荐)

这是 Pydantic v2 引入的专门用

于定义只读、运行时计算字段的机制。它不参与模型初始化输入,只在访问时动态计算,适合纯派生值(如 fullname、total_price、is_valid 等)。

  • 计算逻辑写在方法体中,直接读取 self 上的其他字段
  • 需加上 @computed_field 装饰器,并标注返回类型(类型提示必须明确)
  • 该字段不会出现在 model_dump() 默认输出中,除非显式传参 include_computed=True

示例:

from pydantic import BaseModel, computed_field

class User(BaseModel): first_name: str last_name: str

@computed_field
@property
def full_name(self) -> str:
    return f"{self.first_name} {self.last_name}"

u = User(first_name="Alice", last_name="Smith") print(u.full_name) # "Alice Smith" print(u.model_dump()) # {'first_name': 'Alice', 'last_name': 'Smith'} print(u.model_dump(include_computed=True)) # {'first_name': 'Alice', 'last_name': 'Smith', 'full_name': 'Alice Smith'}

@field_validator 在解析后补全字段(适合需要存入模型的数据)

如果希望计算结果也作为模型的一个“真实字段”被序列化、校验、参与后续逻辑(比如数据库映射),可以用 @field_validator + mode="after",在所有字段解析完成后手动设置目标字段。

  • 装饰器作用于待填充的字段名(如 "full_name"
  • mode="after" 表示在所有字段已解析完毕后触发,此时可安全访问 valuesself
  • 需返回计算后的值(不能修改 self,要通过 info.data 或返回值方式注入)

示例:

from pydantic import BaseModel, field_validator

class User(BaseModel): first_name: str last_name: str full_name: str # 这个字段不再由用户传入,而是自动填充

@field_validator('full_name', mode='after')
@classmethod
def set_full_name(cls, v, info):
    # 如果 v 已提供,就用它;否则根据其他字段生成
    if v is None or v == "":
        data = info.data
        return f"{data['first_name']} {data['last_name']}"
    return v

使用时可不传 full_name,它会自动补上

u = User(first_name="Bob", last_name="Lee") print(u.full_name) # "Bob Lee" print(u.model_dump()) # {'first_name': 'Bob', 'last_name': 'Lee', 'full_name': 'Bob Lee'}

注意:避免在 mode="before" 中依赖未解析字段

mode="before" 在字段解析前执行,此时其他字段可能还未处理,无法可靠读取。除非你明确控制输入结构(如统一传 dict),否则不建议在此模式下做跨字段计算。

  • 例如:想用 email 自动生成 username,但 email 字段本身还没被验证或转换,容易出错
  • 优先选 mode="after"@computed_field

小技巧:结合 default_factory 实现轻量默认计算(仅限初始化时)

如果只是想在字段未提供时“按需生成一次”,且不需要响应其他字段变化,可用 default_factory

from pydantic import BaseModel, Field
from datetime import datetime

class LogEntry(BaseModel): message: str created_at: datetime = Field(default_factory=datetime.now)

注意:这跟其他字段无关,只是时间戳默认值

但它不构成字段间依赖关系,不属于“根据另一个字段计算”。