Python中unittest.mock.patch对象的技巧与窍门

unittest.mock是Python标准库中的一个模块，提供了一些工具类和函数，用以进行单元测试中的模拟(mock)和模仿(fixtures)。其中，patch是一个十分强大的函数，它可以动态地替换掉被测试函数中的对象，以达到模拟和控制测试环境的目的。在本文中，我们将介绍一些使用patch对象的技巧和窍门，并提供一些使用例子，以帮助读者更好地理解和使用patch对象。

1. 使用patch的基本方式

使用patch对象的最基本的方式是将其作为装饰器应用到被测试函数上。例如，我们有一个名为add的函数，它接受两个参数并返回它们的和。现在我们想要测试这个函数，并在测试过程中模拟其中的一个参数。以下是一个使用patch对象的基本示例：

from unittest.mock import patch

def add(a, b):
    return a + b

@patch("__main__.add")
def test_add(mock_add):
    mock_add.return_value = 10
    assert add(3, 4) == 10

在上述示例中，我们使用patch函数创建了一个patch对象，并将其作为装饰器应用到了test_add函数上。patch函数的参数是一个字符串，这个字符串指定了被替换对象的位置。在这个例子中，我们将add函数替换为__main__.add，因为测试代码是在模块的主域中执行的。在test_add函数内部，我们可以通过访问mock_add参数来设置被替换函数的返回值。在这个例子中，我们设置返回值为10，并断言add(3, 4)的结果也为10。

2. 使用patch的进阶技巧

使用patch对象的过程中，有几个技巧和窍门是值得注意的：

（1）使用start和stop，手动控制patch对象的生命周期。通常情况下，patch对象会在测试函数开始执行前自动创建，结束后自动销毁。但是，在某些特殊情况下，我们可能希望手动控制patch对象的生命周期，以便于更灵活地进行模拟和控制。我们可以使用start和stop方法来手动创建和销毁patch对象。以下是一个手动控制patch对象生命周期的示例：

from unittest.mock import patch

def add(a, b):
    return a + b

def test_add():
    mock_add = patch("__main__.add")
    mock = mock_add.start()
    mock.return_value = 10
    assert add(3, 4) == 10
    mock_add.stop()

在上述示例中，我们首先创建了一个patch对象，然后调用它的start方法来手动创建patch。接下来，我们可以访问mock_add对象来设置被替换函数的行为，同样地，在测试函数结束时，我们需要调用stop方法来销毁patch对象。

（2）使用side_effect，控制被替换函数的行为。在实际的测试过程中，我们可能希望被替换的函数在每次被调用时返回不同的结果，或者在被调用时抛出异常。我们可以使用side_effect参数来实现这些需求。side_effect参数可以接受一个可调用对象，当被替换函数被调用时，这个可调用对象将被调用，并返回其返回值作为被替换函数的结果。以下是一个使用side_effect的示例：

from unittest.mock import patch

def add(a, b):
    return a + b

@patch("__main__.add")
def test_add(mock_add):
    mock_add.side_effect = lambda a, b: a - b
    assert add(3, 4) == -1

在上述示例中，我们使用lambda函数作为side_effect的参数，当被替换的函数被调用时，这个lambda函数将被调用，并返回a - b的结果。

（3）使用assert_called_once_with，验证被替换函数的调用情况。在测试过程中，我们通常需要验证被替换函数是否被正确地调用，以及使用了正确的参数。我们可以使用assert_called_once_with方法来实现这个需求。以下是一个验证被替换函数调用情况的示例：

from unittest.mock import patch

def add(a, b):
    return a + b

@patch("__main__.add")
def test_add(mock_add):
    add(3, 4)
    mock_add.assert_called_once_with(3, 4)

在上述示例中，我们首先调用了被替换函数add，然后使用assert_called_once_with方法来验证mock_add对象的调用情况。这个方法接受被替换函数的参数列表作为参数，如果被替换函数在测试过程中只被调用了一次，并且使用了正确的参数，这个方法将通过验证。

3. 使用patch的高级技巧

除了基本的使用方式和进阶的技巧外，还有一些更高级的技巧可以帮助我们更好地使用patch对象：

（1）使用上下文管理器，精确控制patch对象的生命周期。除了手动控制patch对象的生命周期外，我们还可以使用上下文管理器来实现更精确的控制。通过将patch对象放在with语句中，我们可以确保patch对象在代码块结束时自动被销毁。以下是一个使用上下文管理器的示例：

from unittest.mock import patch

def add(a, b):
    return a + b

def test_add():
    with patch("__main__.add") as mock_add:
        mock_add.return_value = 10
        assert add(3, 4) == 10

在上述示例中，我们将patch对象放在了with语句中，这样在with代码块结束时，patch对象将自动被销毁。

（2）使用side_effect的参数可以是一个迭代器，以实现复杂的逻辑。在前面的示例中，我们使用side_effect的参数是一个lambda函数，这要求被替换函数的参数是可被lambda函数接受的，使得每次调用被替换函数时返回相同的结果。但是，有时我们可能希望被替换函数的参数和结果是动态变化的。这时我们可以使用side_effect的参数是一个迭代器，迭代器的每个元素将作为被替换函数的返回结果。以下是一个使用迭代器作为side_effect参数的示例：

from unittest.mock import patch

def add(a, b):
    return a + b

@patch("__main__.add")
def test_add(mock_add):
    mock_add.side_effect = iter([10, 20, 30])
    assert add(3, 4) == 10
    assert add(5, 6) == 20
    assert add(7, 8) == 30

在上述示例中，我们使用iter([10, 20, 30])作为side_effect的参数，这样每次调用被替换函数时，迭代器将返回序列中的下一个元素。

总结：

使用patch对象是进行单元测试中的模拟和模仿的重要手段之一。在本文中，我们介绍了patch对象的基本使用方式、进阶技巧和高级技巧，并提供了相应的使用示例。希望通过本文的介绍，读者能够更好地理解和掌握patch对象