迹忆客 专注技术分享

本文的主要目的是演示如何在使用单元测试库 unittest 时抛出异常。

在 Python 中使用单元测试库 unittest 时抛出异常

为验证我们的代码是否稳定并说明了项目范围内的大部分用例，我们必须通过为其提供不同的输入来对其进行测试。 Python 中的库之一 unittest 提供了这样的功能，允许编写和执行不同的测试用例。

在测试时，有必要能够处理意外输入的情况。 我们可以通过抛出一个详细说明给定输入有什么问题的异常来处理这种情况。

考虑以下代码：

class A:
    def __init__(self):
        pass

    def computeData(self):
        return 0

class B:
    def method_to_test():
        obj = A()
        try:
            print(obj.computeData())
        except Exception as e:
            print("Exception at method_to_test: " + str(e))

假设我们要测试的函数是 method_to_test。 它初始化另一个类 A 的对象，然后在 try-except 块中调用其名为 computeData 的方法之一以捕获任何异常。

如果我们想在抛出特定异常时测试 computeData 的行为，我们必须使用 unittest 模块来实现。

引发异常一次

考虑到上面提到的场景，也可能是我们希望更好地控制何时抛出异常的情况。

出现这种需求的原因有很多。 根据代码的实现，对行为进行更多控制可能会非常有帮助。

断言异常

在编写测试用例时，您可能想检查异常是否触发。 当您想知道是否抛出异常时，这尤其有用。

如果出现问题，这可以帮助您更早地发现测试用例。

模拟第三方模块

第三方模块，取决于我们的实现，可以从几乎没有到很多不等。 要测试第三方模块是否按预期运行，我们还必须使用不同的输出测试其行为。

一个这样的例子就是请求，它是通过网络通信或使用 HTTP 发送/接收数据时广泛使用的模块。 **

从函数中手动引发异常

要从 computeData 函数中手动抛出异常，我们必须使用 side_effect 属性。

考虑以下代码：

import unittest
from unittest.mock import patch
from unittest.mock import MagicMock

class A:
    def __init__(self) -> None:
        pass

    def computeData(self):
        return 0

class B:
    def method_to_test():
        obj = A()
        try:
            print(obj.computeData())
        except Exception as e:
            print("Exception at method_to_test: " + str(e))

class Test(unittest.TestCase):
    @patch.object(A, 'computeData', MagicMock(side_effect=Exception("Test")))
    def test_method(self):
        B.method_to_test()

if __name__ == '__main__':
    Test().test_method()

输出:

Exception at method_to_test: Test

在解决方案中，创建了一个新方法test_method，用于测试方法method_to_test。 同样重要的是要注意该函数是用 patch.object 装饰的。

模块中提供了修补装饰器，用于修补模块和类级属性。 为了更具体地修补什么，我们使用 patch.object 而不是 patch 来直接修补方法。

在装饰器中，类名 A 被传递。 这表明要修补的对象是 A 的一部分，传递的成员名称为 computeData。

最后一个参数是一个 MagicMock 对象，它是 Mock 的一个子类，我们在其中使用 side_effect 属性将所需的行为与 computeData 相关联，这在我们的案例中是抛出异常。

程序的大致流程如下：

1. test_method 被调用。
2. A 类的 computeData 已打补丁。 分配了一个副作用，在我们的例子中，这是一个例外。
3. B类的method_to_test被调用。
4. 类 A 的构造函数被调用，实例存储在 obj 中。
5. 计算数据被调用。 由于正在修补该方法，因此抛出异常。

引发异常一次

为了只引发一次异常或对函数的行为有更多的控制，side_effect 支持的不仅仅是函数调用。

目前，side_effect 支持：

1. Iterable
2. Callable
3. Exception (Instance or Class)

使用 Iterable，我们可以使该方法只引发一次异常。

class Test(unittest.TestCase):
    @patch.object(A, 'computeData', MagicMock(side_effect=[1,Exception("Test"),3]))
    def test_method(self):
        B.method_to_test()

if __name__ == '__main__':
    testClass = Test()
    testClass.test_method()
    testClass.test_method()
    testClass.test_method()

输出:

1
Exception at method_to_test: Test
3

由于传递的 Iterable，我们选择的元素被修补，我们可以控制何时引发异常。 因此，仅在第二次调用该函数时抛出异常，其他情况下返回 1 和 3。

断言异常

要确定是否发生特定异常，我们可以使用 unittest.TestCase.assertRaises 以防未抛出我们想要的异常。

class Test(unittest.TestCase):
    @patch.object(A, 'computeData', MagicMock(side_effect=Exception("Test")))
    def test_method(self):
        self.assertRaises(KeyError, A.computeData)

if __name__ == '__main__':
    Test().test_method()

输出:

Exception at method_to_test: Test
Traceback (most recent call last):
  File "d:\Python Articles\a.py", line 28, in <module>
    Test().test_method()
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1369, in patched
    return func(*newargs, **newkeywargs)
  File "d:\Python Articles\a.py", line 25, in test_method
    self.assertRaises(KeyError, A.computeData)
  File "C:\Program Files\Python310\lib\unittest\case.py", line 738, in assertRaises
    return context.handle('assertRaises', args, kwargs)
  File "C:\Program Files\Python310\lib\unittest\case.py", line 201, in handle
    callable_obj(*args, **kwargs)
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1104, in __call__
    return self._mock_call(*args, **kwargs)
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1108, in _mock_call
    return self._execute_mock_call(*args, **kwargs)
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1163, in _execute_mock_call
    raise effect
  File "d:\Python Articles\a.py", line 17, in method_to_test
Exception: Test

我们正在对我们的 test_method 方法进行细微更改，使用两个参数调用 assertRaises，从而产生上述输出。

这两个参数可以定义为：

1. KeyError - 您要触发的任何异常都会在此处传递。
2. A.computeData - 应该抛出异常的方法。

模拟第三方模块

要像以前一样模拟帖子，您必须使用 patch 装饰器。 一个简单的例子可以如下：

class Test(unittest.TestCase):
    @patch('requests.post', MagicMock(side_effect=requests.exceptions.ConnectionError()))
    def test_method(self):
        requests.post()

输出:

Traceback (most recent call last):
  File "d:\Python Articles\a.py", line 33, in <module>
    Test().test_method()
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1369, in patched
    return func(*newargs, **newkeywargs)
  File "d:\Python Articles\a.py", line 30, in test_method
    requests.post()
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1104, in __call__
    return self._mock_call(*args, **kwargs)
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1108, in _mock_call
    return self._execute_mock_call(*args, **kwargs)
  File "C:\Program Files\Python310\lib\unittest\mock.py", line 1163, in _execute_mock_call
    raise effect
requests.exceptions.ConnectionError

来自第三方模块的功能也可以使用补丁装饰器进行补丁，从而更好地调试和更好地控制产品/程序的可靠性规模。