如何在测试中使用临时目录和文件

How to use temporary directories and files in tests

tmp_path fixture

The tmp_path fixture

您可以使用 tmp_path 夹具，它将为每个测试函数提供一个唯一的临时目录。

tmp_path 是一个 pathlib.Path 对象。以下是一个示例测试用法：

# content of test_tmp_path.py
CONTENT = "content"


def test_create_file(tmp_path):
    d = tmp_path / "sub"
    d.mkdir()
    p = d / "hello.txt"
    p.write_text(CONTENT, encoding="utf-8")
    assert p.read_text(encoding="utf-8") == CONTENT
    assert len(list(tmp_path.iterdir())) == 1
    assert 0

运行此测试将会通过，除了最后的 assert 0 行，我们使用它来查看值：

$ pytest test_tmp_path.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 1 item

test_tmp_path.py F                                                   [100%]

================================= FAILURES =================================
_____________________________ test_create_file _____________________________

tmp_path = PosixPath('PYTEST_TMPDIR/test_create_file0')

    def test_create_file(tmp_path):
        d = tmp_path / "sub"
        d.mkdir()
        p = d / "hello.txt"
        p.write_text(CONTENT, encoding="utf-8")
        assert p.read_text(encoding="utf-8") == CONTENT
        assert len(list(tmp_path.iterdir())) == 1
>       assert 0
E       assert 0

test_tmp_path.py:11: AssertionError
========================= short test summary info ==========================
FAILED test_tmp_path.py::test_create_file - assert 0
============================ 1 failed in 0.12s =============================

默认情况下， pytest 会保留最近 3 次 pytest 调用的临时目录。通过将基础临时目录配置为每次并发运行唯一，支持对同一测试函数的并发调用。有关详细信息，请参见 temporary directory location and retention 。

tmp_path_factory fixture

tmp_path_factory 是一个会话范围的夹具，可以用来从任何其他夹具或测试中创建任意的临时目录。

例如，假设您的测试套件需要一个大的图像文件，该图像是程序生成的。为了节省时间，您可以每个会话生成一次图像，而不是为每个使用它的测试计算相同的图像到自己的 tmp_path 中：

# contents of conftest.py
import pytest


@pytest.fixture(scope="session")
def image_file(tmp_path_factory):
    img = compute_expensive_image()
    fn = tmp_path_factory.mktemp("data") / "img.png"
    img.save(fn)
    return fn


# contents of test_image.py
def test_histogram(image_file):
    img = load_image(image_file)
    # compute and test histogram

有关详细信息，请参见 tmp_path_factory API。

tmpdir 和 tmpdir_factory fixtures

The tmpdir and tmpdir_factory fixtures

tmpdir 和 tmpdir_factory 夹具类似于 tmp_path 和 tmp_path_factory，但使用/返回传统的 py.path.local 对象，而不是标准的 pathlib.Path 对象。

Note

如今，建议使用 tmp_path 和 tmp_path_factory。

为了帮助现代化旧代码库，可以在禁用 legacypath 插件的情况下运行 pytest：

pytest -p no:legacypath

这将对使用传统路径的测试触发错误。 它也可以作为配置文件中 addopts 参数的一部分永久设置。

有关详细信息，请参见 tmpdir 和 tmpdir_factory API。

临时目录位置和保留

Temporary directory location and retention

临时目录默认作为系统临时目录的子目录创建。基本名称将为 pytest-NUM，其中 NUM 在每次测试运行时递增。 默认情况下，超过 3 个临时目录的条目将被删除。 此行为可以通过 tmp_path_retention_count 和 tmp_path_retention_policy 进行配置。

使用 --basetemp 选项将在每次运行之前删除该目录，这意味着仅保留最近一次运行的临时目录。

您可以像这样覆盖默认的临时目录设置：

pytest --basetemp=mydir

Warning

mydir 的内容将被完全删除，因此请确保仅使用一个目录来实现此目的。

在使用 pytest-xdist 在本地机器上分发测试时，会自动为子进程配置 basetemp 目录，以便所有临时数据都位于单个每次测试运行的临时目录下。