如何实现Pydantic模型属性默认值依赖另一属性且类型正确？

问题描述 #

需要定义一个Pydantic BaseModel，满足以下要求：

• 包含两个int类型属性a和b
• a为必填属性
• b为可选属性，未设置时默认值为a + 1

尝试的代码中，b被标注为Optional[int]，但实际构造实例后b永远不会是None，因此类型标注应该为int而非Optional[int]，需要找到合适的实现方式。

解决方案 #

Pydantic V1 实现 #

直接将b的类型标注为int，配合validator确保默认值逻辑生效：

from pydantic import BaseModel, validator

class A(BaseModel):
    a: int
    b: int = None  # 类型设为int，默认值None由验证器处理
    
    @validator('b', always=True)
    def default_b_value(cls, b, values):
        if b is None:
            return values['a'] + 1
        return b

测试示例：

# 未传入b，自动赋值为a+1
instance1 = A(a=5)
print(instance1.b)  # 输出: 6
print(type(instance1.b))  # 输出: <class 'int'>

# 传入b时使用指定值
instance2 = A(a=5, b=10)
print(instance2.b)  # 输出: 10

Pydantic V2 实现 #

使用V2推荐的field_validator或model_validator实现，逻辑更清晰：

方式1：field_validator

from pydantic import BaseModel, field_validator

class A(BaseModel):
    a: int
    b: int = None
    
    @field_validator('b', mode='before')
    def default_b_value(cls, b, info):
        if b is None:
            return info.data['a'] + 1
        return b

方式2：model_validator

from pydantic import BaseModel, model_validator

class A(BaseModel):
    a: int
    b: int = None
    
    @model_validator(mode='after')
    def set_default_b(self):
        if self.b is None:
            self.b = self.a + 1
        return self

说明：

• V2中可以使用int | None（Python 3.10+）作为临时类型标注，但运行时b最终会是int，直接标注为int更符合实际类型情况。
• mode='before'确保在字段验证阶段就替换默认值，mode='after'则在模型实例化后修正字段值，两种方式都能满足需求。

核心要点 #

• 将b的类型标注为int，而非Optional[int]，匹配实际运行时的类型。
• 通过验证器强制处理默认值逻辑，确保即使未传入b，也会自动赋值为a + 1，不会出现None的情况。

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