Python assert 异常

Neema Muganga 2023年1月30日 2021年12月2日
  1. 使用上下文管理器捕获 Python assert 异常
  2. 使用关键字参数捕获 Python assert 异常
Python assert 异常

这篇文章让人们了解 assert 作为一个测试单元,以测试函数是否可以抛出异常(代码执行期间检测到的错误)而不必退出执行。换句话说,抛出的异常被封装了。

如果引发异常,则此测试将通过。如果抛出不同于预期的异常,则会抛出错误。在根本没有引发异常的实例中,测试失败。

使用上下文管理器捕获 Python assert 异常

与通用 Python 概念中必要时允许分配和释放资源的方式类似,这里的上下文获取测试期间抛出的实际异常对象。

如果需要对引发的异常进行额外的性能检查,它会将这个异常属性存储在对象中。

为了测试函数是否失败或通过是否抛出异常,我们将使用 unittest 模块中的 TestCase.assertRaises

让我们看一个使用上下文管理器的实际示例。

import unittest
class TestCase(unittest.TestCase):
    def test_nameerror(self):
        with self.assertRaises(Exception):
            100 * (someNumber/5)

if __name__ == '__main__':
    unittest.main()

输出:

.
----------------------------------------------------------------------
Ran 1 test in 0.002s

OK

在示例代码中,测试通过是因为我们期望抛出异常。我们将 5 除以未定义的变量 someNumber。因此,该函数会引发 NameError 异常。因此,我们的测试通过了,你可以看到 . 显示在输出的第一行。

让我们看一个例子,当没有抛出异常时测试失败。

import unittest
class TestCase(unittest.TestCase):
    def test_nameerror(self):
        with self.assertRaises(Exception):
            someNumber = 10
            100 * (someNumber/5)

if __name__ == '__main__':
    unittest.main()

输出:

F
======================================================================
FAIL: test_nameerror (__main__.MyTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):  File "c:\Users\Neema\Desktop\Article Requirement Spec and Example 
Articles\Article Requirement Spec 
and Example Articles\fah.py", line 106, in test_nameerror
    100 * (someNumber/5)
AssertionError: Exception not raised

----------------------------------------------------------------------
Ran 1 test in 0.002s

FAILED (failures=1)

在此示例代码中,我们为 someNumber 定义了一个值,然后用它执行算术表达式。

输出向我们显示测试按预期失败。我们不希望这次抛出任何 NameError 异常,因为 someNumber 的定义值确实存在。

我们也可以使用用户定义的异常来实现上下文管理器,如下例所示。

import unittest
def user_function():
    raise Exception('A use defined exception')

class MyTestCase(unittest.TestCase):
    def test_userexception(self):
        with self assertRaises(Exception) as context:
            user_function()

        self.assertTrue('A use defined exception' in str(context.exception))

if __name__ == '__main__':
    unittest.main()

输出:

.
----------------------------------------------------------------------
Ran 1 test in 0.006s

OK

请记住使用 strcontext.exception 括起来,以避免出现 TypeError。

我们引入了 assertTrue,一个 unittest 库,用于在单元测试中将测试值与 true 进行比较。

你还可以选择使用 assertIn 而不是 assertTrue

例子:

import unittest
def user_function():
    raise Exception('A use defined exception')

class MyTestCase(unittest.TestCase):
    def test_userexception(self):
        with self assertRaises(Exception) as context:
            user_function()

        self.assertIn('A use defined exception', str(context.exception))

if __name__ == '__main__':
    unittest.main()

我们看到将产生测试通过的相同输出。

使用关键字参数捕获 Python assert 异常

与上下文管理器不同,我们只将异常传递给 assertRaises(),我们还将函数调用和函数参数作为关键字参数传递来引发异常。

语法

assertRaises(exception, function, *args, **keywords)

例子:

import unittest
class MyTestCase(unittest.TestCase):
    def test_division_by_error(self):
        import operator
        self.assertRaises(ZeroDivisionError, operator.floordiv, 55, 0)

if __name__ == '__main__':
    unittest.main()

输出:

.
----------------------------------------------------------------------
Ran 1 test in 0.002s

OK

上面的示例代码使用带有关键字参数的 assertRaises()。在尝试将数字除以零后,我们将预期的 ZeroDivisionError 异常传递给它。我们导入了与 floordiv 运算符函数一起使用的运算符函数作为第二个参数。这里的参数值是第三个参数:55 除以 0。

assert 的最后一个应用是当我们向 assertRaises() 传入一个不同于预期的异常时。反而会产生错误。

使用我们刚刚在上面使用的相同示例代码,让我们实现它。

import unittest
class MyTestCase(unittest.TestCase):
    def test_division_by_error(self):
        import operator
        self.assertRaises(TypeError, operator.floordiv, 55, 0)

if __name__ == '__main__':
    unittest.main()

输出:

E
======================================================================
ERROR: test_division_by_error (__main__.MyTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):  File "c:\Users\Neema\Desktop\Article Requirement Spec and Example 
Articles\user.py", line 16, in test_division_by_error
    self.assertRaises(TypeError, operator.floordiv, 55, 0)
  File "C:\Users\Neema\AppData\Local\Programs\Python\Python39\lib\unittest\case.py", line 733, in assertRaises
    return context.handle('assertRaises', args, kwargs)
  File "C:\Users\Neema\AppData\Local\Programs\Python\Python39\lib\unittest\case.py", line 201, in handle
    callable_obj(*args, **kwargs) 
ZeroDivisionError: integer division or modulo by zero

----------------------------------------------------------------------
Ran 1 test in 0.031s

FAILED (errors=1)

从输出中,会产生一个错误回溯。当我们将一个数字除以零时,我们预计会出现 ZeroDivisionError 异常。相反,我们传入一个 TypeError 异常,在不同数据类型之间执行算术运算时应用,比如字符串和整数。

相关文章 - Python Exception