Python：如何在测试套件中创建临时文件？

Question

（我正在使用 Python 2.6 和 nose。）

我正在为我的 Python 应用程序编写测试。我想要一个测试来打开一个新文件，关闭它，然后删除它。当然，我更喜欢这发生在临时目录中，因为我不想破坏用户的文件系统。而且，它需要是跨操作系统的。

我该怎么做？

Answer 1

FWIW 使用 py.test 您可以编写：

def test_function(tmpdir):
    # tmpdir is a unique-per-test-function invocation temporary directory

使用“tmpdir”函数参数的每个测试函数将获得一个干净的空目录，创建为“/tmp/pytest-NUM”的子目录（linux，win32 有不同的路径），其中 NUM每次测试运行都会增加。保留最后三个目录以便于检查，旧的目录将被自动删除。您还可以使用 py.test --basetemp=mytmpdir 设置基本临时目录。

tmpdir 对象是一个 py.path.local 对象，也可以像这样使用：

sub = tmpdir.mkdir("sub")
sub.join("testfile.txt").write("content")

但也可以将其转换为“字符串”路径：

tmpdir = str(tmpdir)

Answer 2

请参阅标准库中的 tempfile 模块

以下是 使用 TemporaryFile 和 TemporaryDirectory 的示例 > 作为上下文管理器：

with tempfile.TemporaryFile() as fp:
    fp.write(b'Hello world!')
    fp.seek(0)
    fp.read()

with tempfile.TemporaryDirectory() as tmpdirname:
    print('created temporary directory', tmpdirname)

Answer 3

我建议不要直接使用 tempfile ，而是使用上下文管理器包装器 - 上下文管理器需要小心在所有情况下（成功/失败/异常）删除目录，基本上没有样板。

以下是它的使用方法：

from tempfile import TempDir    # "tempfile" is a module in the standard library
...

# in some test:
with TempDir() as d:
    temp_file_name = os.path.join(d.name, 'your_temp_file.name')
    # create file...
    # ...
    # asserts...

到目前为止，当我也需要在其他地方使用它时，我一直在使用自制版本（实现相当短 - 不到 20 行），所以我环顾四周是否有准备安装的包，确实有： tempfile

---

注意：上面的代码片段有点过时的。

• 在Python 2.7中，有 tempfile.mkdtemp
• 在Python 3中是 tempfile.TemporaryDirectory

Answer 4

要为测试创建包含自定义内容的临时文件，您可以使用此类：

import os, tempfile

class TestFileContent:                                                                                                  
    def __init__(self, content):                                                                                        

        self.file = tempfile.NamedTemporaryFile(mode='w', delete=False)                                                 

        with self.file as f:                                                                                            
            f.write(content)                                                                                            

    @property                                                                                                           
    def filename(self):                                                                                                 
        return self.file.name                                                                                           

    def __enter__(self):                                                                                                
        return self                                                                                                     

    def __exit__(self, type, value, traceback):                                                                         
        os.unlink(self.filename)                                                                                        

此类将创建一个临时文件，在其中写入您的内容，然后关闭该文件。
您可以在 with 语句中使用它，以确保文件在使用后被删除，如下所示：

    with TestFileContent(
'''Hello, world
'''
    ) as test_file:

        # Here, a temporary file has been created in the file named test_file.filename with the specified content
        # This file will be deleted once you leave the with block

Answer 5

Python 3.2+

tempfile 库 TemporaryDirectory( ) 与上下文管理器携手with是正确的出路。但是请注意，这实际上会创建临时目录（在某些操作系统目录中用于临时文件（在 Linux 上可能是 /tmp）） - 那里的文件实际上会使用存储设备/磁盘 - 它可能不会对您来说是一个问题，但是当付费服务等使用量很大时需要考虑（有关替代方案，请参阅此答案帖子的末尾）。

我还建议使用 os 库os.path.join() 将内容放在那里并一般使用它以避免有关 \ 的跨平台错误或 / 路径。

注意：当不使用上下文管理器与时，您将获得TemporaryDirectory类的对象并使用检索名称.name
，在上下文管理器中使用时，您将获得分配给 as 变量的名称字符串。

TL;DR：代码

import tempfile
import os
with tempfile.TemporaryDirectory() as tempdir:
  # you can e.g. create a file here:
  tmpfilepath = os.path.join(tempdir, 'someFileInTmpDir.txt')
  with open(tmpfilepath, 'w') as tmpfile:
    tmpfile.write("something")

更改临时目录位置

在此处 您必须更深入地挖掘，因为 文档 是一种这里模糊：它根本不记录其参数，但是，它会将您发送到 mkdtemp() 应该使用相同的规则，并将您发送到 mkstemp() 您最终可以在其中确保自己使用 dir 参数来覆盖默认目录位置。

您想完全伪造文件系统上的 I/O（输入/输出）操作吗？

您可以尝试按照此答案中的建议使用 pyfakefs：https://stackoverflow.com/a/46817032/1835470

哪个更好？伪造文件系统或物理临时目录？

取决于使用情况 - 通常组合可以是一个很好的折衷方案 - 使用真实的目录和文件单独测试每个文件系统操作，以便您知道它确实有效，但对于您自定义的大量使用的东西，请使用伪造/模拟文件系统操作:)另外例如，对于测试来自操作系统内部的权限 - 使用物理方式可能会更好。

您必须始终事先评估您可以获得多少性能和耐用性，以及进行额外测试是否有意义。

Answer 6

对于将来遇到此问题但由于某种原因拒绝使用 pytest 的人：

我写了 tempcase，一个小型库，它提供了一个 unittest.TestCase 子类，其中包含处理临时目录的便捷方法。在您请求目录的路径之前，不会创建目录，并且它们会根据项目、TestCase 类、时间戳和测试方法进行命名空间。之后它们会自动清理。您可以通过设置属性来禁用清理以检查输出。

如果您逐步移植代码，还有一个可以应用于单个测试用例的装饰器。