使用msg参数不能按预期工作的self.assert成为上下文管理器

问题描述

请检查以下代码：

import unittest


CORRECT_MESSAGE = 'Correct message'
WRONG_MESSAGE = 'Wrong message'


def fn():
    raise KeyError(CORRECT_MESSAGE)


class Test(unittest.TestCase):
    def test(self):
        # I am expecting this test to fail as the msg I am
        # checking is WRONG_MESSAGE, and not CORRECT_MESSAGE.
        with self.assertRaises(KeyError, msg=WRONG_MESSAGE):
            fn()


unittest.main()

---

正如评论中提到的，我预计此测试将失败，因为我正在检查的消息(WRONG_MESSAGE)不正确，但测试通过了。

我错过了什么？我已检查：assertRaises(exception, *, msg=None)。

---

解决方案

我将回答我自己的问题。

---

我误解了msg的用法。发件人：Python's official documentation：

所有Assert方法都接受msg参数，如果指定该参数，则该参数将用作失败时的错误消息。

用于调试。

例如

import unittest


CORRECT_MESSAGE = 'Correct message'
WRONG_MESSAGE = 'Wrong message'


def fn():
    return
    # Don't raise an exception.
    # raise KeyError(CORRECT_MESSAGE)


class Test(unittest.TestCase):
    def test(self):
        with self.assertRaises(KeyError, msg=WRONG_MESSAGE):
            fn()


unittest.main()

在我们将得到的输出中：

AssertionError：未引发KeyError：错误消息

msg在未引发断言错误时使用。

---

如果我们要检查异常消息，则实际解决方案是使用assertRaisesRegex。

例如

import unittest


CORRECT_MESSAGE = 'Correct message'
WRONG_MESSAGE = 'Wrong message'


def fn():
    raise KeyError(CORRECT_MESSAGE)


class Test(unittest.TestCase):
    def test_will_pass(self):
        # This will check if the error message is CORRECT_MESSAGE.
        with self.assertRaisesRegex(KeyError, CORRECT_MESSAGE):
            fn()

    def test_will_fail(self):
        # This will check if the error message is WRONG_MESSAGE.
        with self.assertRaisesRegex(KeyError, WRONG_MESSAGE):
            fn()

unittest.main()