使用Pydantic BaseModel时如何让None值属性不生成

需求说明：希望类实例在属性值为None时，该属性直接不存在（访问会报错），仅当传入有效值时才生成该属性。传统OOP的实现示例如下：

class C(object):
    def __init__(self, c, t=None):
        self.c = c
        if t:
            self.t = t

c1 = C(c=1, t=2)
print(c1.t) # 输出2
c1 = C(c=1)
print(c1.t) # 抛出错误

尝试用Pydantic实现时遇到两个问题：

• 未定义t字段的写法，无论是否传t，访问c1.t都会报错
• 使用model_config = ConfigDict(extra='allow')会允许所有额外参数，不符合仅支持t一个可选属性的要求

正确实现方式 #

通过定义可选字段t，并在初始化后删除值为None的属性，既明确支持t参数，又满足需求：

from pydantic import BaseModel
from typing import Optional

class C(BaseModel):
    c: int
    t: Optional[int] = None

    def model_post_init(self, __context) -> None:
        if self.t is None:
            delattr(self, 't')

# 验证效果
c1 = C(c=1, t=2)
print(c1.t)  # 输出 2
c2 = C(c=1)
print(c2.t)  # 抛出 AttributeError: 'C' object has no attribute 't'

说明 #

• 显式定义t: Optional[int] = None，明确这是唯一允许的可选属性，避免extra='allow'带来的任意参数问题
• 利用Pydantic的model_post_init钩子，在实例初始化完成后检查t的值，若为None则删除该属性，实现和传统OOP一致的效果

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