如何在 pytest 中为使用上下文管理器的类方法打桩并返回自定义值

大明姑娘_4832

大明姑娘_4832

2026-07-05

542人浏览

原创

本文介绍如何在纯 pytest 环境中,通过 monkeypatch 替换依赖上下文管理器(__enter__/__exit__)的类,使其 database_query 方法返回预设测试数据,从而实现对 Flask 路由的隔离式单元测试。

本文介绍如何在纯 pytest 环境中,通过 `monkeypatch` 替换依赖上下文管理器(`__enter__`/`__exit__`)的类,使其 `database_query` 方法返回预设测试数据,从而实现对 flask 路由的隔离式单元测试。

在测试涉及上下文管理器(如 with Database() as db:)的代码时,不能仅 mock 单个方法(例如 database_query),因为 Database 实例是在 with 语句块内动态创建并进入上下文的。直接 patch 方法无法生效——db 对象来自真实类实例,其方法调用仍会执行原始逻辑。

正确做法是完全替换 Database 类本身,用一个轻量级的模拟类替代,该类实现必需的上下文管理协议(__enter__ 返回自身,__exit__ 无副作用),并在其中硬编码所需返回值。

以下是完整、可直接复用的测试方案:

花生AI
花生AI

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

下载

✅ 正确做法:用 monkeypatch 替换整个类

import pytest
from app import app
from tests.sample_data.api_responses.get_some_stuff import get_some_stuff_api_response
from tests.sample_data.query_responses.get_some_stuff import get_some_stuff_query_response

# 导入实际被使用的 Database 类路径(注意:必须与应用中 import 路径一致)
import app.utils.Database  # ← 关键:patch 的目标是此模块下的 Database 类


class MockDatabase:
    def __init__(self, *args, **kwargs):
        # 模拟 __init__ 行为(可选:支持传参兼容性)
        pass

    def __enter__(self):
        return self  # 必须返回 self,以支持 `as db`

    def __exit__(self, exc_type, exc_value, traceback):
        # 无需关闭连接,空实现即可
        pass

    def database_query(self, table: str, query: str):
        # 直接返回预设的测试响应数据
        return get_some_stuff_query_response


@pytest.fixture
def client():
    with app.test_client() as client:
        yield client


def test_get_some_stuff(client, monkeypatch):
    # ✅ 关键:patch 模块中被导入的 Database 类(不是原始定义位置!)
    monkeypatch.setattr(app.utils.Database, "Database", MockDatabase)

    response = client.get("/api/this/route")

    assert response.status_code == 200
    assert response.get_json() == get_some_stuff_api_response

⚠️ 注意事项与最佳实践

  • Patch 路径必须精准:monkeypatch.setattr(module, "ClassName", MockClass) 中的 module 是应用代码中实际导入并使用的模块路径(即 app.utils.Database),而非 database.py 的原始定义路径。否则 patch 失效。
  • __enter__ 必须返回 self:这是上下文管理器协议的核心要求,否则 with Database() as db: 会因 db 为 None 或其他对象而报错。
  • 避免 patch 方法级对象:不要尝试 patch("app.utils.Database.Database.database_query") —— 因为 database_query 是在 __enter__ 返回的实例上调用的,而该实例来自真实类,patch 不会生效。
  • 保持测试纯净性:Mock 类应仅实现测试所需最小接口,不引入额外依赖或状态,确保测试快速、稳定、可重复。

? 扩展建议(按需)

若需验证不同查询参数对应不同响应,可在 MockDatabase.database_query 中添加简单路由逻辑:

def database_query(self, table: str, query: str):
    if "users" in table and "active" in query:
        return {"hits": [{"id": 1, "name": "Alice"}]}
    elif "orders" in table:
        return {"total": 42}
    return {"default": True}

通过这种类级别替换策略,你能在零外部依赖(不启动数据库、不调用真实客户端)的前提下,高效、可靠地完成端到端 API 路由测试。

相关文章

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1591

4

python能做什么
python能做什么

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

2023.07.25

3784

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21777

23

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

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

2023.08.04

2687

5

python eval
python eval

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

2023.08.04

2727

5

scratch和python区别
scratch和python区别

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

2023.08.11

1103

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2103

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.2万人学习