Flask 单元测试中正确模拟 request.get_json 的最佳实践

酷强大大_7821

酷强大大_7821

2026-03-28

632人浏览

原创

Flask 单元测试中正确模拟 request.get_json 的最佳实践

在 Flask 单元测试中,直接 patch request.get_json 会触发“Working outside of request context”错误;应使用 app.test_request_context() 构建真实请求上下文,而非强行 mock 全局 request 对象。

在 flask 单元测试中,直接 patch `request.get_json` 会触发“working outside of request context”错误;应使用 `app.test_request_context()` 构建真实请求上下文,而非强行 mock 全局 request 对象。

Flask 的 request 是一个上下文局部对象(LocalProxy),其底层依赖于当前活动的请求上下文(Request Context)。当在测试中未激活上下文时,任何对 request.get_json() 的调用(包括被 patch 后的访问)都会因无法解析 local.get() 而抛出 RuntimeError。因此,问题根源不在于“如何 mock”,而在于“如何提供合法的请求环境”。

✅ 正确做法是使用 Flask 内置的 app.test_request_context() —— 它能安全、轻量地构造一个模拟 HTTP 请求的上下文,完全兼容 request 对象的所有行为,无需 patch,也无需启动服务器。

以下为推荐的测试写法(以 pytest 或 unittest 兼容风格为例):

import pytest
from your_app import app  # 替换为你的 Flask 应用实例
from errors import NoPostArguments

def test_get_post_args_returns_dict():
    """测试正常 JSON 请求返回字典"""
    with app.test_request_context(method='POST', json={"user_id": 123, "action": "create"}):
        result = get_post_args()
        assert isinstance(result, dict)
        assert result["user_id"] == 123

def test_get_post_args_raises_on_non_dict_json():
    """测试非字典类型 JSON(如列表)触发 NoPostArguments"""
    with app.test_request_context(method='POST', json=["invalid", "payload"]), \
         pytest.raises(NoPostArguments):
        get_post_args()

def test_get_post_args_handles_empty_payload():
    """测试空 JSON payload(如 null 或缺失 body)——此时 get_json() 返回 None"""
    with app.test_request_context(method='POST', json=None):
        # 注意:get_json() 默认对空体/无效 JSON 返回 None,但不会自动 raise
        # 所以你的 get_post_args() 中的 isinstance(args, dict) 检查会生效
        with pytest.raises(NoPostArguments):
            get_post_args()

⚠️ 注意事项:

  • json= 参数会自动设置 Content-Type: application/json 并序列化数据为请求体,等价于发送 {"key": "value"};
  • 若需测试原始空 body(如 curl -X POST http://... 无 -d),可显式传 data=b'' 和 content_type="application/json",此时 request.get_json() 默认返回 None(除非设置 force=True);
  • 避免 patch flask.request 或其方法:这不仅易失败,还会掩盖上下文缺失的根本问题,且与 Flask 测试规范相悖;
  • 在 unittest.TestCase 子类中,可直接用 self.assertRaises();在 pytest 中推荐 pytest.raises(),语义更清晰。

? 总结:Flask 测试的核心原则是「模拟请求,而非 mock 请求对象」。test_request_context() 是官方推荐、稳定可靠、零副作用的解决方案。它让测试既符合框架设计哲学,又具备高可读性与可维护性。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1911

4

python能做什么
python能做什么

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

2023.07.25

5324

7

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

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

2023.07.31

1849

3

python教程
python教程

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

2023.08.03

32297

23

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

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

2023.08.04

3807

5

python eval
python eval

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

2023.08.04

3827

5

scratch和python区别
scratch和python区别

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

2023.08.11

1263

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2963

5

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134.3万人学习