yield在pytest的fixture中的作用

在了解yield 的使用方法前，需要先了解fixture

1.什么是Fixture

Fixture 是用于为测试提供初始化环境和数据的功能。

可以将它理解为一段“准备工作”，它可以在每个测试用例之前执行，用来准备测试所需的数据、资源或配置，比如数据库连接、模拟数据、认证信息等。

2.定义 fixture 的步骤

①定义一个函数：这个函数可以做任何你需要的初始化工作（比如创建对象、准备数据、设置数据库连接等），并返回一个值供测试用例使用。

②使用 @pytest.fixture 装饰器：将该函数标记为 fixture。

③在测试用例中传入 fixture 的名称：pytest 会自动将 fixture 的返回值传递给测试用例

3.yield 的作用：

 yield 在 pytest 的 fixture 中起到前后置操作的作用，主要用于拆分前置操作（如资源的创建、初始化）和后置操作（如资源的清理、关闭）。

通俗解释：

在 yield 之前的代码相当于“初始化”工作，yield 返回的值会被测试用例使用，等测试用例执行完毕后，yield 之后的代码才会执行，也就是“清理”工作。

4.举例说明：

'''

假如我们使用 @pytest.fixture 装饰器将该函数temp_file标记为 fixture，

在temp_file函数中创建一个临时文件夹，然后将文件返回出去，最后再删除文件

步骤拆分：

1.创建一个临时文件夹:(预期)前置操作，即其他方法在运行前，先调用这个操作

2.返回结果给测试用例:(预期)跟着1走，在1运行完后，紧接着将结果返回

3.删除文件:(预期) 仅在"使用该 fixture 的测试用例执行完毕后"立即执行

'''

5.代码示例：

import pytest

# 定义 fixture，用于创建临时文件并在测试后删除
@pytest.fixture
def temp_file():
    # 前置操作：创建一个临时文件
    file = open("temp.txt", "w")
    file.write("Temporary file for testing")
    file.close()

    # yield 让 pytest 返回结果给测试用例
    yield "temp.txt"

    # 后置操作：测试用例结束后删除文件
    import os
    os.remove("temp.txt")

# 使用 fixture 的测试用例
def test_temp_file_exists(temp_file):
    # temp_file 是 fixture 返回的临时文件名
    assert os.path.exists(temp_file)

6.注意事项：

yield 后面的清理操作 只会在使用该 fixture 的测试用例执行完毕后 立即执行，而不是等所有测试用例全部执行完毕。换句话说，pytest 会在每个引用该 fixture 的测试用例结束后，马上执行 yield 后的清理代码。

7.总结

• yield 的主要作用：在 pytest.fixture 中拆分初始化和清理工作。yield 之前的代码是前置操作，yield 返回的值供测试用例使用，yield 之后的代码是后置操作，在测试用例执行完后才会运行。
• 在 temp_file 的例子中，yield 暂停了 fixture 的执行，让文件 "temp.txt" 可以被测试用例引用和操作，只有在测试用例执行结束后，才会删除该文件。