Python MagicMock测试异常：side_effect赋值引发StopIteration问题

问题核心原因 #

你的测试结果差异完全来自于Mock中side_effect的迭代规则：

• 当side_effect被设为列表/迭代器时，Mock方法每次调用会按顺序取出列表中的一个元素返回；一旦列表元素被取完，后续调用会直接抛出*StopIteration*异常。
• test_get_dummy1报错的原因：被测逻辑中至少有一个TstObj实例的search方法被调用了超过1次，但你给它的side_effect是单元素列表，第二次调用时列表已空，触发异常。
• test_get_dummy2通过的原因：你仅给object1的search设了3元素的side_effect，刚好匹配被测逻辑中它被调用的次数（3次）；另外两个对象的search没设置side_effect，默认每次调用返回Mock实例（不会因调用次数触发异常），自然不会报错。

Mock核心知识点 #

1. side_effect的三种常用用法 #

• 列表/迭代器：按顺序返回元素，取完抛*StopIteration*（就是你遇到的情况）
• 自定义函数：每次调用Mock方法时，会执行该函数并返回其结果，也可以在函数中抛出指定异常
• 异常类/实例：每次调用Mock方法都会抛出该异常

2. 默认Mock行为 #

如果不给Mock方法设置side_effect或return_value，每次调用会返回一个新的Mock实例，无论调用多少次都不会触发异常。

3. 避免*StopIteration*的实用技巧 #

• 如果需要多次调用返回同一个固定值，直接用return_value替代单元素列表的side_effect，比如：

  mock_search.return_value = 1
  

• 如果需要循环返回列表中的元素，可以用itertools.cycle()把列表转为无限迭代器，比如：

  import itertools
  mock_search.side_effect = itertools.cycle([1,2])
  

  这样调用时会循环取1、2、1、2...永远不会抛异常

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