Fixture 的本质是把“测试环境的搭建和销毁”从测试逻辑中解耦出来。 没有它,你的测试要么充满重复代码,要么因为资源未清理/状态污染而变得不可靠。它是 pytest 最核心的设计哲学之一。
示例代码:
importpytest@pytest.fixturedeftmp_dir(tmpdir):# 使用内置的 tmpdir fixturereturntmpdir.mkdir("test_data")deftest_tmp_dir(tmp_dir):file=tmp_dir.join("test.txt")file.write("Hello")assertfile.read()=="Hello"参考文章:pytest介绍(python测试框架)(@pytest.mark.parametrize、@pytest.fixtures)
文章目录
- **代码解析**
- 1. **导入 pytest 模块**
- 2. **定义自定义 fixture:`tmp_dir`**
- 3. **测试函数:`test_tmp_dir`**
- **调用流程**
- **如何运行代码**
- **关键概念总结**
- **扩展示例**
这段代码使用了
pytest的内置tmpdirfixture 来创建临时目录,并验证其功能。下面是对代码的逐行解释和调用流程的说明:代码解析
1.导入 pytest 模块
importpytest- 导入
pytest模块,这是使用pytest测试框架的基础。
2.定义自定义 fixture:tmp_dir
@pytest.fixturedeftmp_dir(tmpdir):# 使用内置的 tmpdir fixturereturntmpdir.mkdir("test_data")- 作用:创建一个临时目录
test_data,并将其返回给测试函数使用。 - 关键点:
tmpdir是pytest提供的内置 fixture,它会自动在测试开始前创建一个临时目录,并在测试结束后删除该目录。tmpdir.mkdir("test_data")在临时目录下创建一个名为test_data的子目录。- 返回值
tmp_dir是一个py.path.local对象,表示test_data目录。
3.测试函数:test_tmp_dir
deftest_tmp_dir(tmp_dir):file=tmp_dir.join("test.txt")file.write("Hello")assertfile.read()=="Hello"- 作用:在临时目录
test_data中创建一个文件test.txt,写入内容并验证内容是否正确。 - 关键点:
tmp_dir是上一步定义的 fixture,它会自动传入当前测试函数。tmp_dir.join("test.txt")在test_data目录下创建一个文件test.txt。file.write("Hello")向文件写入字符串"Hello"。assert file.read() == "Hello"验证文件内容是否匹配预期值。
调用流程
运行测试时:
pytest会自动发现以test_开头的测试函数(如test_tmp_dir)。- 执行
test_tmp_dir时,pytest会先调用tmp_dirfixture。
tmp_dirfixture 的执行:pytest自动调用内置的tmpdirfixture(无需手动调用)。tmpdir.mkdir("test_data")创建临时目录test_data。- 返回
test_data目录对象给test_tmp_dir函数。
测试函数的执行:
test_tmp_dir使用tmp_dir参数(即test_data目录)。- 创建文件
test.txt并写入内容,最后验证内容是否正确。
测试结束后的清理:
- 测试完成后,
pytest会自动删除临时目录test_data及其所有子目录和文件(包括test.txt)。
- 测试完成后,
如何运行代码
保存代码到文件:
将代码保存为test_tmp.py。运行测试:
在终端中执行以下命令:pytest test_tmp.py-v-v表示输出详细的测试信息。- 如果测试通过,你会看到类似
test_tmp.py::test_tmp_dir PASSED的输出。
验证临时目录的自动清理:
- 测试运行时,
pytest会生成一个临时目录(路径类似/tmp/pytest-of-<username>/.../test_data)。 - 测试结束后,该目录及其内容会被自动删除,无需手动清理。
- 测试运行时,
关键概念总结
tmpdirfixture:- 自动创建临时目录,测试结束后自动删除。
- 可用于存放测试过程中需要的临时文件。
Fixture 的作用:
- 将测试的准备工作(如创建临时目录)与测试逻辑分离,提高代码的可读性和可维护性。
断言验证:
- 使用
assert验证文件内容是否符合预期,确保测试的正确性。
- 使用
扩展示例
如果你需要更复杂的临时文件管理,可以结合tmpdir_factory(会话级临时目录)或tempfile模块。例如:
importpytestimporttempfile@pytest.fixturedefsession_tmp_dir(tmpdir_factory):returntmpdir_factory.mktemp("session_data")deftest_session_tmp_dir(session_tmp_dir):file=session_tmp_dir.join("session_file.txt")file.write("Session Data")assertfile.read()=="Session Data"tmpdir_factory的作用范围是整个测试会话(session),适合需要跨多个测试共享的临时目录。