如何测试Python函数是否抛出异常? 如何编写只有在函数不抛出时才会失败的测试呢 意料之中的例外?

简短的回答:

利用自我。assertRaises方法作为上下文管理器:

    def test_1_cannot_add_int_and_str(self):
        with self.assertRaises(TypeError):
            1 + '1'

示范

在Python shell中很容易演示最佳实践方法。

unittest库

在Python 2.7或3中:

import unittest

在Python 2.6中，你可以安装2.7的unittest库的backport，称为unittest2，并将其别名为unittest:

import unittest2 as unittest

示例测试

现在，将以下Python类型安全测试粘贴到Python shell中:

class MyTestCase(unittest.TestCase):
    def test_1_cannot_add_int_and_str(self):
        with self.assertRaises(TypeError):
            1 + '1'
    def test_2_cannot_add_int_and_str(self):
        import operator
        self.assertRaises(TypeError, operator.add, 1, '1')

测试一使用assertRaises作为上下文管理器，以确保在记录错误的同时正确地捕获和清除错误。

我们也可以在没有上下文管理器的情况下编写它，参见测试二。第一个参数是您期望引发的错误类型，第二个参数是您正在测试的函数，其余的args和关键字args将被传递给该函数。

我认为仅仅使用上下文管理器要简单得多，可读性和可维护性更强。

运行测试

要运行测试:

unittest.main(exit=False)

在Python 2.6中，您可能需要以下内容:

unittest.TextTestRunner().run(unittest.TestLoader().loadTestsFromTestCase(MyTestCase))

你的终端应该输出如下:

..
----------------------------------------------------------------------
Ran 2 tests in 0.007s

OK
<unittest2.runner.TextTestResult run=2 errors=0 failures=0>

正如我们所期望的那样，尝试在TypeError中添加一个1和一个'1'结果。

---

想要更详细的输出，试试这个:

unittest.TextTestRunner(verbosity=2).run(unittest.TestLoader().loadTestsFromTestCase(MyTestCase))

你可以使用unittest模块中的assertRaises:

import unittest

class TestClass():
  def raises_exception(self):
    raise Exception("test")

class MyTestCase(unittest.TestCase):
  def test_if_method_raises_correct_exception(self):
    test_class = TestClass()
    # Note that you don’t use () when passing the method to assertRaises
    self.assertRaises(Exception, test_class.raises_exception)

对于Django上的那些，你可以使用上下文管理器来运行错误的函数，并使用assertRaisesMessage断言它会引发带有特定消息的异常

with self.assertRaisesMessage(SomeException,'Some error message e.g 404 Not Found'):
    faulty_funtion()

使用TestCase。从unittest模块中assertRaises(或testcase . failunlessraised)，例如:

import mymod

class MyTestCase(unittest.TestCase):
    def test1(self):
        self.assertRaises(SomeCoolException, mymod.myfunc)

由于我还没有看到任何关于如何检查我们是否在使用上下文管理器的接受列表中获得特定异常的详细解释，或其他异常细节，我将添加我的(在Python 3.8上检查)。

如果我只是想检查函数是否引发实例TypeError，我会写:

with self.assertRaises(TypeError):
    function_raising_some_exception(parameters)

如果我想检查函数是否引发TypeError或IndexError，我会写:

with self.assertRaises((TypeError,IndexError)):
    function_raising_some_exception(parameters)

如果我想要更多关于异常引发的细节，我可以在这样的上下文中捕获它:

# Here I catch any exception
with self.assertRaises(Exception) as e:
    function_raising_some_exception(parameters)

# Here I check actual exception type (but I could
# check anything else about that specific exception,
# like it's actual message or values stored in the exception)
self.assertTrue(type(e.exception) in [TypeError,MatrixIsSingular])

有4个选项(你会在最后找到完整的例子):

assertRaises与上下文管理器

def test_raises(self):
    with self.assertRaises(RuntimeError):
        raise RuntimeError()

如果你想检查异常消息(参见下面的"assertRaisesRegex with context manager"选项来检查它的一部分):

def test_raises(self):
    with self.assertRaises(RuntimeError) as error:
        raise RuntimeError("your exception message")
    self.assertEqual(str(error.exception), "your exception message")

assertRaises一行程序

注意:这里使用的函数不是函数调用，而是可调用函数(不带圆括号)。

def test_raises(self):
    self.assertRaises(RuntimeError, your_function)

assertRaisesRegex与上下文管理器

第二个参数是正则表达式，是必选项。当您只想检查部分异常消息时，非常方便。

def test_raises_regex(self):
    with self.assertRaisesRegex(RuntimeError, r'.* exception message'):
        raise RuntimeError('your exception message')

assertRaisesRegex一行程序

第二个参数是正则表达式，是必选项。当您只想检查部分异常消息时，非常方便。

注意:这里使用的函数不是函数调用，而是可调用函数(不带圆括号)。

def test_raises_regex(self):
    self.assertRaisesRegex(RuntimeError, r'.* exception message', your_function)

---

完整的代码示例:

import unittest

def your_function():
    raise RuntimeError('your exception message')

class YourTestCase(unittest.TestCase):

    def test_1_raises_context_manager(self):
        with self.assertRaises(RuntimeError):
            your_function()

    def test_1b_raises_context_manager_and_error_message(self):
        with self.assertRaises(RuntimeError) as error:
            your_function()
        self.assertEqual(str(error.exception), "your exception message")

    def test_2_raises_oneliner(self):
        self.assertRaises(RuntimeError, your_function)

    def test_3_raises_regex_context_manager(self):
        with self.assertRaisesRegex(RuntimeError, r'.* exception message'):
            your_function()

    def test_4_raises_regex_oneliner(self):
        self.assertRaisesRegex(RuntimeError, r'.* exception message', your_function)

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

虽然这取决于开发人员遵循哪种风格，但我更喜欢使用上下文管理器的两种方法。