优化Python Unittest测试文件管理：成功删除，失败保留

不用全局变量和冗余的try-except块，我们可以直接利用unittest框架自带的测试结果收集机制来判断是否保留测试输出文件，以下是两种实用方案：

方案一：直接在tearDownClass中检查测试结果 #

通过访问unittest内部的测试结果集合，判断是否存在失败或错误的测试用例，仅在全部测试通过时删除文件：

import unittest
import os

# 假设这是你要测试的写JSON函数
def write_json(file_path, data):
    import json
    with open(file_path, "w") as f:
        json.dump(data, f)

def load_json(file_path):
    import json
    with open(file_path, "r") as f:
        return json.load(f)

class TestJSONWriter(unittest.TestCase):
    # 统一管理测试生成的文件
    TEST_OUTPUT_FILES = ["test_data.json", "empty_test.json"]

    @classmethod
    def tearDownClass(cls):
        # 收集所有失败和错误的测试用例
        failed_tests = cls._outcome.result.failures + cls._outcome.result.errors
        # 只要有一个测试失败/出错，就保留文件
        if not failed_tests:
            for file_path in cls.TEST_OUTPUT_FILES:
                if os.path.exists(file_path):
                    os.remove(file_path)

    def test_normal_json_write(self):
        test_data = {"name": "unittest", "version": "3.11"}
        write_json(self.TEST_OUTPUT_FILES[0], test_data)
        self.assertEqual(load_json(self.TEST_OUTPUT_FILES[0]), test_data)

    def test_empty_json_write(self):
        write_json(self.TEST_OUTPUT_FILES[1], {})
        self.assertEqual(load_json(self.TEST_OUTPUT_FILES[1]), {})

方案说明 #

• 利用cls._outcome.result获取当前测试类的全部结果，其中failures存储断言失败的用例，errors存储抛出异常的用例
• 无需修改测试方法内部逻辑，仅在类清理阶段统一判断，代码侵入性极低

方案二：重写run方法记录测试状态（兼容更多Python版本） #

如果担心_outcome.result是内部属性可能在不同版本变动，可以通过重写TestCase的run方法，统一记录测试类是否有失败用例：

import unittest
import os

class BaseTestCase(unittest.TestCase):
    # 类级变量标记是否有测试失败
    _has_failed = False

    def run(self, result=None):
        super().run(result)
        if result:
            # 检查当前测试用例是否失败或出错
            current_test_failed = any(test is self for test, _ in result.failures + result.errors)
            if current_test_failed:
                self.__class__._has_failed = True

class TestJSONWriter(BaseTestCase):
    TEST_OUTPUT_FILES = ["test_data.json", "empty_test.json"]

    @classmethod
    def tearDownClass(cls):
        if not cls._has_failed:
            for file_path in cls.TEST_OUTPUT_FILES:
                if os.path.exists(file_path):
                    os.remove(file_path)

    # 测试方法同方案一
    def test_normal_json_write(self):
        test_data = {"name": "unittest", "version": "3.11"}
        write_json(self.TEST_OUTPUT_FILES[0], test_data)
        self.assertEqual(load_json(self.TEST_OUTPUT_FILES[0]), test_data)

    def test_empty_json_write(self):
        write_json(self.TEST_OUTPUT_FILES[1], {})
        self.assertEqual(load_json(self.TEST_OUTPUT_FILES[1]), {})

方案说明 #

• 通过自定义基础测试类，在每个测试用例执行后更新类级别的失败标记
• 完全基于unittest公开的API，兼容性更强，适合跨版本项目使用

额外建议 #

• 把测试输出文件统一存放在一个临时目录（比如./test_outputs/），这样清理时只需删除整个目录，更高效
• 如果使用Python 3.10+，可以结合tempfile.TemporaryDirectory，但需要手动控制目录的删除时机（默认会自动删除，测试失败时跳过删除）

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