如何编写仅在函数未引发预期异常的情况下失败的单元测试？

使用unittest模块中的TestCase.assertRaises（或TestCase.failUnlessRaises），例如：

import mymod

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

从Python 2.7开始，您可以使用上下文管理器来获取抛出的实际Exception对象：

import unittest

def broken_function():
    raise Exception('This is broken')

class MyTestCase(unittest.TestCase):
    def test(self):
        with self.assertRaises(Exception) as context:
            broken_function()

        self.assertTrue('This is broken' in context.exception)

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

http://docs.python.org/dev/library/unittest.html#unittest.TestCase.assertRaises

在Python的3.5，你必须包装context.exception在str，否则，你会得到一个TypeError

self.assertTrue('This is broken' in str(context.exception))

我上一个答案中的代码可以简化为：

def test_afunction_throws_exception(self):
    self.assertRaises(ExpectedException, afunction)

如果函数接受参数，则将它们传递给assertRaises，如下所示：

def test_afunction_throws_exception(self):
    self.assertRaises(ExpectedException, afunction, arg1, arg2)

您如何测试Python函数引发异常？

如何编写仅在函数未引发预期异常的情况下失败的测试？

简短答案：

将该self.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库的向后移植，称为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>

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

有关更详细的输出，请尝试以下操作：

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

您的代码应遵循以下模式（这是一个unittest模块样式测试）：

def test_afunction_throws_exception(self):
    try:
        afunction()
    except ExpectedException:
        pass
    except Exception:
       self.fail('unexpected exception raised')
    else:
       self.fail('ExpectedException not raised')

在Python <2.7上，此构造对于检查预期异常中的特定值很有用。unittest函数assertRaises仅检查是否引发了异常。

来自：http : //www.lengrand.fr/2011/12/pythonunittest-assertraises-raises-error/

首先，这是文件dum_function.py中相应的（still dum：p）函数：

def square_value(a):
   """
   Returns the square value of a.
   """
   try:
       out = a*a
   except TypeError:
       raise TypeError("Input should be a string:")

   return out

这是要执行的测试（仅插入此测试）：

import dum_function as df # import function module
import unittest
class Test(unittest.TestCase):
   """
      The class inherits from unittest
      """
   def setUp(self):
       """
       This method is called before each test
       """
       self.false_int = "A"

   def tearDown(self):
       """
       This method is called after each test
       """
       pass
      #---
         ## TESTS
   def test_square_value(self):
       # assertRaises(excClass, callableObj) prototype
       self.assertRaises(TypeError, df.square_value(self.false_int))

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

现在我们准备测试我们的功能！这是尝试运行测试时发生的情况：

======================================================================
ERROR: test_square_value (__main__.Test)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test_dum_function.py", line 22, in test_square_value
    self.assertRaises(TypeError, df.square_value(self.false_int))
  File "/home/jlengrand/Desktop/function.py", line 8, in square_value
    raise TypeError("Input should be a string:")
TypeError: Input should be a string:

----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)

TypeError被引发actullay，并生成测试失败。问题在于，这正是我们想要的行为：s。

为避免此错误，只需在测试调用中使用lambda运行该函数：

self.assertRaises(TypeError, lambda: df.square_value(self.false_int))

最终输出：

----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

太好了！

...对我来说也是完美的！

非常感谢Julien Lengrand-Lambert先生

这个测试断言实际上返回一个假阳性。发生这种情况是因为'assertRaises'内部的lambda是引发类型错误而不是经过测试的函数的单位。

您可以构建自己的程序contextmanager来检查是否引发了异常。

import contextlib

@contextlib.contextmanager
def raises(exception):
    try:
        yield 
    except exception as e:
        assert True
    else:
        assert False

然后您可以raises像这样使用：

with raises(Exception):
    print "Hola"  # Calls assert False

with raises(Exception):
    raise Exception  # Calls assert True

如果您使用pytest，则该东西已经实现。您可以pytest.raises(Exception)：

例：

def test_div_zero():
    with pytest.raises(ZeroDivisionError):
        1/0

结果：

pigueiras@pigueiras$ py.test
================= test session starts =================
platform linux2 -- Python 2.6.6 -- py-1.4.20 -- pytest-2.5.2 -- /usr/bin/python
collected 1 items 

tests/test_div_zero.py:6: test_div_zero PASSED

我几乎在所有地方都使用doctest [1]，因为我喜欢同时记录和测试函数的事实。

看一下这段代码：

def throw_up(something, gowrong=False):
    """
    >>> throw_up('Fish n Chips')
    Traceback (most recent call last):
    ...
    Exception: Fish n Chips

    >>> throw_up('Fish n Chips', gowrong=True)
    'I feel fine!'
    """
    if gowrong:
        return "I feel fine!"
    raise Exception(something)

if __name__ == '__main__':
    import doctest
    doctest.testmod()

如果将此示例放在模块中并从命令行运行它，则将评估并检查两个测试用例。

[1] Python文档：23.2 doctest-测试交互式Python示例

我刚刚发现，Mock库提供了assertRaisesWithMessage（）方法（在其unittest.TestCase子类中），该方法不仅会检查是否引发了预期的异常，还检查了与预期消息一起引发的异常：

from testcase import TestCase

import mymod

class MyTestCase(TestCase):
    def test1(self):
        self.assertRaisesWithMessage(SomeCoolException,
                                     'expected message',
                                     mymod.myfunc)

这里有很多答案。该代码显示了我们如何创建一个异常，如何在我们的方法中使用该异常，最后，您如何在单元测试中进行验证，并提出正确的异常。

import unittest

class DeviceException(Exception):
    def __init__(self, msg, code):
        self.msg = msg
        self.code = code
    def __str__(self):
        return repr("Error {}: {}".format(self.code, self.msg))

class MyDevice(object):
    def __init__(self):
        self.name = 'DefaultName'

    def setParameter(self, param, value):
        if isinstance(value, str):
            setattr(self, param , value)
        else:
            raise DeviceException('Incorrect type of argument passed. Name expects a string', 100001)

    def getParameter(self, param):
        return getattr(self, param)

class TestMyDevice(unittest.TestCase):

    def setUp(self):
        self.dev1 = MyDevice()

    def tearDown(self):
        del self.dev1

    def test_name(self):
        """ Test for valid input for name parameter """

        self.dev1.setParameter('name', 'MyDevice')
        name = self.dev1.getParameter('name')
        self.assertEqual(name, 'MyDevice')

    def test_invalid_name(self):
        """ Test to check if error is raised if invalid type of input is provided """

        self.assertRaises(DeviceException, self.dev1.setParameter, 'name', 1234)

    def test_exception_message(self):
        """ Test to check if correct exception message and code is raised when incorrect value is passed """

        with self.assertRaises(DeviceException) as cm:
            self.dev1.setParameter('name', 1234)
        self.assertEqual(cm.exception.msg, 'Incorrect type of argument passed. Name expects a string', 'mismatch in expected error message')
        self.assertEqual(cm.exception.code, 100001, 'mismatch in expected error code')


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

您可以使用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 dont use () when passing the method to assertRaises
    self.assertRaises(Exception, test_class.raises_exception)

尽管所有答案都很好，但我仍在寻找一种方法来测试函数是否引发异常，而无需依赖于单元测试框架和编写测试类。

我最终写了以下内容：

def assert_error(e, x):
    try:
        e(x)
    except:
        return
    raise AssertionError()

def failing_function(x):
    raise ValueError()

def dummy_function(x):
    return x

if __name__=="__main__":
    assert_error(failing_function, 0)
    assert_error(dummy_function, 0)

它在正确的行失败：

Traceback (most recent call last):
  File "assert_error.py", line 16, in <module>
    assert_error(dummy_function, 0)
  File "assert_error.py", line 6, in assert_error
    raise AssertionError()
AssertionError