使用python的mock patch.object来更改另一个方法中调用的方法的返回值

时间:2013-08-12 15:46:29

标签: python unit-testing mocking patch

是否可以模拟在我试图测试的另一个函数中调用的函数的返回值?我希望模拟的方法(我将在我测试的许多方法中调用)在每次调用时返回指定的变量。例如:

class Foo:
    def method_1():
       results = uses_some_other_method()
    def method_n():
       results = uses_some_other_method()

在单元测试中,我想使用mock更改uses_some_other_method()的返回值,以便在Foo中调用它时,它将返回我在{{1}中定义的内容}

4 个答案:

答案 0 :(得分:76)

有两种方法可以做到这一点;有补丁和patch.object

Patch假定您没有直接导入对象,而是正在测试的对象使用它,如下所示

#foo.py
def some_fn():
    return 'some_fn'

class Foo(object):
    def method_1(self):
        return some_fn()

#bar.py
import foo
class Bar(object):
    def method_2(self):
        tmp = foo.Foo()
        return tmp.method_1()

#test_case_1.py
import bar
from mock import patch

@patch('foo.some_fn')
def test_bar(mock_some_fn):
    mock_some_fn.return_value = 'test-val-1'
    tmp = bar.Bar()
    assert tmp.method_2() == 'test-val-1'
    mock_some_fn.return_value = 'test-val-2'
    assert tmp.method_2() == 'test-val-2'

如果要直接导入要测试的模块,可以按如下方式使用patch.object:

#test_case_2.py
import foo
from mock import patch

@patch.object(foo, 'some_fn')
def test_foo(test_some_fn):
    test_some_fn.return_value = 'test-val-1'
    tmp = foo.Foo()
    assert tmp.method_1() == 'test-val-1'
    test_some_fn.return_value = 'test-val-2'
    assert tmp.method_1() == 'test-val-2'

在这两种情况下,在测试功能完成后,some_fn将被“未模拟”。

编辑: 为了模拟多个函数,只需向函数添加更多装饰器并添加参数以获取额外参数

@patch.object(foo, 'some_fn')
@patch.object(foo, 'other_fn')
def test_foo(test_other_fn, test_some_fn):
    ...

请注意,装饰器越接近函数定义,它就越早在参数列表中。

答案 1 :(得分:12)

这可以通过以下方式完成:

# foo.py
class Foo:
    def method_1():
        results = uses_some_other_method()


# testing.py
from mock import patch

@patch('Foo.uses_some_other_method', return_value="specific_value"):
def test_some_other_method(mock_some_other_method):
    foo = Foo()
    the_value = foo.method_1()
    assert the_value == "specific_value"

以下是您可以阅读的来源:Patching in the wrong place

答案 2 :(得分:5)

让我澄清一下你在说什么:你想在测试用例中测试Foo,它调用外部方法uses_some_other_method。您想要模拟返回值,而不是调用实际方法。

class Foo:
    def method_1():
       results = uses_some_other_method()
    def method_n():
       results = uses_some_other_method()

好的,假设上面的代码在foo.py中,uses_some_other_method在模块bar.py中定义。这是unittest:

import unitest
import mock

from foo import Foo


class TestFoo(unittest.TestCase):

    def setup(self):
        self.foo = Foo()

    @mock.patch('foo.uses_some_other_method')
    def test_method_1(self, mock_method):
        mock_method.return_value = 3
        self.foo.method_1(*args, **kwargs)

        mock_method.assert_called_with(*args, **kwargs)

如果您想在每次传入不同的参数时更改返回值,mock提供side_effect

答案 3 :(得分:0)

要增加Silfheed的答案(这很有用),我需要修补有问题的对象的多种方法。我发现这样做比较优雅:

给出位于module.a_function.to_test.py的以下功能进行测试:

from some_other.module import SomeOtherClass

def add_results():
    my_object = SomeOtherClass('some_contextual_parameters')
    result_a = my_object.method_a()
    result_b = my_object.method_b()
    
    return result_a + result_b

要测试此功能(或类方法,没关系),可以结合使用SomeOtherClasspatch.object()来修补类sys.modules的多个方法:

@patch.object(sys.modules['module.a_function.to_test'], 'SomeOtherClass')
def test__should_add_results(self, mocked_other_class):
  mocked_other_class().method_a.return_value = 4
  mocked_other_class().method_b.return_value = 7

  self.assertEqual(add_results(), 11)

无论您需要打补丁的SomeOtherClass方法数量如何,它都具有独立的结果。

此外,使用相同的修补方法,如果需要,可以返回SomeOtherClass的实际实例:

@patch.object(sys.modules['module.a_function.to_test'], 'SomeOtherClass')
def test__should_add_results(self, mocked_other_class):
  other_class_instance = SomeOtherClass('some_controlled_parameters')
  mocked_other_class.return_value = other_class_instance 
  ...