Pytest进阶之fixture的使用（超详细）

Fixture定义

Fixture使用方式

作为参数使用

Fixture间相互调用(作为参数调用)

作为conftest.py文件传入

Fixture作用范围Scope

function

class

module

session

Fixture中params和ids

Fixture中autouse

Fixture中Name

总结

pytest fixture 是一种用来管理测试依赖和资源的机制。

简单来说，就是做初始化准备，比如一些测试用例需要打开浏览器或者链接数据库才能进行测试，因此我们需要在有需要的测试用例面前加上fixture进行测试前的资源准备。

Fixture定义

通过在函数前面加上

@pytest.fixture()装饰器来装饰一个函数，那么被装饰的这个函数就是一个fixture

先来简单的用一下：

我们在一个普通函数前面加上@pytest.fixture()

@pytest.fixture()
def fixtureFunc():
    return "I am Fixture"

这样这个函数就是一个fixture了，然后我们在用例中使用这个fixture

class TestDemo:
    def test_case1(self,fixtureFunc):
        print(fixtureFunc)
        assert fixtureFunc == "I am Fixture"

这个方式是作为参数传入，后面还有其它的传入方式，我们等下再说

运行后我们发现已经成功输出了fixture函数中的值，而且用例也passed了

Fixture使用方式

Fixture共三种使用方式：

1.作为参数传入

2.fixture相互调用(也相当于作为参数传入)

3.作为conftest.py文件传入

我接下来会分别讲这三种使用方式

作为参数使用

我创建2个fixture函数，分别为login和logout，login如果被调用输出“登录”，并返回“Account”；logout如果被调用，则输出“退出”，并返回“Exit”

然后我在测试类中创建3个测试方法：

第一个case 我在参数中传入login，并输出

第二个case 不传入任何参数

第三个case 两个fixture(login，logout)全部传入，也输出

如下：

import pytest

@pytest.fixture()
def login():
    print("登录")
    return "Account"

@pytest.fixture()
def logout():
    print("退出")
    return "Exit"

class TestDemo:
    def test_case1(self,login):
        print("我传入了Login Fixture")
        assert login == "Account"

    def test_case2(self):
        print("我没传入任何 Fixture")

    def test_case3(self,login,logout):
        print("我传入了两个Fixture")
        assert login == "Account"
        assert logout == "Exit"


if __name__ == '__main__':
    pytest.main(['-s','test_2.py'])

预期结果：

case1：首先在参数中调用了login，则会自动寻找login的fixture，找到后输出
“登录”和“我传入了Login Fixture”

case2：由于没有传入任何Fixture，所以只会输出“我没传入任何 Fixture”

case3：两个fixture都传入了，那么输出“登录”和“退出”，以及测试方法本身的“我传入了两个Fixture”

我们运行验证一下结果：

可以看到谁出结果符合我们的预期，这便是作为参数的一种使用方法

Fixture间相互调用(作为参数调用)

该方法其实是属于作为参数调用的一种特殊情况，只不过是是某个Fixture方法又调用了其他Fixture方法，而不是测试用例调用Fixture方法

现在有一个login和account的fixture，login参数中调用了account。

在测试用例中，有一个用例调用了login，另一个用例调用了account，先看代码：

import pytest

@pytest.fixture()
def account():
    print("Account")
    return "Ret-Account"

#调用上面的account fixture
@pytest.fixture()
def login(account):
    print("Login")

class TestDemo:
    def test_case1(self,login):
        print("调用了login,返回值为{}".format(login))
    def test_case2(self,account):
        print("调用了account，返回值为{}".format(account))

我们注意，login是没有返回值的，而account有一个返回值

那我们执行用例，结果是什么呢？

在命令行或终端输入 pytest -s .\test_2.py，，文件名和路径改成自己的就可以

可以看到。test_case1调用login后，login的参数中有account fixture，因此先调用了account，然后再执行login自己内部的逻辑，因此输出了Login，最后执行了test_case1中的逻辑

但是返回值是None，这是因为返回值永远是上一次调用的函数返回的值，虽然login调用了account，account给login返回了一个值，但是login没用这个值，也没有返回任何值给test_case1,所以这个测试用例是没有返回值的

作为对照，test_case2直接调用了account，然后返回了Ret-Account，也是符合我们预期的

做一下总结及补充：

1.Fixture之间支持相互调用，但普通函数直接调用fixture是不生效的，必须在测试函数中调用才会生效
2.多层fixture调用时，会最先执行最后一层fixture，然后再依次向前执行。类似于C语言中的压栈。例如这个例子调用顺序是test_case1->login->account,那么他就会先执行account，再执行login，最后执行test_case1
3.不会自动return 上一层函数返回的值。例如login 接收到了上一层account的返回值，但是它并没有返回account返回的这个值，而是None，取决login本身return 的值

作为conftest.py文件传入

如果我们想在多个测试文件中，使用同一个fixture，那么我们可以单独将这个fixture拿出来，放到conftest.py文件中。

下面是使用conftest.py文件的规则：

1.conftest.py文件名是固定的，不可以修改
2.conftest.py与运行用例在同一个包下，并且该包中有__init__.py文件
3.运行其他测试文件时会自动寻找conftest.py文件，而不需要手动导入

我们首先创建一个名为conftest.py文件，然后再新建两个.py文件，分别使用conftest.py文件中的fixture

conftest.py:

@pytest.fixture()

def login():
    print("Login")
    return "Ret-Login"

test_1.py

import pytest

def test_case1(login):
    print(login)
    assert login == "Ret-Login"

test_2.py

import pytest

def test_case2(login):
    assert login != "Ret-Login"

然后我们在命令行执行这两个文件：

 pytest -s .\test_1.py .\test_2.py

可以看到case1确实如预期结果所示，调用了conftest.py中的fixture，正确输出而且断言正确

case2也调用了fixture，断言错误，和预期一样

Fixture作用范围scope

Fixture的参数如下:

@pytest.fixture(scope = "function",params=None,autouse=False,ids=None,name=None)

fixture的作用范围(scope)共有4种：function，class，module，session

范围依次递增的：即function < class < module < session

我依次来讲解这些作用范围

function

其实我们刚才使用的是例子scope一直是function，它也是默认值

当scope=“function”时，只要有测试函数显示调用fixture时，都会执行一次fixture。但是如果测试函数没有调用fixture，那么就不会执行fixture

如下：

import pytest

@pytest.fixture()
def login():
    print("Login")
    return "Ret-Login"

class TestDemo:
    #调用login,则会调用一次fixture
    def test_case1(self,login):
        print("case1")
    #不调用login，则不会调用fixture
    def test_case2(self):
        print("case2")
    #调用login，则第二次调用fixture，加上case1，一共调用了两次
    def test_case3(self,login):
        print("case3")
        assert login == "Ret-Login"

我们看运行结果：

可以看到第一次和第三次都调用了Login，一共调用了2次，第二次没调用

所以总结是：只要有测试方法调用了fixture，那么fixture都会被执行一次

class

当scope=“class”时，有两种场景：

1.测试类下所有的测试方法都调用了fixture，那么fixture只执行一次，时机为测试类中所有测试方执行前。
2.测试类下只有部分测试方法调用了fixture，那么fixture只执行一次，时机为在测试类中第一个调用fixture的测试方法前执行

不理解可以看下面的例子：

对于1：测试类下所有的测试方法都调用了fixture

import pytest

@pytest.fixture(scope="class")
def login():
    print("Scope='class'")
    return "Ret-Login"

class TestDemo:
    def test_case1(self,login):
        print("case1")
        assert login == "Ret-Login"
    def test_case2(self,login):
        print("case2")
    def test_case3(self,login):
        print("case3")
        assert login != "Ret-Login"

测试结果：

可以看到虽然类中有3个测试函数都调用了fixture，但是由于scope=“class”，所以最终fixture在所有测试方法执行前只调用了一次

对于2：测试类下只有部分测试方法调用了fixture

import pytest

@pytest.fixture(scope="class")
def login():
    print("Scope='class'")
    return "Ret-Login"

class TestDemo:
    def test_case1(self):
        print("case1")

    def test_case2(self,login):
        print("case2")
    def test_case3(self,login):
        print("case3")
        assert login == "Ret-Login"

我们预期的是，先执行完case1，然后case2中由于是第一个调用login fixture，所以此时调用一次login，然后case3就不再调用login了，因为scope=“class”，所以只从第一个调用处调用一次、

结果如下：

可以看到确实结果如我们所预料的，而且case3正常通过，说明login已经能正常使用了

module

当scope=“module”时，则范围会对当前整个.py文件生效

与class相同，会在第一个调用fixture的测试方法前调用一次然后生效，后面即使再有其他测试方法调用fixture，也不会再调用

import pytest

@pytest.fixture(scope="module")
def login():
    print("Scope='module'")
    return "Ret-Login"

def test_case(login):
    print("test_case")

class TestDemo:
    def test_case1(self,login):
        print("case1")
    def test_case2(self,login):
        print("case2")
    def test_case3(self,login):
        print("case3")
        assert login == "Ret-Login"

从上向下执行，会先执行test_case,然后调用一次login fixture对后面其他调用的也就生效了，后面即使TestDemo中所有的测试方法都调用了login，也不会在调用了

可以看到也就在test_case第一次调用前调用了一次fixture，后面都没有再调用了

session

当scope=“session”时，则范围会对所有的.py文件生效

还记得我们刚才说的conftest.py文件吗？其实该范围主要是应用在这里

这里有两个.py文件，test_1.py,test_2.py.

如果conftest.py文件中的fixture的scope=“module”

那么当test_1.py文件第一次测试方法调用fixture后，test_1.py文件里后面其它的测试方法便不再调用，但是如果test_1.py文件执行完后，此时test_2.py也有测试方法调用fixture，那么测试还会再调用一次，这样相当于调用了2次

先看代码，看着代码理解会容易一些：

conftest.py：

import pytest

@pytest.fixture(scope="module")
def login():
    print("Scope='module'")
    return "Ret-Login"

test_1.py:

import pytest

def test_case1(login):
    print("case1")
    assert login == "Ret-Login"

def test_case2(login):
    print("case2")

def test_case3(login):
    print("case3")

test_2.py:

import pytest


def test_case(login):
    print("test_case")

class TestDemo:
    def test_case1(self,login):
        print("case1")
    def test_case2(self,login):
        print("case2")
    def test_case3(self,login):
        print("case3")
        assert login == "Ret-Login"

可以看到此时scope是“module”，我们运行：

可以看到此时确实一个文件都执行了一次

此时我把conftest.py文件中的scope换成“session”：

import pytest

@pytest.fixture(scope="session")
def login():
    print("Scope='session'")
    return "Ret-Login"

运行：

可以看到此时虽然有多个测试文件，但fixture只被调用了一次，这便是session的作用了

Fixture中参数列表params和ids

params是fixture的第二个参数，它是Fixture的可选形参列表，支持列表传入

默认不写为None；

如果传入列表，对于传入的列表的每个值（参数），fixture都会执行一次。可以与第三个参数ids搭配使用，ids是每个参数的标识。类似for循环

在pytest中有一个内建的fixture叫做request，request.param 是 pytest 提供的一种机制，用于访问 fixture 参数化过程中每个参数值。

调用每一个参数，固定写法：

request.param

比如我想写一个带参数列表的fixture，然后每次都返回这几个参数，写法如下（这里我搭配了ids）：

@pytest.fixture(params=[1, 2, 3], ids=["param1", "param2", "param3"])
def some_fixture(request):
    return request.param

然后我们使用一个测试用例来调用这个fixture

import pytest


@pytest.fixture(params=[1, 2, 3], ids=["param1", "param2", "param3"])
def some_fixture(request):
    return request.param

def test_fixture(some_fixture):
    print(f"Running test with param: {some_fixture}")
    assert some_fixture > 0

可以看到三个值都已经被输出出来了，说明那3个参数全部被传入fixture了

如果我再加一个测试用例：

可以看到1,2,3又被执行了一次

说明对于每个测试用例，fixture都会将参数列表的值传入执行。

比如fixture参数列表有3个，有两个测试用例

那么fixture一共会被执行2*3=6次

Fixture中autouse

autouse默认为Fasle

pytest 中的 fixture 只有在被显式地调用或作为测试函数的参数传递时才会执行。但是，如果你希望某个 fixture 在所有测试函数执行之前或之后自动执行，可以使用 autouse=True 来实现这一点。

即不需要再测试方法前面加上fixture调用，不需要加任何东西，他就会自动调用。

哪怕你没有使用该fixture,也会调用一次

我举个例子

@pytest.fixture(autouse=False)
def testAutouse():
    print("autouse is called")

def test_case1(login):
    print("case1")

def test_case2():
    print("case2")

可以看到只有显式调用fixture，才被执行了

但是当我们把autouse=True

可以看到即使case2没有调用testautouse，它也被调用了一次，这便是autouse的作用

Fixture中Name

pytest 中，fixture 可以通过参数传递一个可选的 name 参数，这个参数的作用是为 fixture 显式命名，使得在测试报告中能够更清晰地识别和显示这个 fixture 的名称。

如果使用了name，那么后面传参只能使用这个name进行传参，而原本的fixture的名字会失效，

import pytest
#指定old_Fixture新名字为new_Fixture
@pytest.fixture(name="new_Fixture")
def old_Fixture():
    print("hello, Fixture")

def test_case1(new_Fixture):
    print("case1")
def test_case2(old_Fixture):
    print("case2")

此时我们再运行：

可以看到报错，说old_Fixture未找到，就印证了刚才我们所说的

总结

在 pytest 中，fixture 是一种用于管理测试依赖和资源的强大机制。它可以在测试函数之前设置（setup）需要的环境，并在测试函数执行后进行清理（teardown）。以下是 fixture 的关键用法和参数总结：

定义 fixture：

1.使用 @pytest.fixture 装饰器定义 fixture 函数。
2.Fixture 函数可以接受测试函数传入的参数，这些参数可以是其他 fixture 或者测试函数的参数。
3.可以设置不同作用域来控制 fixture 的生命周期，如 scope="function"、scope="module"、scope="class" 和 scope="session"。

参数化 fixture：