如何在Python pytest中优雅地测试包含循环引用的复杂对象？-Python教程-PHP中文网

pytest 默认断言失败时会调用 repr() 渲染对象，而循环引用会导致无限递归或 RecursionError；解决方案包括：用 deepdiff 替代 ==、临时 patch __repr__、或编写语义级断言函数并配合 --tb=short。

如何在python pytest中优雅地测试包含循环引用的复杂对象？

为什么 `pytest` 默认会卡在循环引用对象的断言里？

因为 pytest 在失败时自动调用 repr() 或 pprint() 渲染预期值与实际值，而含循环引用的对象（比如 A 持有 B，B 又持有 A）会让 repr 无限递归展开，最终触发 RecursionError: maximum recursion depth exceeded 或直接卡死。

这不是你代码逻辑错，是 pytest 的断言辅助机制“太尽责”了。

典型触发场景：assert obj1 == obj2，其中 obj1 和 obj2 是手动构造的带父子双向引用的模型实例（如 SQLAlchemy 模型、自定义树节点）
哪怕你重写了 __eq__，只要 pytest 尝试展示差异，就可能掉进 repr 坑里
pytest -s 也救不了——输出被阻塞在内部格式化阶段，根本到不了你的 print

用 `deepdiff` 替代原生 `==` 断言

deepdiff 默认跳过循环引用检测，且支持显式控制遍历深度和忽略字段，是目前最轻量、最可控的替代方案。

安装：pip install deepdiff
基本用法：from deepdiff import DeepDiff; assert not DeepDiff(a, b, ignore_order=True, report_repetition=True)
关键参数：
- ignore_order=True：避免因 list 顺序不同误报（常见于 children 列表）
- max_diff_depth=5：防深层嵌套失控（默认无限制）
- exclude_paths=["root._parent", "root._children"]：直接过滤掉已知循环字段
注意：DeepDiff 返回 dict，空 dict 表示相等，所以必须写 assert not DeepDiff(...)，而不是 assert DeepDiff(...) == {}（后者在 diff 很大时可能慢且不直观）

给测试对象加临时 `repr` 防护

如果你无法引入第三方库，或只想快速让现有测试跑通，可以在测试 setup 阶段为对象打一个“安全 repr 补丁”，不改生产代码，只影响当前测试上下文。

python学习

Python 编程学习助手 skill，面向零基础用户。当用户表达以下意图时触发： - 学习 Python 基础概念（变量、数据类型、循环、函数、类等） - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导（爬虫、数据分析、Web 开发等入门项目） - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载

做法：用 unittest.mock.patch 临时替换类的 __repr__

示例：

from unittest.mock import patch
<p>def test_tree_with_cycle():
root = TreeNode("root")
child = TreeNode("child")
root.add_child(child)
child.parent = root  # 形成循环</p><pre class="brush:php;toolbar:false;">with patch.object(TreeNode, "__repr__", lambda self: f"<treenode>"):
    assert root.children == [child]  # 此时 assert 不再崩溃</treenode>

⚠️ 注意：patch 要作用在类上，不是实例；且仅对当前测试块生效，不影响其他测试
不推荐长期使用——它掩盖了真实结构，不利于调试；但作为 CI 临时兜底很有效

用 `pytest --tb=short` + 自定义断言函数规避渲染

当对象结构极其复杂、连 deepdiff 都难以稳定比对时，退回到语义级断言更可靠：只验证你真正关心的字段路径是否一致，绕过全量结构比较。

写一个极简校验函数，例如：

def assert_node_equal(actual, expected):
    assert actual.name == expected.name
    assert len(actual.children) == len(expected.children)
    for a, e in zip(actual.children, expected.children):
        assert_node_equal(a, e)  # 递归但可控，不依赖 repr