Pydantic中私有属性与非原始类型默认值在嵌套模型中的序列化问题

在Python生态系统中，Pydantic作为数据验证和设置管理的强大工具，被广泛应用于各种项目中。然而，在处理包含私有属性和非原始类型默认值的嵌套模型时，开发者可能会遇到一些意料之外的行为。

问题背景

当我们在Pydantic模型中定义私有属性（以单下划线开头）并赋予非原始类型的默认值时，直接序列化该模型实例通常表现正常。但一旦将这个模型作为另一个模型的字段默认值使用时，使用model_dump(exclude_defaults=True)方法进行序列化时就会出现问题。

问题重现

考虑以下示例代码：

import pandas as pd
from pydantic import BaseModel

class A(BaseModel):
    _df: pd.DataFrame = pd.DataFrame([0])

class B(BaseModel):
    a: A = A()

直接序列化A实例可以正常工作：

A().model_dump(exclude_defaults=True)  # 输出: {}

但当尝试序列化B实例时：

B().model_dump(exclude_defaults=True)

这会引发错误，因为Pydantic在比较默认值时尝试对Pandas DataFrame进行相等性比较。

问题根源分析

这个问题的根本原因在于Pydantic处理exclude_defaults参数时的内部机制：

1. 当exclude_defaults=True时，Pydantic需要比较实例值与默认值
2. 对于嵌套模型，它会递归地进行这种比较
3. 在比较过程中，它会访问所有属性，包括私有属性
4. 对于像Pandas DataFrame这样的复杂对象，直接使用==操作符比较可能会引发错误

解决方案探讨

对于这个问题，目前有几种可能的解决方案：

1. 重写__eq__方法：在模型中自定义相等性比较逻辑，避免直接比较复杂对象

class A(BaseModel):
    _df: pd.DataFrame = pd.DataFrame([0])
    
    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return NotImplemented
        return self.model_dump() == other.model_dump()

2. 避免使用复杂对象作为默认值：改用None作为默认值，在实例化时再赋值

3. 不使用exclude_defaults：改为显式指定需要排除的字段

最佳实践建议

基于Pydantic的设计理念和使用经验，我们建议：

1. 对于包含复杂对象的私有属性，尽量避免直接作为模型字段的默认值
2. 如果必须使用，考虑实现自定义的相等性比较逻辑
3. 在设计模型时，预先考虑序列化场景，特别是当模型会被嵌套使用时
4. 对于Pandas DataFrame等特殊对象，可以封装为属性，提供更可控的访问方式

总结

Pydantic虽然在大多数情况下提供了优雅的数据验证和序列化方案，但在处理复杂场景时仍需要开发者深入理解其内部机制。通过合理设计模型结构和自定义比较逻辑，可以规避这类问题，构建更健壮的数据处理流程。

理解这些边界情况不仅能帮助我们更好地使用Pydantic，也能加深对Python数据模型和对象序列化的理解，在更广泛的开发场景中做出更明智的设计决策。