Question

我有以下功能，我使用doctest进行单元测试。

from collections import deque

def fill_q(histq=deque([])):
    """
    >>> fill_q()
    deque([1, 2, 3])
    >>> fill_q()
    deque([1, 2, 3])
    """
    if histq:
        assert(len(histq) == 0)
    histq.append(1)
    histq.append(2)
    histq.append(3)
    return histq

if __name__ == "__main__":
    import doctest
    doctest.testmod()

第一种情况通过，但第二次调用fill_q失败，但它是相同的代码：

**********************************************************************
File "trial.py", line 7, in __main__.fill_q
Failed example:
    fill_q()
Exception raised:
    Traceback (most recent call last):
      File "/usr/lib/python2.7/doctest.py", line 1289, in __run
        compileflags, 1) in test.globs
      File "<doctest __main__.fill_q[1]>", line 1, in <module>
        fill_q()
      File "trial.py", line 11, in fill_q
        assert(len(histq) == 0)
    AssertionError
**********************************************************************
1 items had failures:
   1 of   2 in __main__.fill_q
***Test Failed*** 1 failures.

看起来doctest在第一次测试调用中重用了本地变量histq，为什么要这样做呢？这是非常愚蠢的行为（假如这不是我在这里做的疯狂）。

Answer 1

你犯了一个非常常见的Python错误 - 如果你将一个对象设置为函数的默认构造函数it will not be reinitialized on the next invocation of that function - 并且对该对象的任何更改都将在函数调用中持续存在。

避免此问题的更好策略是将默认值设置为某个已知值，并检查它：

def fill_q(histq=None):
    if histq is None:
        histq = deque([])
    ...

Answer 2

问题不在于doctest，而是在def fill_q(histq=deque([]))中使用的默认参数。它类似于：

>>> from collections import deque
>>> 
>>> def fill_q(data=deque([])):
...     data.append(1)
...     return data
... 
>>> fill_q()
deque([1])
>>> fill_q()
deque([1, 1])
>>> fill_q()
deque([1, 1, 1])

当您使用可变对象作为列表或字典等默认值时，会出现这种看似奇怪的行为。它实际上使用相同的对象：

>>> id(fill_q())
4485636624
>>> id(fill_q())
4485636624
>>> id(fill_q())
4485636624

<强>为什么吗

默认参数值总是在且仅当它们所属的def语句执行时才会被评估[ref]。

如何避免这个错误：

使用None作为默认参数，或者使用任意对象：

my_obj = object()
def sample_func(value=my_obj):
    if value is my_obj:
        value = expression
    # then modify value

何时使用？：

全球名称的本地重新绑定：

import math

def fast_func(sin=math.sin, cos=math.cos):

可用于记忆（例如，使某些递归运行得更快）

Python doctest执行上下文

2 个答案: