Python中如何利用pytest-mock的高级特性模拟复杂的上下文管理器?

阿墨小哥_8827

阿墨小哥_8827

2026-06-01

949人浏览

原创

异步上下文管理器需用mocker.async_mock()模拟__aenter__(返回资源)和__aexit__(返回True/False),不可用普通patch;__aexit__必须显式设返回值,否则报TypeError。

python中如何利用pytest-mock的高级特性模拟复杂的上下文管理器?

如何模拟异步上下文管理器的 __aenter__ 和 __aexit__

异步上下文管理器(如 aiohttp.ClientSession 或自定义 async with 块)不能用普通 mocker.patch 直接替换,因为其 __aenter__ 和 __aexit__ 是协程方法,需返回 Awaitable。直接 mock 普通方法会导致 TypeError: object X is not async iterable 或 RuntimeWarning: coroutine 'X' was never awaited。

正确做法是使用 mocker.async_mock() 创建支持异步协议的模拟对象,并显式设置 __aenter__ 和 __aexit__ 的返回值:

  • __aenter__.return_value 设为你要暴露给 as 变量的对象(比如字符串、字典或另一个 mock)
  • __aexit__.return_value 必须设为 False(表示不压制异常)或 True(压制),不能留空或设为 None,否则会报 TypeError: __aexit__ must return a bool
  • 若需验证异常处理逻辑,可在测试中主动抛出异常,并断言 __aexit__ 被调用且参数匹配
@pytest.mark.asyncio
async def test_async_context_manager(mocker):
    async_mock = mocker.async_mock()
    async_mock.__aenter__.return_value = {"data": "ok"}
    async_mock.__aexit__.return_value = False  # 不压制异常
<pre class="brush:php;toolbar:false;">async with async_mock as resource:
    assert resource == {"data": "ok"}

async_mock.__aenter__.assert_called_once()
async_mock.__aexit__.assert_called_once()

模拟带状态的同步上下文管理器(如数据库连接)

很多上下文管理器内部维护状态(如连接是否已关闭、事务是否已提交),单纯 patch __enter__ 返回固定值无法覆盖这类行为。常见错误是忽略 __exit__ 的副作用,导致后续断言失败或资源泄漏误判。

推荐用 mocker.Mock 手动构造,并通过 side_effect 控制状态流转:

  • 让 __enter__ 返回一个可变对象(如 dict 或自定义类实例),供后续操作修改
  • 让 __exit__ 接收 exc_type, exc_val, exc_tb 并根据需要改变内部状态(例如设置 .closed = True)
  • 避免用 mocker.patch.object(obj, '__enter__', ...) —— 它无法同时控制 __exit__ 行为,容易漏掉清理逻辑
def test_db_connection_context(mocker):
    mock_conn = mocker.Mock()
    mock_conn.closed = False
<pre class="brush:php;toolbar:false;">def exit_side_effect(exc_type, exc_val, exc_tb):
    mock_conn.closed = True
    return False  # 不压制异常

mock_conn.__enter__.return_value = mock_conn
mock_conn.__exit__.side_effect = exit_side_effect

with mock_conn:
    assert not mock_conn.closed
assert mock_conn.closed

链式调用 + 上下文管理器混合场景(如 session.get(...).json())

当被测代码写成 async with session.get(url) as resp: return await resp.json() 这类嵌套结构时,mock 需要同时满足:1)session.get 返回一个支持 __aenter__ 的响应 mock;2)该响应 mock 的 json 方法是协程。

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载

关键点在于分层构造,不能只 mock 最外层:

  • 先用 mocker.async_mock() 创建响应对象,设置 json.return_value 为期望数据
  • 再用另一个 mocker.async_mock() 创建 session mock,并让其 get.return_value 指向上一步的响应 mock
  • 确保所有中间对象都支持异步协议,否则 await resp.json() 会报 TypeError: object MagicMock is not awaitable
@pytest.mark.asyncio
async def test_session_get_json_chain(mocker):
    # 模拟响应对象
    mock_resp = mocker.async_mock()
    mock_resp.json.return_value = {"status": "ok"}
<pre class="brush:php;toolbar:false;"># 模拟 session 对象
mock_session = mocker.async_mock()
mock_session.get.return_value = mock_resp

# 替换模块中的 session 实例
mocker.patch("my_module.get_session", return_value=mock_session)

result = await my_module.fetch_data()
assert result == {"status": "ok"}
mock_session.get.assert_called_once()
mock_resp.json.assert_awaited_once()

为什么 mocker.spy() 不适用于上下文管理器?

mocker.spy() 的设计目标是“监控真实方法调用而不改变行为”,但它对 __enter__/__exit__ 无效——因为这两个方法在 with 语句中由 Python 解释器隐式调用,不走常规属性访问路径。尝试对它们 spy 会触发 AttributeError: __enter__ 或静默失败。

真正需要监控上下文行为时,应改用完整 mock 替换整个上下文管理器对象,再通过 assert_called_once() 等验证其协议方法是否被触发。spy 更适合用于普通实例方法或函数,比如 db.commit() 或 logger.info()。

最容易被忽略的是:异步上下文管理器的 __aexit__ 即使没发生异常也会被调用,且必须返回布尔值;同步版本的 __exit__ 同理——漏掉这个返回值,mock 就不是合法的上下文管理器。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1571

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3744

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1589

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

21517

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2647

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2707

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1083

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2083

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程