在 Python 单元测试中使用 mock 模拟函数返回值（含多个返回值和用户输入模拟）

2024-03-26 04:18:54

在 Python 中使用 Mock 模拟多次返回值

引言

在单元测试中，模拟外部函数或方法的返回值至关重要。Python 的 mock 模块提供了强大的 patch 装饰器，它允许我们用模拟对象覆盖代码中的函数或方法，从而进行灵活的测试。本篇文章将深入探讨如何使用 mock 模块来模拟没有输入的函数的多个返回值，并介绍如何利用 MagicMock 对象来模拟用户输入。

模拟没有输入的函数的多个返回值

对于没有输入的函数，直接使用 return_value 属性来模拟返回值是无效的。相反，我们可以使用 side_effect 属性。side_effect 是一个可迭代对象或函数，它指定了当被模拟函数被调用时要返回的值。

示例：

考虑以下函数 get_boolean_response()：

def get_boolean_response():
    response = io.prompt('y/n').lower()
    while response not in ('y', 'n', 'yes', 'no'):
        io.echo('Not a valid input. Try again')
        response = io.prompt('y/n').lower()

    return response in ('y', 'yes')

为了模拟这个函数的多个返回值，我们可以使用如下代码：

@mock.patch('io')
def test_get_boolean_response(self, mock_io):
    # 设置模拟返回值的迭代器
    mock_io.prompt.side_effect = ['x', 'y']

    # 执行被测函数
    result = operations.get_boolean_response()

    # 断言结果并验证模拟函数的调用次数
    self.assertTrue(result)
    self.assertEqual(mock_io.prompt.call_count, 2)

在模拟对象上设置 side_effect 迭代器后，当被模拟函数被调用时，它将返回迭代器中的第一个值。之后，它将返回迭代器中的下一个值，依此类推。在这种情况下，当 get_boolean_response() 函数被调用时，它将返回 "x"，然后返回 "y"。

模拟用户输入

另一种模拟用户输入的方法是使用 mock.MagicMock 类。MagicMock 是一个灵活的模拟对象，它可以动态地模拟任何方法或属性。

示例：

为了模拟 io.prompt 函数并返回特定的用户输入，我们可以使用如下代码：

@mock.patch('io')
def test_get_boolean_response(self, mock_io):
    # 创建 MagicMock 对象并模拟 prompt 方法
    mock_prompt = mock.MagicMock(return_value='y')
    mock_io.prompt = mock_prompt

    # 执行被测函数
    result = operations.get_boolean_response()

    # 断言结果并验证模拟函数的调用次数
    self.assertTrue(result)
    self.assertEqual(mock_prompt.call_count, 1)

在这里，我们创建了一个 MagicMock 对象 mock_prompt，并用它覆盖 mock_io.prompt 属性。当 get_boolean_response() 函数调用 io.prompt 时，它实际上会调用 mock_prompt，后者返回 "y" 值。

结论

模拟外部函数或方法的返回值是单元测试中的一个关键技术。通过使用 mock 模块的 patch 装饰器和 side_effect 和 MagicMock 类，我们可以有效地模拟各种情况，包括模拟没有输入的函数的多个返回值和模拟用户输入。这些技术使我们能够全面而准确地测试我们的代码，并提高代码的质量和可靠性。