0

0

Python单元测试:正确模拟json模块以避免TypeError

霞舞

霞舞

发布时间:2025-09-13 11:26:01

|

481人浏览过

|

来源于php中文网

原创

python单元测试:正确模拟json模块以避免typeerror

本文深入探讨了在Python单元测试中模拟json.dumps()时可能遇到的TypeError: Object of type MagicMock is not JSON serializable问题。核心解决方案在于理解Python的导入机制和unittest.mock的工作原理,即应模拟被测试模块中导入并使用的json模块引用,而非全局的json.dumps()函数,从而有效控制json序列化行为,确保测试的隔离性和正确性。

在Python单元测试中,我们经常需要模拟外部依赖,例如网络请求、数据库操作或文件系统交互。unittest.mock库是Python标准库中用于实现这一目标强大工具。然而,当尝试模拟像json.dumps()这样的标准库函数时,开发者有时会遇到意料之外的问题,特别是TypeError: Object of type MagicMock is not JSON serializable。本文将详细解释这一问题的原因,并提供一个稳健的解决方案。

问题根源:Python的导入机制与mock.patch

当一个模块(例如my_module.py)导入另一个模块(例如json)时,它会在自己的命名空间中创建一个对该模块的引用。例如:

# my_module.py
import json

def serialize_data(data):
    return json.dumps(data)

在这个例子中,my_module内部使用的json对象是my_module命名空间中的一个引用。如果我们尝试使用@mock.patch("json.dumps")来模拟json.dumps(),我们实际上是在修改全局json模块中的dumps函数。这通常不会影响到my_module中已经导入并使用的json模块引用,因为my_module在导入时已经将json模块加载到了自己的命名空间,并且后续对json.dumps的调用会通过my_module自己的json引用进行。因此,my_module仍然会调用原始的json.dumps(),导致模拟失败。

至于TypeError: Object of type MagicMock is not JSON serializable,这通常是由于以下情况之一造成的:

立即学习Python免费学习笔记(深入)”;

  1. 错误的模拟目标: mock.patch("json.dumps")未能成功替换my_module中使用的json.dumps。因此,my_module中的代码仍然调用原始的json.dumps。如果测试代码随后将一个MagicMock对象作为数据传给了这个未被模拟的json.dumps(例如,某个依赖于json.dumps的函数返回了一个MagicMock对象,然后这个MagicMock对象又被传给了另一个json.dumps),就会触发此TypeError。
  2. 模拟配置不当: 即使json.dumps被成功模拟,如果MagicMock对象没有被正确配置以返回一个字符串(json.dumps的预期输出),并且其返回值被后续代码尝试再次序列化,也可能导致此错误。

核心问题在于,mock.patch需要知道“在哪里查找”被模拟的对象。对于一个模块内部使用的导入对象,正确的模拟目标应该是"."。

Viggle AI
Viggle AI

Viggle AI是一个AI驱动的3D动画生成平台,可以帮助用户创建可控角色的3D动画视频。

下载

正确的模拟策略:模拟模块引用

要正确模拟my_module中使用的json模块,我们应该模拟my_module命名空间中的json引用,而不是全局的json模块或其dumps函数。这意味着正确的模拟路径应该是"my_module.json"。通过这种方式,当my_module尝试访问json模块时,它会得到一个MagicMock对象,我们可以配置这个MagicMock对象来控制json.dumps等方法的行为。

示例代码

为了更好地理解,我们通过一个具体的例子来演示。

my_module.py (被测试的模块):

# my_module.py
import json

def serialize_user_profile(user_data: dict) -> str:
    """
    序列化用户数据为JSON字符串,并添加一些处理信息。
    """
    processed_data = {
        "user_id": user_data.get("id"),
        "username": user_data.get("name"),
        "status": "processed",
        "original_input_keys": list(user_data.keys())
    }
    # my_module 内部调用 json.dumps
    return json.dumps(processed_data, indent=2, ensure_ascii=False)

def get_user_data_as_json(user_id: str) -> str:
    """
    模拟从数据库获取用户数据并序列化。
    (这里简化为直接构造数据)
    """
    user_info = {"id": user_id, "name": f"User_{user_id}", "email": f"user{user_id}@example.com"}
    return serialize_user_profile(user_info)

test_my_module.py (单元测试):

# test_my_module.py
import unittest
from unittest import mock
import json # 引入 json 模块仅用于演示,不用于模拟

# 导入被测试的模块
import my_module

class TestMyModuleSerialization(unittest.TestCase):

    def test_serialize_user_profile_without_mock(self):
        """
        测试不使用mock时 serialize_user_profile 的正常行为。
        """
        user_data = {"id": "123", "name": "张三", "age": 30}
        expected_output = '{\n  "user_id": "123",\n  "username": "张三",\n  "status": "processed",\n  "original_input_keys": [\n    "id",\n    "name",\n    "age"\n  ]\n}'
        self.assertEqual(my_module.serialize_user_profile(user_data), expected_output)

    @mock.patch("json.dumps")
    def test_get_user_data_as_json_incorrect_patch(self, mock_global_dumps):
        """
        尝试模拟全局的 json.dumps,但对 my_module 无效。
        """
        mock_global_dumps.return_value = "MOCKED GLOBAL DUMPS OUTPUT"
        test_user_id = "456"

        # 此时 my_module.json.dumps 仍然是原始的 json.dumps
        # 因为 my_module 拥有自己的 json 模块引用
        result = my_module.get_user_data_as_json(test_user_id)

        # 验证原始函数被调用,而不是mock
        mock_global_dumps.assert_not_called()
        self.assertNotEqual(result, "MOCKED GLOBAL DUMPS OUTPUT")

        # 实际结果会是原始 json.dumps 的输出,包含处理后的数据
        self.assertIn("processed", result) 
        self.assertIn(f"User_{test_user_id}", result)

        # 注意:在此场景下,通常不会直接出现 TypeError: Object of type MagicMock is not JSON serializable,
        # 因为原始的 json.dumps 正常运行。但如果后续代码期望 mock 的返回值,
        # 而此处得到的是原始 json.dumps 的结果,可能导致其他逻辑错误,
        # 甚至在更复杂的交互中间接触发 TypeError。
        # 关键在于,这种方式未能成功模拟 my_module 内部的 json 行为。

    @mock.patch("my_module.json")
    def test_get_

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

769

2023.06.15

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

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

661

2023.07.20

python能做什么
python能做什么

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

764

2023.07.25

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

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

639

2023.07.31

python教程
python教程

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

1325

2023.08.03

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

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

549

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

709

2023.08.11

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 10.6万人学习

Django 教程
Django 教程

共28课时 | 3.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号