Python | 单元测试对象补丁 | 第 2 组

简介

在Python中，单元测试（Unit Testing）是一种以函数、类、模块等单元为单位进行测试的方法，通常使用Python自带的unittest模块来进行。在进行单元测试时，我们有时需要替代函数、类、模块等对象的部分或全部行为，这时就可以使用对象补丁（Object Patching）来实现。

对象补丁是指将整个对象或对象的某些属性或方法替换成指定的值或者函数，这样在使用对象时就会调用替换后的属性或方法。这个过程也叫做“模拟”。

对象补丁的例子

下面举一个简单的例子，来演示如何使用对象补丁。假设有一个名为func的函数，其内部使用了一个外部方法external_func，我们想在进行单元测试时替换这个外部方法。

def func():
    print('I want to call an external function')
    return external_func()

def external_func():
    print('You have called an external function')
    return 1

下面我们编写一个测试函数，来测试func函数的行为：

import unittest

class TestFunc(unittest.TestCase):
    def test_func(self):
        self.assertEqual(func(), 1)

这个测试函数的意义是，执行func方法并判断其返回值是否为1。但是问题在于，我们无法保证external_func函数的正确性，也许运行时会出现各种问题。为了解决这个问题，我们可以使用对象补丁来将external_func函数替换掉，以保证测试的准确性。

import unittest
from unittest.mock import patch

class TestFunc(unittest.TestCase):
    @patch('__main__.external_func')
    def test_func(self, external_func_mock):
        external_func_mock.return_value = 2
        self.assertEqual(func(), 2)

这个测试函数对func函数进行了对象补丁，将external_func函数替换为一个名为external_func_mock的Mock对象，这个Mock对象返回值为2。这样当func函数运行时，就会调用这个Mock对象，而不是原始的external_func函数。

patch的参数说明

在上面的例子中，我们使用了patch函数来对对象进行补丁，但这个函数有很多参数，我们需要一个一个来解释。

@patch(target[, new=DEFAULT[, spec=None[, create=False[, spec_set=None[, autospec=None[, new_callable=None[, **kwargs]]]]]]])

参数说明：

• target：需要补丁的对象路径，字符串类型。可以是全局变量名、类的方法、实例的变量等等。
• new：用于替换对象的新对象。如果不指定，会使用MagicMock对象。如果指定了，必须是一个类、函数或属性等对象。
• spec：用于指定新对象的方法和属性，可以是类或实例。如果为None，则无需指定。
• create：如果为True，则在目标对象不存在时创建一个新对象。如果为False，则返回空的MagicMock对象。
• spec_set：用于指定新对象的方法和属性，必须是类或实例。如果为None，则无需指定。
• autospec：如果为True，则新对象的签名将与目标对象相同。如果为False，则不。如果为None，则默认为被补丁的对象是否有签名。
• new_callable：用于指定替换对象的构造函数。如果为None，则使用默认的MagicMock构造函数。如果指定，必须是一个类、函数或属性等对象。
• **kwargs：其他参数，可以传递给MagicMock对象和新对象的构造函数。

总结

对象补丁是Python中一种常用的单元测试方法，它可以让我们替代函数、类、模块等对象的部分或全部行为，以保证单元测试的准确性。在使用对象补丁时，我们需要使用patch函数来对需要补丁的对象进行处理，掌握patch函数的参数与用法是很重要的。