编写一个pytest函数来检查输出到python中的文件？

Question

我向this 询问了有关如何编写 pytest 来检查stdout 中的输出的问题并得到了解决方案。现在我需要写一个test case，以检查内容是否写入文件以及内容是否按预期写入 例如：

def writetoafile():
   file = open("output.txt",w)
   file.write("hello\n")
   file.write("world\n")
   file.close()

现在是一个 pytest 函数来检查它是否写了：

def test_writeToFile():
    file = open("ouput.txt",'r')
    expected = "hello\nworld\n"
    assert expected==file.read()

虽然这似乎可行，但我认为这并不理想，尤其是硬编码。这种写文件的test functions通常是怎么写的？

Answer 1

tmpdir fixture 将为您创建一个每次测试的临时目录。所以测试看起来像这样：

def writetoafile(fname):
    with open(fname, 'w') as fp:
        fp.write('Hello\n')

def test_writetofile(tmpdir):
    file = tmpdir.join('output.txt')
    writetoafile(file.strpath)  # or use str(file)
    assert file.read() == 'Hello\n'

在这里，您正在重构代码，使其也不会被硬编码，这是测试代码如何让您设计得更好的一个典型例子。

Answer 2

假设您在一个名为main.py 的文件中拥有这个“惊人”的软件：

"""
main.py
"""

def write_to_file(text):
    with open("output.txt", "w") as h:
        h.write(text)

if __name__ == "__main__":
    write_to_file("Every great dream begins with a dreamer.")

要测试write_to_file 方法，您可以在名为test_main.py 的同一文件夹中的文件中编写类似这样的内容：

"""
test_main.py
"""
from unittest.mock import patch, mock_open

import main


def test_do_stuff_with_file():
    open_mock = mock_open()
    with patch("main.open", open_mock, create=True):
        main.write_to_file("test-data")

    open_mock.assert_called_with("output.txt", "w")
    open_mock.return_value.write.assert_called_once_with("test-data")

我总是尽量避免将文件写入磁盘，即使它是专门用于我的测试的临时文件夹：不实际接触磁盘会使您的测试更快，尤其是当您在代码中与文件进行大量交互时。