Python单元测试中json.dumps()方法的正确模拟策略-Python教程-PHP中文网

Python单元测试中json.dumps()方法的正确模拟策略

DDD

发布： 2025-09-13 10:40:00

原创

536人浏览过

Python单元测试中json.dumps()方法的正确模拟策略

本文探讨了Python单元测试中模拟json.dumps()时遇到的常见TypeError: Object of type MagicMock is not JSON serializable问题。它解释了直接模拟json.dumps()为何会导致失败，并提供了一种正确的解决方案：在被测试模块中，通过模拟整个json模块而非其特定方法来规避此问题，从而实现有效的测试隔离和功能验证。

理解json.dumps()模拟的挑战

在python单元测试中，我们经常需要模拟外部依赖，以确保测试的隔离性和可预测性。json.dumps()是python标准库中一个常用的方法，用于将python对象序列化为json格式的字符串。然而，当尝试直接模拟json.dumps()时，开发者常常会遇到一个令人困惑的typeerror: object of type magicmock is not json serializable错误。

这个错误通常不是因为MagicMock对象本身被错误地传递给json.dumps()进行序列化，而是源于Python unittest.mock库的一个核心原则：你必须在对象被查找（lookup）的地方进行模拟，而不是在它被定义（define）的地方。

当你在测试中使用@mock.patch("json.dumps")时，你尝试替换的是全局json模块中的dumps方法。然而，如果你正在测试的模块（例如my_module.py）是通过import json或from json import dumps语句导入了json模块或其dumps方法，那么my_module内部使用的json对象或dumps函数，在模块加载时就已经获得了对原始json模块或dumps函数的引用。此时，即使你修改了全局json.dumps，my_module仍然在使用它最初导入的那个未被修改的引用。

在这种情况下，如果你的代码期望json.dumps()返回一个字符串，但由于模拟失败，实际调用的仍然是真实的json.dumps()。如果某个环节意外地将一个MagicMock对象作为参数传递给了这个未被模拟的真实json.dumps()，就会触发TypeError，因为真实的json.dumps()无法序列化一个MagicMock对象。

正确的模拟策略：在被测试模块中打补丁

解决这个问题的关键在于遵循“在被查找处打补丁”的原则。这意味着我们不应该直接模拟标准库的全局json.dumps，而是应该模拟被测试模块中导入的json模块。

立即学习“Python免费学习笔记（深入）”；

青柚面试

简单好用的日语面试辅助工具

查看详情

假设我们有一个服务模块my_service.py，其内容如下：

# my_service.py
import json

def process_data(data):
    """
    处理数据并将其序列化为JSON字符串。
    """
    processed_data = {"id": data.get("id", 0) + 1, "value": data.get("value", "default").upper()}
    return json.dumps(processed_data)

def generate_report(report_data):
    """
    生成包含JSON数据的报告。
    """
    return f"Report:\n{json.dumps(report_data, indent=2)}"

登录后复制

为了测试process_data或generate_report函数，我们需要模拟my_service模块内部使用的json.dumps。正确的模拟方式是针对my_service.json进行打补丁，然后配置其dumps方法的行为。

示例代码：

# test_my_service.py
import unittest
from unittest import mock
from my_service import process_data, generate_report

class TestMyService(unittest.TestCase):

    @mock.patch("my_service.json") # 正确的模拟方式：模拟my_service模块中导入的json
    def test_process_data_with_mocked_json_dumps(self, mock_json):
        # 配置mock_json对象的dumps方法
        mock_json.dumps.return_value = '{"mocked_id": 101, "mocked_value": "MOCKED"}'

        # 调用被测试函数
        input_data = {"id": 100, "value": "test"}
        result = process_data(input_data)

        # 验证json.dumps是否被调用以及调用参数
        mock_json.dumps.assert_called_once_with({"id": 101, "value": "TEST"})
        self.assertEqual(result, '{"mocked_id": 101, "mocked_value": "MOCKED"}')

    @mock.patch("my_service.json")
    def test_generate_report_with_mocked_json_dumps(self, mock_json):
        # 配置mock_json对象的dumps方法
        mock_json.dumps.return_value = '{\n  "status": "success",\n  "details": "mocked report"\n}'

        # 调用被测试函数
        report_data = {"status": "success", "details": "original report"}
        result = generate_report(report_data)

        # 验证json.dumps是否被调用以及调用参数
        mock_json.dumps.assert_called_once_with(report_data, indent=2)
        self.assertEqual(result, 'Report:\n{\n  "status": "success",\n  "details": "mocked report"\n}')

    # 错误模拟方式的

登录后复制

以上就是Python单元测试中json.dumps()方法的正确模拟策略的详细内容，更多请关注php中文网其它相关文章！