如何在pytest中实现不受测试结果影响的文件关闭与删除机制？

问题根源 #

你的finally块未执行，大概率是测试在执行到finally前就触发了未捕获异常（比如assert失败抛出的AssertionError），导致代码流程提前终止。另外手动管理文件句柄和删除操作本身就容易出现遗漏，不如借助Python上下文管理器和pytest内置机制来简化处理。

改进方案1：用上下文管理器自动管控文件生命周期 #

重构文件生成函数 #

将文件生成逻辑封装为上下文管理器，确保文件自动关闭、无论测试结果如何都会被删除：

from contextlib import contextmanager
import os

@contextmanager
def prepare_file_with_fixed_size(filename: str, size: int):
    # 创建指定大小的文件
    with open(filename, 'wb') as f:
        f.truncate(size)
    # 打开文件并返回，退出上下文时自动执行清理
    try:
        with open(filename, 'rb') as f:
            yield f
    finally:
        # 确保文件存在再删除，避免报错
        if os.path.exists(filename):
            os.remove(filename)

修改测试用例 #

在测试中通过with语句调用该函数，无需手动执行关闭和删除操作：

import pytest
import requests

@pytest.mark.parametrize('filename', [
    'test.pdf',
    't est.pdf'
])
def test_should_work(filename: str):
    # given
    content_type = 'application/pdf'
    with prepare_file_with_fixed_size(filename, MAX_FILE_SIZE) as file:
        files = [('file', (filename, file, content_type))]
        file_id = requests.post('my_url', files=files).json()['id']

        # when
        result = requests.get(f"my_url/{file_id}/raw")

        # then
        assert result.status_code == 200
        # 其他断言逻辑...

改进方案2：用pytest的tmp_path Fixture（更推荐） #

pytest内置的tmp_path Fixture会自动创建临时目录，测试结束后自动清理所有临时文件，彻底省去手动删除的麻烦：

调整文件生成逻辑 #

def prepare_file_with_fixed_size(tmp_path, filename: str, size: int):
    file_path = tmp_path / filename
    with open(file_path, 'wb') as f:
        f.truncate(size)
    return open(file_path, 'rb')

修改测试用例 #

import pytest
import requests

@pytest.mark.parametrize('filename', [
    'test.pdf',
    't est.pdf'
])
def test_should_work(filename: str, tmp_path):
    # given
    content_type = 'application/pdf'
    file = prepare_file_with_fixed_size(tmp_path, filename, MAX_FILE_SIZE)
    try:
        files = [('file', (filename, file, content_type))]
        file_id = requests.post('my_url', files=files).json()['id']

        # when
        result = requests.get(f"my_url/{file_id}/raw")

        # then
        assert result.status_code == 200
        # 其他断言逻辑...
    finally:
        file.close()

使用tmp_path的优势：

• 所有临时文件都存放在pytest管理的独立目录，不会污染测试环境
• 测试结束后自动删除整个临时目录，无需手动判断文件状态
• 避免并行测试时的文件名冲突

内容的提问来源于stack exchange，提问作者BiggestUbuntuNoobie