【pytest】`setup`和`teardown`

在Python的pytest测试框架中,setupteardown是用于准备测试环境和清理测试环境的钩子函数。不过,pytest中使用的术语略有不同。pytest使用setup_methodteardown_methodsetup_classteardown_classsetup_moduleteardown_module等函数来执行不同级别的设置和清理任务。下面详细讲解这些函数:

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

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

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

python 复制代码
import pytest

class 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 True

    def test_two(self):
        assert True

2. 类级别的设置和清理

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

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

python 复制代码
import pytest

class TestExample:
    @classmethod
    def setup_class(cls):
        # 在整个测试类开始前执行一次
        print("Setting up the class")

    @classmethod
    def teardown_class(cls):
        # 在整个测试类结束后执行一次
        print("Tearing down the class")

    def test_one(self):
        assert True

    def test_two(self):
        assert True

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

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

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

python 复制代码
import pytest

def setup_module(module):
    # 在模块的第一个测试前执行一次
    print("Setting up the module")

def teardown_module(module):
    # 在模块的最后一个测试后执行一次
    print("Tearing down the module")

def test_function_one():
    assert True

def test_function_two():
    assert True

注意事项:

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

Fixture 替代 setup/teardown

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

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

python 复制代码
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 True

def test_another_thing(setup_module_data):
    # 另一个测试也会接收相同的fixture数据
    assert True

在这个例子中,setup_module_data是一个fixture,它的作用类似于模块级别的setup_moduleteardown_module。使用yield语句,我们可以在fixture内部划分设置和清理的逻辑。在yield之前的

相关推荐
新子y10 分钟前
【小白笔记】岛屿数量
笔记·python
CLubiy15 分钟前
【研究生随笔】Pytorch中的线性代数
pytorch·python·深度学习·线性代数·机器学习
reasonsummer18 分钟前
【办公类-115-02】20251018信息员每周通讯上传之文字稿整理(PDF转docx没有成功)
python·pdf
材料科学研究25 分钟前
深度学习物理神经网络(PINN)!
python·深度学习·神经网络·pinn
兰文彬30 分钟前
Pytorch环境安装指南与建议
人工智能·pytorch·python
写不来代码的草莓熊38 分钟前
vue前端面试题——记录一次面试当中遇到的题(9)
前端·javascript·vue.js
哦你看看1 小时前
学习Python 03
开发语言·windows·python
后端小张1 小时前
[AI 学习日记] 深入解析MCP —— 从基础配置到高级应用指南
人工智能·python·ai·开源协议·mcp·智能化转型·通用协议
天青色等烟雨..1 小时前
AI+Python驱动的无人机生态三维建模与碳储/生物量/LULC估算全流程实战技术
人工智能·python·无人机
JinSo1 小时前
pnpm monorepo 联调:告别 --global 参数
前端·github·代码规范