Python unittest mock：测试时可以伪造方法默认参数的值吗？

Question

我有一个方法，它可以接受默认参数：

def build_url(endpoint, host=settings.DEFAULT_HOST):
    return '{}{}'.format(host, endpoint)

我有一个测试案例来测试这个方法：

class BuildUrlTestCase(TestCase):
    def test_build_url(self):
        """ If host and endpoint are supplied result should be 'host/endpoint' """

        result = build_url('/end', 'host')
        expected = 'host/end'

        self.assertEqual(result,expected)

     @patch('myapp.settings')
     def test_build_url_with_default(self, mock_settings):
        """ If only endpoint is supplied should default to settings"""
        mock_settings.DEFAULT_HOST = 'domain'

        result = build_url('/end')
        expected = 'domain/end'

        self.assertEqual(result,expected)

如果我在build_url里设置一个调试点，查看这个属性settings.DEFAULT_HOST，它会返回我模拟的值。但是测试还是失败了，断言显示host被赋值为我实际的settings.py里的值。我知道这是因为host这个关键字参数是在导入时就设置好的，而我的模拟值没有被考虑进去。

调试器

(Pdb) settings
<MagicMock name='settings' id='85761744'>                                                                                                                                                                                               
(Pdb) settings.DEFAULT_HOST
'domain'
(Pdb) host
'host-from-settings.com'                                                                                                                                                 

有没有办法在测试时覆盖这个值，这样我就可以用一个模拟的settings对象来测试默认路径呢？

Answer 1

我参考了其他人对这个问题的回答，但在使用上下文管理器之后，我的修补函数和之前的不一样了。

我的修补函数看起来是这样的：

def f(foo=True):
    pass

在我的测试中，我做了这个：

with patch.object(f, 'func_defaults', (False,)):

在上下文管理器之外调用 f 时，默认值完全消失了，而不是恢复到之前的值。调用 f 而不传参数时出现了错误 TypeError: f() takes exactly 1 argument (0 given)

相反，我在测试之前做了这个：

f.func_defaults = (False,)

在测试之后我又做了这个：

f.func_defaults = (True,)

Answer 2

还有一种替代的方法：可以使用functools.partial来提供你想要的“默认”参数。这并不是说技术上完全一样，因为被调用的函数会看到一个明确的参数，但调用者不需要提供这个参数。大多数情况下，这样做已经足够接近了，而且在上下文管理器退出后，它会正确处理事情：

# mymodule.py
def myfunction(arg=17):
    return arg

# test_mymodule.py
from functools import partial
from mock import patch

import mymodule

class TestMyModule(TestCase):
    def test_myfunc(self):
        patched = partial(mymodule.myfunction, arg=23)
        with patch('mymodule.myfunction', patched):
            self.assertEqual(23, mymodule.myfunction())  # Passes; default overridden
        self.assertEqual(17, mymodule.myfunction()) # Also passes; original default restored

我在测试时用这个来覆盖默认的配置文件位置。要给出信用，我的这个想法是从Danilo Bargen那里得到的，具体可以在这里找到。

Answer 3

函数在定义的时候，会把它们的参数默认值存储在一个叫做 func_defaults 的属性里，所以你可以对这个进行修改。比如说：

def test_build_url(self):
    """ If only endpoint is supplied should default to settings"""

    # Use `func_defaults` in Python2.x and `__defaults__` in Python3.x.
    with patch.object(build_url, 'func_defaults', ('domain',)):
      result = build_url('/end')
      expected = 'domain/end'

    self.assertEqual(result,expected)

我使用 patch.object 作为上下文管理器，而不是装饰器，这样可以避免把不必要的补丁对象作为参数传递给 test_build_url。