Pydantic模型中循环引用与缓存属性的显示问题解析

问题背景

在使用Pydantic V2构建树形结构数据模型时，开发者可能会遇到一个特殊的技术问题：当模型包含父子循环引用关系，同时又使用了cached_property作为计算字段时，尝试打印或显示模型实例会导致RuntimeError: dictionary changed size during iteration异常。

问题现象

考虑以下典型场景：我们构建一个树形结构模型，其中每个节点可以有一个父节点和多个子节点，同时节点上定义了一个需要复杂计算但结果可缓存的属性：

from pydantic import BaseModel, computed_field
from functools import cached_property

class TreeNode(BaseModel):
    parent: 'TreeNode' | None = None
    children: list['TreeNode'] = []

    @computed_field
    @cached_property
    def expensive_computation(self) -> bool:
        # 模拟耗时计算
        return True

当创建并打印这种循环引用的结构时：

root = TreeNode()
child = TreeNode()
root.children.append(child)
child.parent = root

print(root)  # 这里会抛出RuntimeError

系统会抛出运行时错误，提示"dictionary changed size during iteration"。

技术原理分析

这个问题的根本原因在于Pydantic V2的内部实现机制：

1. 模型表示机制：当打印模型实例时，Pydantic会调用__repr__方法，该方法会遍历模型的所有字段来构建字符串表示

2. 缓存属性特性：cached_property装饰器会在首次访问属性时将结果缓存在实例的__dict__中

3. 循环引用处理：在遍历过程中，当遇到尚未计算的cached_property时，访问它会动态地向实例的__dict__添加新条目，而此时Python正在迭代同一个字典，导致"字典在迭代过程中大小改变"的错误

解决方案比较

方案1：使用普通property替代

@property
def expensive_computation(self) -> bool:
    return True

优点：简单直接，避免错误
缺点：失去了缓存优势，每次访问都会重新计算

方案2：预先计算属性

在model_post_init中访问属性：

def model_post_init(self, __context):
    _ = self.expensive_computation

优点：保留了缓存特性
缺点：初始化时就计算所有属性，失去了按需计算的优势

方案3：使用repr参数控制显示

@computed_field(repr=False)
@cached_property
def expensive_computation(self) -> bool:
    return True

优点：简单有效
缺点：该属性不会出现在模型的字符串表示中

方案4：等待官方修复

Pydantic团队已在2.11版本中修复此问题，新版本会正确处理这种场景。

最佳实践建议

1. 对于小型计算或频繁访问的属性，考虑使用方案1的普通property

2. 对于确实需要缓存的重量级计算属性：

   • 如果使用Pydantic ≥2.11，可以直接使用原方案
   • 如果使用旧版本，建议采用方案2的预计算方式

3. 对于调试信息中不需要显示的计算属性，方案3是最简洁的选择

深入理解

这个问题揭示了Python描述符协议与对象表示机制之间的微妙交互。cached_property作为一种描述符，其缓存机制依赖于实例字典的修改，而对象的字符串表示又需要安全地遍历这个字典。Pydantic 2.11的修复方案可能涉及以下改进之一：

1. 在生成表示前预先收集所有需要显示的字段
2. 对字典遍历进行保护，允许安全修改
3. 对缓存属性采用替代存储机制

这种类型的问题在构建复杂数据模型时并不罕见，理解其背后的机制有助于开发者设计更健壮的数据结构。

总结

Pydantic模型中的循环引用与缓存属性组合虽然会引发显示问题，但通过理解其原理和选择合适的解决方案，开发者可以既保持代码清晰性又不牺牲性能。随着Pydantic的持续更新，这类边界情况问题正在得到更好的处理。