我有一个Python函数，可以将输出文件写入磁盘。

我想使用Python unittest模块为它编写单元测试。

我该如何断言文件的相等性？如果文件内容与预期的一个+差异列表不同，我想得到一个错误。如在unix diff命令的输出中那样。

有没有官方/推荐的方式呢？

解决方案

最简单的方法是编写输出文件，然后读取其内容，读取gold（预期）文件的内容，并将它们与简单的字符串相等进行比较。如果它们相同，请删除输出文件。如果它们不同，请提出断言。

这样，当测试完成后，每个失败的测试都将用输出文件表示，你可以使用第三方工具将它们与黄金文件区分开来（Beyond Compare非常适合这个）。

如果你真的想提供自己的diff输出，请记住Python stdlib有difflib模块。Python 3.1中新的unittest支持包括一个assertMultiLineEqual使用它来显示差异的方法，类似于：

    def assertMultiLineEqual(self, first, second, msg=None):
        """Assert that two multi-line strings are equal.

        If they aren't, show a nice diff.

        """
        self.assertTrue(isinstance(first, str),
                'First argument is not a string')
        self.assertTrue(isinstance(second, str),
                'Second argument is not a string')

        if first != second:
            message = ''.join(difflib.ndiff(first.splitlines(True),
                                                second.splitlines(True)))
            if msg:
                message += " : " + msg
            self.fail("Multi-line strings are unequal:\n" + message)