python - Python单元测试中多行字符串的比较

Question

当我在 Python 单元测试中比较两个 Unicode 字符串时，它会给出一条很好的失败消息，突出显示哪些行和字符不同。然而，比较两个 8 位字符串只是显示两个字符串，没有突出显示。

如何获得 Unicode 和 8 位字符串的高亮显示？

这是一个显示两个比较的示例单元测试:

import unittest

class TestAssertEqual(unittest.TestCase):
    def testString(self):
        a = 'xax\nzzz'
        b = 'xbx\nzzz'
        self.assertEqual(a, b)

    def testUnicode(self):
        a = u'xax\nzzz'
        b = u'xbx\nzzz'
        self.assertEqual(a, b)

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

这个测试的结果显示了差异:

FF
======================================================================
FAIL: testString (__main__.TestAssertEqual)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/mnt/data/don/workspace/scratch/scratch.py", line 7, in testString
    self.assertEqual(a, b)
AssertionError: 'xax\nzzz' != 'xbx\nzzz'

======================================================================
FAIL: testUnicode (__main__.TestAssertEqual)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/mnt/data/don/workspace/scratch/scratch.py", line 12, in testUnicode
    self.assertEqual(a, b)
AssertionError: u'xax\nzzz' != u'xbx\nzzz'
- xax
?  ^
+ xbx
?  ^
  zzz

----------------------------------------------------------------------
Ran 2 tests in 0.001s

FAILED (failures=2)

Python 3 更新

在 Python 3 中，字符串文字默认是 Unicode，所以这几乎是无关紧要的。 assertMultiLineEqual()不再支持字节字符串，因此您几乎只能使用常规 assertEqual()除非您愿意将字节字符串解码为 Unicode。

Answer 1

稍微挖掘一下 Python source code表明 TestCase 注册了一堆方法来测试不同类型的相等性。

self.addTypeEqualityFunc(dict, 'assertDictEqual')
self.addTypeEqualityFunc(list, 'assertListEqual')
self.addTypeEqualityFunc(tuple, 'assertTupleEqual')
self.addTypeEqualityFunc(set, 'assertSetEqual')
self.addTypeEqualityFunc(frozenset, 'assertSetEqual')
try:
    self.addTypeEqualityFunc(unicode, 'assertMultiLineEqual')
except NameError:
    # No unicode support in this build
    pass

您可以看到 unicode 已注册使用 assertMultiLineEqual()，但 str 未注册任何特殊内容。我不知道为什么 str 被遗漏了，但到目前为止，我对以下两种方法中的任何一种都很满意。

直接调用

如果 8 位字符串未注册为默认使用 assertMultiLineEqual()，您仍然可以直接调用它。

def testString(self):
    a = 'xax\nzzz'
    b = 'xbx\nzzz'
    self.assertMultiLineEqual(a, b)

注册字符串类型

您也可以自己注册。只需在测试用例的 setUp() 方法中添加一行。做一次，你所有的测试方法都会使用正确的方法来测试相等性。如果您的项目有一个用于所有测试用例的公共(public)基类，那将是放置它的好地方。

class TestAssertEqual(unittest.TestCase):
    def setUp(self):
        super(TestAssertEqual, self).setUp()
        self.addTypeEqualityFunc(str, self.assertMultiLineEqual)

    def testString(self):
        a = 'xax\nzzz'
        b = 'xbx\nzzz'
        self.assertEqual(a, b)

    def testUnicode(self):
        a = u'xax\nzzz'
        b = u'xbx\nzzz'
        self.assertEqual(a, b)

当字符串比较失败时，这两种方法中的任何一种都会包括突出显示。