Python pytest进阶:Fixture详解与实战
本文深入解析Python pytest框架中的核心组件fixture。详细阐述fixture的定义方法、三种调用方式及其区别,重点讲解scope参数控制的四种作用范围(session/module/class/function)。通过yield关键字实现teardown清理逻辑,并结合Selenium示例展示浏览器生命周期管理。文章提供完整代码示例与执行结果分析,帮助开发者掌握pytest高级用法。
前言
前言
学习pytest时,fixture是必须掌握的核心概念。它相当于unittest中的setup和teardown方法,如果不理解fixture,使用pytest与unittest并无本质区别(个人观点)。
fixture用途
fixture用途
1. 用于测试前后的初始化设置,如准备测试数据、连接数据库、启动浏览器等操作均可通过fixture实现。
2. 测试用例的前置条件可通过fixture实现。
3. 支持经典的xunit fixture,类似于unittest中的setup和teardown。
4. 实现unittest无法完成的功能,例如unittest中测试用例间无法传递参数和数据,而fixture可以解决这一问题。
fixture定义
fixture定义
fixture通过@pytest.fixture()装饰器装饰一个函数,该函数即为fixture。以下是一个示例。
# test_fixture.py
import pytest
@pytest.fixture()
def fixtureFunc():
return 'fixtureFunc'
def test_fixture(fixtureFunc):
print('我调用了{}'.format(fixtureFunc))
if __name__=='__main__':
pytest.main(['-v', 'test_fixture.py'])
执行结果
test_fixture.py .我调用了fixtureFunc
[100%]
========================== 1 passed in 0.02 seconds ===========================
Process finished with exit code 0
fixtureFunc函数即为一个fixture,其内部可实现初始化操作。
fixture使用
fixture使用
调用fixture有三种方式。
方式1:将fixture的名字直接作为测试用例的参数,上述示例即采用此方式。再来看一个实例。
# test_fixture.py
import pytest
@pytest.fixture()
def fixtureFunc():
return 'fixtureFunc'
def test_fixture(fixtureFunc):
print('我调用了{}'.format(fixtureFunc))
class TestFixture(object):
def test_fixture_class(self, fixtureFunc):
print('在类中使用fixture "{}"'.format(fixtureFunc))
if __name__=='__main__':
pytest.main(['-v', 'test_fixture.py'])
方式2
在每个函数或类前使用@pytest.mark.usefixtures('fixture')装饰器进行装饰。
实例
# test_fixture.py
import pytest
@pytest.fixture()
def fixtureFunc():
print('\n fixture->fixtureFunc')
@pytest.mark.usefixtures('fixtureFunc')
def test_fixture():
print('in test_fixture')
@pytest.mark.usefixtures('fixtureFunc')
class TestFixture(object):
def test_fixture_class(self):
print('in class with text_fixture_class')
if __name__=='__main__':
pytest.main(['-v', 'test_fixture.py'])
方式3
指定fixture的参数autouse=True,使每个测试用例自动调用fixture(此处表述不够严谨,因为还涉及fixture的作用范围,我们这里默认是函数级别的,后续会具体说明fixture的作用范围)。
实例
# test_fixture.py
import pytest
@pytest.fixture(autouse=True)
def fixtureFunc():
print('\n fixture->fixtureFunc')
def test_fixture():
print('in test_fixture')
class TestFixture(object):
def test_fixture_class(self):
print('in class with text_fixture_class')
if __name__=='__main__':
pytest.main(['-v', 'test_fixture.py'])
结果
fixture->fixtureFunc
.in test_fixture
fixture->fixtureFunc
.in class with text_fixture_class
[100%]
========================== 2 passed in 0.04 seconds ===========================
从结果可以看出,每个测试用例执行前都自动执行了fixture。
小结
掌握上述方法即可使用fixture,那么这几种方式有何区别?从代码中可以看出,如果测试用例需要使用fixture返回的参数,后两种方式无法使用返回值,因为fixture返回的数据默认存储在fixture名称中,因此只有第一种方式可以调用fixture中的返回值。(理论如此,建议读者自行实践验证!)
fixtur作用范围
fixtur作用范围 上述所有示例默认均为函数级别,因此只要测试函数调用了fixture,在测试函数执行前都会先执行指定fixture。谈及作用范围,不得不提fixture的第二个参数scope参数。
scope参数可以是session、module、class、function;默认为function。
1. session会话级别(通常此级别会结合conftest.py文件使用,后续提及conftest.py文件时再详述)。
2. module模块级别:模块内所有用例执行前执行一次module级别的fixture。
3. class类级别:每个类执行前都会执行一次class级别的fixture。
4. function函数级别:前述示例已说明,此为默认模式,每个测试用例执行前都会执行一次function级别的fixture。
下面我们通过一个实例具体查看fixture的作用范围。
# test_fixture.py
import pytest
@pytest.fixture(scope='module', autouse=True)
def module_fixture():
print('\n-----------------')
print('我是module fixture')
print('-----------------')
@pytest.fixture(scope='class')
def class_fixture():
print('\n-----------------')
print('我是class fixture')
print('-------------------')
@pytest.fixture(scope='function', autouse=True)
def func_fixture():
print('\n-----------------')
print('我是function fixture')
print('-------------------')
def test_1():
print('\n 我是test1')
@pytest.mark.usefixtures('class_fixture')
class TestFixture1(object):
def test_2(self):
print('\n我是class1里面的test2')
def test_3(self):
print('\n我是class1里面的test3')
@pytest.mark.usefixtures('class_fixture')
class TestFixture2(object):
def test_4(self):
print('\n我是class2里面的test4')
def test_5(self):
print('\n我是class2里面的test5')
if __name__=='__main__':
pytest.main(['-v', '--setup-show', 'test_fixture.py'])
运行结果
我们在cmd中执行使用--setup-show可以查看具体setup和teardown顺序。
test_fixture.py
SETUP M module_fixture
SETUP F func_fixture
-----------------
我是module fixture
-----------------
-----------------
我是function fixture
-------------------
test_fixture.py::test_1 (fixtures used: func_fixture, module_fixture).
我是test1
TEARDOWN F func_fixture
SETUP C class_fixture
SETUP F func_fixture
-----------------
我是class fixture
-------------------
-----------------
我是function fixture
-------------------
test_fixture.py::TestFixture1::test_2 (fixtures used: class_fixture, func_fixture, module_fixture).
我是class1里面的test2
TEARDOWN F func_fixture
SETUP F func_fixture
-----------------
我是function fixture
-------------------
test_fixture.py::TestFixture1::test_3 (fixtures used: class_fixture, func_fixture, module_fixture).
我是class1里面的test3
TEARDOWN F func_fixture
TEARDOWN C class_fixture
SETUP C class_fixture
SETUP F func_fixture
-----------------
我是class fixture
-------------------
-----------------
我是function fixture
-------------------
test_fixture.py::TestFixture2::test_4 (fixtures used: class_fixture, func_fixture, module_fixture).
我是class2里面的test4
TEARDOWN F func_fixture
SETUP F func_fixture
-----------------
我是function fixture
-------------------
test_fixture.py::TestFixture2::test_5 (fixtures used: class_fixture, func_fixture, module_fixture).
我是class2里面的test5
TEARDOWN F func_fixture
TEARDOWN C class_fixture
TEARDOWN M module_fixture
========================== 5 passed in 0.05 seconds ===========================
我们可以很清楚地看到整个模块只执行了一次module级别的fixture,每个类分别执行了一次class级别的fixture,而每一个函数之前都执行了一次function级别的fixture。
fixture实现teardown
fixture实现teardown
前述所有示例仅做了测试用例执行前的准备工作,那么用例执行后如何实现环境清理工作呢?这不得不说yield关键字,想必大家或多或少的知道这个关键字,其作用与return类似,也能返回数据给调用者,唯一的不同是被调用函数执行遇到yield会停止执行,接着执行调用处的函数,调用出的函数执行完后会继续执行yield关键字后面的代码(具体原理可参考我之前关于生成器的文章)。看下面的实例来了解如何实现teardown功能。
import pytest
from selenium import webdriver
import time
@pytest.fixture()
def fixtureFunc():
'''实现浏览器的打开和关闭'''
driver = webdriver.Firefox()
yield driver
driver.quit()
def test_search(fixtureFunc):
'''访问百度首页,搜索pytest字符串是否在页面源码中'''
driver = fixtureFunc
driver.get('http://www.baidu.com')
driver.find_element_by_id('kw').send_keys('pytest')
driver.find_element_by_id('su').click()
time.sleep(3)
source = driver.page_source
assert 'pytest' in source
if __name__=='__main__':
pytest.main(['--setup-show', 'test_fixture.py'])
这个实例会先打开浏览器,然后执行测试用例,最后关闭浏览器。大家可以试试!通过yield就实现了用例执行后的teardown功能。
总结
总结
1. fixture如何定义
2. fixture的使用方式
3. fixture作用范围
4. fixture用yield实现teardown功能
最后提一句:实际工作中尽量少用auto=True这个参数,可能会引发意想不到的结果!最常用的还是通过传递参数最好!
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持本站。
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













