pytest-cov统计aiohttp异步方法覆盖率时return行未覆盖如何解决

你遇到的问题是pytest-cov底层依赖的coverage.py工具对异步代码的跟踪缺陷导致的，和你查到的C#场景问题本质逻辑一致：当await等待的协程执行速度极快（比如数据库操作被Mock后瞬间返回、或者实际查询耗时低于跟踪探针的采样阈值），没有触发异步挂起逻辑直接返回结果时，旧版本的coverage.py会漏记await之后代码行的执行记录，所以会误判return所在行没有被覆盖。
另外还有两种可能触发该问题的场景：

1. 自定义的session_decorator装饰器没有用functools.wraps保留原函数元信息，导致覆盖率工具无法正确关联执行逻辑到原函数
2. 测试代码只断言了响应状态码，没有读取响应体，aiohttp的测试客户端可能提前终止了请求处理链，没有完整触达视图函数的return逻辑

• 第一步先升级相关依赖到最新版本，新版本coverage.py已经修复了绝大多数异步代码跟踪遗漏问题：

pip install -U coverage pytest-cov aiohttp pytest-aiohttp

• 调整测试代码，补充响应体读取逻辑，确保视图函数完整执行完毕：

from http import HTTPStatus

async def test_healthz_page(test_client):
    response = await test_client.get("/healthz")
    assert response.status == HTTPStatus.OK
    # 新增读取响应内容的逻辑，确认return语句执行完成
    resp_json = await response.json()
    assert resp_json["status"] == "ok"

• 检查自定义装饰器的异步兼容性，必须添加functools.wraps保留原函数元信息：

import functools

def session_decorator():
    def wrapper(func):
        @functools.wraps(func) # 该配置不可缺少
        async def inner(request):
            # 你的session生成逻辑
            session = get_db_session()
            return await func(session, request)
        return inner
    return wrapper

• 若上述操作后仍有问题，在项目根目录新增.coveragerc配置文件，开启异步并发跟踪模式：

[run]
concurrency = asyncio,thread
source = .

之后再运行原测试命令即可得到准确的覆盖率数据：

python3.9 -m pytest -vv --cov --cov-report xml --cov-report term-missing

内容的提问来源于stack exchange，提问作者Anton Pomieshchenko