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

函数在定义函数时将其参数默认值存储在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。

Answer 2

我对这个问题应用了另一个答案，但是在上下文管理器之后，修补的功能与以前不同。

我的补丁函数如下所示：

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 3

另一种方法：使用 functools.partial 提供您想要的“默认”参数。这与覆盖它们技术上不同。被调用者看到一个明确的 arg，但调用者不必提供它。这在大多数情况下已经足够接近，并且在上下文管理器退出后它会做正确的事情：

# 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 here 那里得到了这个想法