unittest.mock.patch的使用与实例

unittest.mock.patch是Python的一个单元测试工具，用于在测试过程中，临时替换掉指定对象的部分功能。该工具常用于以下场景：

1. 测试代码依赖于外部接口或者难以构造的对象。

2. 需要为不可控组件的行为创建预期。

3. 为了避免运行测试时对其他依赖的影响。

使用unittest.mock.patch可以完美地解决这些问题，下面是一个使用unittest.mock.patch的实例：

# 假设我们有一个类，里面有一个需要调用外部接口的方法
class ExternalApi:
    def call_api(self):
        # 调用外部接口，返回结果
        pass

# 需要测试的类，调用了ExternalApi的call_api方法
class MyClass:
    def __init__(self):
        self.api = ExternalApi()

    def do_something(self):
        response = self.api.call_api()
        # 对response进行处理的代码

# 我们希望在测试MyClass类的时候，临时替换掉ExternalApi的call_api方法
# 使用patch装饰器

import unittest
from unittest.mock import patch

class TestMyClass(unittest.TestCase):
    def test_do_something(self):
        # 使用patch装饰器，替换ExternalApi的call_api方法为mock_call_api
        with patch('path.to.module.ExternalApi.call_api', mock_call_api):
            obj = MyClass()
            obj.do_something()

    def mock_call_api(self):
        # 使用mock_call_api代替真实的call_api方法
        # 这里可以自定义mock_call_api的返回值，用于测试
        pass

在上述例子中，我们需要测试MyClass的do_something方法，但是该方法调用了ExternalApi类的call_api方法，为了确保测试的独立性和可控性，我们希望在测试时临时替换掉call_api方法。使用unittest.mock.patch，我们可以很方便地实现这个目标。

这里使用了patch装饰器，它的 个参数是要替换的对象路径，即ExternalApi.call_api的路径。patch装饰器会在测试方法执行之前，临时替换指定对象的方法或属性。在这个例子中，我们将ExternalApi.call_api方法替换为了自己定义的mock_call_api方法。

patch装饰器中的第二个参数是用于替换的方法或属性。在这个例子中，我们只是简单地定义了一个空的mock_call_api方法。在实际使用时，我们可以根据需要，自定义mock_call_api方法的行为，比如模拟外部接口的返回值。

在with语句块中，ExternalApi.call_api被替换为mock_call_api，MyClass被实例化，并调用了do_something方法。由于ExternalApi.call_api已经被替换，实际上没有调用外部接口，从而保证了测试的独立性和可控性。

通过使用unittest.mock.patch，我们可以方便地在测试过程中替换掉指定对象的部分功能，从而实现对依赖的隔离、行为的预期以及其他依赖的影响的避免。这对于单元测试的编写和执行非常有帮助。