《带你装B，带你飞》pytest修仙之路5 - yield操作

1. 简介

　　上一篇中，我们刚刚实现了在每个用例之前执行初始化操作，那么用例执行完之后如需要清除数据（或还原）操作，可以使用 yield 来实现。fixture通过scope参数控制setup级别，既然有setup作为用例之前前的操作，用例执行完之后那肯定也有teardown操作。
这里用到fixture的teardown操作并不是独立的函数，用yield关键字呼唤teardown操作。fixture的teardown操作并不是独立的函数，可以用yield关键字呼唤teardown操作。　

　　我们之前学习的都是测试用例的前置固件，也就是相当于“setup”。说到这，细心的你可能想到了，那有没有什么方式可以表示出“teardown”？这就是我们今天学习的yield和addfinalizer。

yield

　　yield是一个关键字，它不是单独存在的，要写在fixtrue标记的固件中。

　　我们在声明的固件myfixture中加入yield关键字，在它下面写测试用例执行后想要运行的代码；其他有关于固件的使用没有任何差别。需要说明的一点是我们在pytest主函数中增加了一个参数“–setup-show”，他会显示出固件的执行情况。

　　fixture里面的teardown用yield来唤醒teardown的执行

　　如果测试用例中的代码出现异常或者断言失败，并不会影响他的固件中yield后的代码执行；但是如果固件中的yield之前的代码也就是相当于setup部分的带代码，出现错误或断言失败，那么yield后的代码将不会再执行，当然测试用例中的代码也不会执行。

　　我们也可以通过request.addfinalizer()的方式实现“teardown”

　　我们在固件中传入request参数；又在固件中定义了一个内置函数；最后将定义的内置函数添加到request的addfinalizer中。

2. scope="function"

当 pytest.fixture(scope="function") 时，pytest的yieId 类似unittest的teartown。每个方法（函数）都会执行一次

1.新建 test_bjhg_function1.py文件，我们看一下是不是这样的。

2.1 代码实现：

2.2 参考代码：

# coding=utf-8
# 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

# 2.注释：包括记录创建时间，创建人，项目名称。
'''
Created on 2020-04-20
@author: 北京-宏哥
Project:《带你装B，带你飞》pytest修仙之路5 - yield操作
'''
# 3.导入模块
import pytest

@pytest.fixture(scope="function")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1(login):
    print('操作1')
    print("-----------------------------------------------")

def test2(login):
    print('操作2')
    print("-----------------------------------------------")

def test3(login):
    print('操作3')
    print("-----------------------------------------------")

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

2.3 运行结果：

运行代码后，控制台打印如下图的结果

从结果看出，虽然test1,test2,test3三个地方都调用了login函数，并且它会在每一个用例前执行一次

2.如果test1不调用,test2（调用login）,test3不调用，运行顺序会是怎样的？

2.4 参考代码：

# coding=utf-8
# 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

# 2.注释：包括记录创建时间，创建人，项目名称。
'''
Created on 2020-04-20
@author: 北京-宏哥
Project:《带你装B，带你飞》pytest修仙之路5 - yield操作
'''
# 3.导入模块
import pytest

@pytest.fixture(scope="function")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1():
    print('操作1')
    print("-----------------------------------------------")

def test2(login):
    print('操作2')
    print("-----------------------------------------------")

def test3():
    print('操作3')
    print("-----------------------------------------------")

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

2.5 运行结果：

运行代码后，控制台打印如下图的结果

从结果看出，function级别的fixture在当前.py模块里，只会在用例（test_s2）第一次调用前执行一次

3.scope="module"

1.fixture参数scope=”module”，module作用是整个.py文件都会生效（ 整个文件只会执行一次），用例调用时，参数写上函数名称就行

3.1 代码实现：

3.2 参考代码：

# coding=utf-8
# 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

# 2.注释：包括记录创建时间，创建人，项目名称。
'''
Created on 2020-04-20
@author: 北京-宏哥
Project:《带你装B，带你飞》pytest修仙之路5 - yield操作
'''
# 3.导入模块
import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1(login):
    print('操作1')
    print("-----------------------------------------------")

def test2(login):
    print('操作2')
    print("-----------------------------------------------")

def test3(login):
    print('操作3')
    print("-----------------------------------------------")

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

3.3 运行结果：

运行代码后，控制台打印如下图的结果

从结果看出，虽然test1,test2,test3三个地方都调用了login函数，但是它只会在第一个用例前执行一次

2.如果test1不调用,test2（调用login）,test3不调用，运行顺序会是怎样的？

3.4 参考代码：

# coding=utf-8
# 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

# 2.注释：包括记录创建时间，创建人，项目名称。
'''
Created on 2020-04-20
@author: 北京-宏哥
Project:《带你装B，带你飞》pytest修仙之路5 - yield操作
'''
# 3.导入模块
import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("用例执行完成，收尾")

def test1():
    print('操作1')
    print("-----------------------------------------------")

def test2(login):
    print('操作2')
    print("-----------------------------------------------")

def test3():
    print('操作3')
    print("-----------------------------------------------")

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

3.5 运行结果：

运行代码后，控制台打印如下图的结果

从结果看出，module级别的fixture在当前.py模块里，只会在用例（test_s2）第一次调用前执行一次

4. yield执行teardown

　　细心的童鞋或者小伙伴可以看到，我前边的代码中有一个yield关键字，大家有点好奇是做什么的，这一小节就给你答疑解惑。其实就是用来唤醒teardown。

1.fixture里面的teardown用yield来唤醒teardown的执行

4.1 代码实现：

4.2 参考代码：

# coding=utf-8
# 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

# 2.注释：包括记录创建时间，创建人，项目名称。
'''
Created on 2020-04-20
@author: 北京-宏哥
Project:《带你装B，带你飞》pytest修仙之路5 - yield操作
'''
# 3.导入模块
import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("执行teardown!")
    print("用例执行完成，收尾")

def test1(login):
    print('操作1')
    print("-----------------------------------------------")

def test2(login):
    print('操作2')
    print("-----------------------------------------------")

def test3(login):
    print('操作3')
    print("-----------------------------------------------")

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

4.3 运行结果：

运行代码后，控制台打印如下图的结果

5. yield遇到异常

1.如果其中一个用例出现异常，不影响yield后面的teardown执行,运行结果互不影响，并且在用例全部执行完之后，会呼唤teardown的内容

5.1 代码实现：

5.2 参考代码：

# coding=utf-8
# 1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

# 2.注释：包括记录创建时间，创建人，项目名称。
'''
Created on 2020-04-20
@author: 北京-宏哥
Project:《带你装B，带你飞》pytest修仙之路5 - yield操作
'''
# 3.导入模块
import pytest

@pytest.fixture(scope="module")
def login():
    print("登录成功")
    yield
    print("执行teardown!")
    print("用例执行完成，收尾")

def test1(login):
    print('操作1')
    print("-----------------------------------------------")
    # 如果第一个用例异常了，不影响其他的用例执行
    raise NameError  # 模拟异常

def test2(login):
    print('操作2')
    print("-----------------------------------------------")

def test3(login):
    print('操作3')
    print("-----------------------------------------------")

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

5.3 运行结果：

运行代码后，控制台打印如下图的结果

2.如果在setup就异常了，那么是不会去执行yield后面的teardown内容了

3.yield也可以配合with语句使用，以下是官方文档给的案例

# 官方文档案例
# content of test_yield2.py

import smtplib
import pytest

@pytest.fixture(scope="module")
def smtp():
    with smtplib.SMTP("smtp.gmail.com") as smtp:
        yield smtp  # provide the fixture value

6.addfinalizer终结函数

1.除了yield可以实现teardown,在request-context对象中注册addfinalizer方法也可以实现终结函数。

# 官方案例

# content of conftest.py
import smtplib
import pytest

@pytest.fixture(scope="module")
def smtp_connection(request):
    smtp_connection = smtplib.SMTP("smtp.gmail.com", 587, timeout=5)
    def fin():
        print("teardown smtp_connection")
        smtp_connection.close()
    request.addfinalizer(fin)
    return smtp_connection  # provide the fixture value

2.yield和addfinalizer方法都是在测试完成后呼叫相应的代码。但是addfinalizer不同的是：

• 他可以注册多个终结函数。

• 这些终结方法总是会被执行，无论在之前的setup code有没有抛出错误。这个方法对于正确关闭所有的fixture创建的资源非常便利，即使其一在创建或获取时失败

7.小结

　好了，今天的分享就到这里吧！！！谢谢各位的耐心阅读。有问题加群交流讨论！！！

 

您的肯定就是我进步的动力。如果你感觉还不错，就请鼓励一下吧！记得随手点波  推荐  不要忘记哦！！！

别忘了点 推荐 留下您来过的痕迹

 

参考文档：https://docs.pytest.org/en/latest/