【pytest】`setup`和`teardown`

在Python的pytest测试框架中，setup和teardown是用于准备测试环境和清理测试环境的钩子函数。不过，pytest中使用的术语略有不同。pytest使用setup_method、teardown_method、setup_class、teardown_class、setup_module和teardown_module等函数来执行不同级别的设置和清理任务。下面详细讲解这些函数：

1. 函数级别的设置和清理

setup_method(self, method): 在每个测试方法（函数）执行前调用。
teardown_method(self, method): 在每个测试方法（函数）执行后调用。

这两个方法适用于测试类中的每个单独测试方法。

import pytestclass TestExample:def setup_method(self, method):# 在每个测试方法前执行print("Setting up for", method.__name__)def teardown_method(self, method):# 在每个测试方法后执行print("Tearing down after", method.__name__)def test_one(self):assert Truedef test_two(self):assert True

2. 类级别的设置和清理

setup_class(cls): 在测试类的第一个测试方法执行前调用一次（仅一次）。
teardown_class(cls): 在测试类的最后一个测试方法执行后调用一次（仅一次）。

这两个方法用于设置和清理整个测试类所需的资源。

import pytestclass TestExample:@classmethoddef setup_class(cls):# 在整个测试类开始前执行一次print("Setting up the class")@classmethoddef teardown_class(cls):# 在整个测试类结束后执行一次print("Tearing down the class")def test_one(self):assert Truedef test_two(self):assert True

3. 模块级别的设置和清理

setup_module(module): 在模块中的第一个测试函数执行前调用一次（整个模块只调用一次）。
teardown_module(module): 在模块中的最后一个测试函数执行后调用一次（整个模块只调用一次）。

这两个方法用于设置和清理整个测试模块所需的资源。

import pytestdef setup_module(module):# 在模块的第一个测试前执行一次print("Setting up the module")def teardown_module(module):# 在模块的最后一个测试后执行一次print("Tearing down the module")def test_function_one():assert Truedef test_function_two():assert True

注意事项：

在pytest中，setup和teardown是通用的概念，但具体的实现方法名称有所不同。
这些钩子方法通常定义在测试类内部或测试模块中，并且通常带有特定的装饰器或按照pytest的命名约定来命名。
如果你使用的是pytest的fixture功能，那么setup和teardown的功能可以通过fixture来实现，并且fixture提供了更强大和灵活的功能。
对于一些简单的测试场景，你可能不需要使用类级别的setup_class和teardown_class，而只需使用函数级别的setup_method和teardown_method，或者更简单地使用fixture。

Fixture 替代 setup/teardown

pytest的fixture是一个强大的功能，它可以替代setup和teardown方法，并提供更多的灵活性和可重用性。fixture允许你定义可复用的测试资源，这些资源可以在多个测试用例之间共享。

下面是一个使用fixture的例子：

import pytest@pytest.fixture(scope="module")
def setup_module_data():# 这个fixture在整个模块的所有测试开始之前执行一次print("Setting up module data")yield  # 在测试结束后，但teardown逻辑执行前暂停print("Tearing down module data")def test_something(setup_module_data):# 这个测试将接收fixture返回的数据（如果有的话）assert Truedef test_another_thing(setup_module_data):# 另一个测试也会接收相同的fixture数据assert True