pytest解读fixtures中yield与addfinalizer区别

Wanda ·

更新时间:2024-11-13

· 1764 次阅读

前言

一、问题回顾

二、问题解决

前言

在上一章中，文末留下了一个坑待填补，疑问是这样的：

目前从官方文档中看到的是

We have to be careful though, because pytest will run that finalizer once it’s been added, even if that fixture raises an exception after adding the finalizer.

一旦添加了终结器，pytest便会执行。

但是，当我尝试在setup代码中进行抛错，终结器的代码却并没有执行。尝试搜索外网暂时也没得到有效的帮助，只能在GitHub上向pytest提了issue了，这里算是埋下一个坑，待后续解决。

一、问题回顾

其实说到底还是我理解的不对，可能当时自己处在疑问中难免就会陷入进死循环，后来在github上经过别人提点方才醒悟。先来看下当时我尝试演示出上述结果的代码，也就是：setup代码中进行抛错，终结器的代码却并没有执行。

代码分为2部分，一个是fixture函数代码，另一个则是测试用例。代码是不能直接copy出来运行的，是我在项目的用例中进行改造的，在这里仅仅帮助说明意思。

# content of conftest.py
@pytest.fixture()
def init_data_allot_task(request):
    query_sql = """
    SELECT id FROM `sm_purchase_allot` WHERE `status`!=5
    """
    db = DB()
    data = db.fetch_one(query_sql)
    db.close()
    def demo_finalizer():
        print("running finalizer code...")
    request.addfinalizer(demo_finalizer)
    return data

# content of testcase
...
def test_allot_detail(init_data_allot_task):
    """
    """
    payload = {
          "allotId": init_data_allot_task[0]
        }
    r = requests.post(QA_URL + API_URL, json=payload, headers=HEADER)
    result = r.json()
    assert result["result"] == "ok"
    assert result["errmsg"] == "success"
    assert len(result["row"]["taskListOfPage"]["resultData"]) &gt; 0

最开始我想做的是，在fixture函数中，让代码db = DB()抛出一个mysql连接超时的错误，然后就能在控制台中看到"running finalizer code..."的输出。

但是我执行后，并没有看到预期的输出，说明setup代码抛错后，addfinalizer代码并没有执行。

最后经过github上朋友指点后，发现还是我自己理解错了。

二、问题解决

还是来看下官方的原文：

We have to be careful though, because pytest will run that finalizer once it’s been added, even if that fixture raises an exception after adding the finalizer.

这句话意思其实是说，当finalizer 一旦添加成功后，pytest就会去执行它。就算是fixture函数在添加了finalizer之后抛出了异常。

按照这样理解的话，那我在fixture函数中的代码就有问题了。因为db = DB()代码在request.addfinalizer(demo_finalizer)之前就抛错了，那么实际上并没有执行到添加终结器的这行代码，所以终结器都还没添加成功，又怎么会去执行呢？

终于我明白过来了，于是调整了代码顺序，把request.addfinalizer(demo_finalizer)放到前面去，然后再接上fixture的代码：

# content of conftest.py
@pytest.fixture()
def init_data_allot_task(request):
    query_sql = """
    SELECT id FROM `sm_purchase_allot` WHERE `status`!=5 
    """
    def demo_finalizer():
        print("running finalizer code...")
    request.addfinalizer(demo_finalizer)
    print("running setup code...")
    db = DB()
    data = db.fetch_one(query_sql)
    db.close()
    return data

如此来看，我们会先看到"running setup code..."的输出，然后看到mysql抛错，最后仍然可以看到"running setup code..."的输出。

运行代码验证一下：