本教程将探讨在Python单元测试中模拟json.dumps()方法时常见的陷阱及其解决方案。针对直接使用@mock.patch(“json.dumps”)可能导致的TypeError，我们将介绍如何通过模拟目标模块中导入的整个json模块来有效控制其行为，确保测试的准确性和隔离性。
1. 引言：json.dumps()模拟的挑战
在python的单元测试中，我们经常需要模拟（mock）外部依赖，以确保被测代码的隔离性和测试结果的可预测性。json.dumps()是python标准库中用于将python对象序列化为json格式字符串的常用方法。然而，在对其进行模拟时，许多开发者会遇到意想不到的问题，尤其是当尝试直接模拟json.dumps()函数本身时。本教程旨在揭示这些问题的原因，并提供一个健壮且推荐的解决方案。
2. 常见误区：直接模拟json.dumps()
许多开发者在测试中，会自然而然地尝试使用unittest.mock.patch装饰器直接模拟json.dumps()函数，例如：
from unittest import mockimport json# 这是一个常见的尝试，但可能导致问题@mock.patch("json.dumps")def test_serialize_data_incorrect_mock(mock_dumps): # 假设这里是被测代码调用json.dumps() # mock_dumps.return_value = "mocked_json_string" # ... pass
这种直接模拟”json.dumps”的方式，在某些情况下可能会导致TypeError: Object of type MagicMock is not JSON serializable的错误。
为什么会失败？
unittest.mock.patch的核心原则是“patch where it’s looked up”，即在被测代码中查找对象的位置进行模拟。当你的模块（例如my_app.py）通过import json导入json模块并调用json.dumps()时，它实际上是在使用my_app模块内部对json模块的引用。
立即学习“Python免费学习笔记（深入）”；
如果仅仅使用@mock.patch(“json.dumps”)，你可能只是模拟了全局的json.dumps函数，而my_app模块内部持有的json模块引用可能仍然是原始的、未被模拟的。在这种情况下，如果你的被测函数将一个MagicMock对象（例如，一个被模拟的参数）传递给了这个未被模拟的真实json.dumps，那么真实的json.dumps函数就会尝试序列化一个MagicMock对象，从而抛出TypeError。
3. 正确方法：模拟导入的json模块
解决上述问题的关键在于，不要直接模拟json.dumps()函数，而是模拟被测模块中导入的整个json模块对象。这样，当被测模块调用json.dumps()时，它实际上是在调用你提供的MagicMock对象的dumps方法，从而实现完全的控制。
核心思想： 将被测模块中对json模块的引用替换为一个MagicMock实例。
语法： @mock.patch(“.json”)
其中，是指你的代码中导入json模块的完整路径（例如，如果你的函数在my_project.utils模块中，并且该模块导入了json，那么路径就是my_project.utils.json）。
示例代码：
首先，我们定义一个包含json.dumps()调用的被测模块：
# my_app.pyimport jsondef serialize_user_data(user_info: dict) -> str: """ 将用户信息字典序列化为格式化的JSON字符串。 """ if not isinstance(user_info, dict): raise TypeError("User info must be a dictionary.") return json.dumps(user_info, indent=4, sort_keys=True)def process_and_serialize_config(config_data: dict) -> str: """ 处理配置数据并将其序列化。 """ # 假设这里有一些处理逻辑 processed_data = {k.upper(): v for k, v in config_data.items()} return serialize_user_data(processed_data) # 内部调用了json.dumps
接下来，我们编写测试代码，使用正确的方法模拟json模块：
# test_my_app.pyfrom unittest import mockfrom my_app import serialize_user_data, process_and_serialize_configclass TestJsonDumpsMocking(mock.TestCase): @mock.patch("my_app.json") # 模拟my_app模块中导入的json对象 def test_serialize_user_data_mocked(self, mock_json): """ 测试serialize_user_data函数，模拟json.dumps()的行为。 """ # 配置mock_json对象的dumps方法，使其返回预设值 mock_json.dumps.return_value = "mocked_user_json_string" test_data = {"name": "Alice", "age": 30} result = serialize_user_data(test_data) # 验证mock_json.dumps()是否被正确调用，以及调用参数 mock_json.dumps.assert_called_once_with(test_data, indent=4, sort_keys=True) self.assertEqual(result, "mocked_user_json_string") @mock.patch("my_app.json") # 再次模拟my_app模块中导入的json对象 def test_process_and_serialize_config_mocked(self, mock_json): """ 测试process_and_serialize_config函数，确保内部json.dumps()被模拟。 """ mock_json.dumps.return_value = "mocked_config_json_output" initial_config = {"app_name": "My App", "version": "1.0"} expected_processed_data = {"APP_NAME": "My App", "VERSION": "1.0"} result = process_and_serialize_config(initial_config) # 验证内部调用json.dumps()的参数 mock_json.dumps.assert_called_once_with(expected_processed_data, indent=4, sort_keys=True) self.assertEqual(result, "mocked_config_json_output") def test_serialize_user_data_type_error(self): """ 测试serialize_user_data函数在输入类型错误时的行为（不涉及mock）。 """ with self.assertRaises(TypeError): serialize_user_data("not_a_dict")
4. 工作原理详解
当@mock.patch(“my_app.json”)被应用到test_serialize_user_data_mocked函数上时，my_app模块内部对json的引用（即my_app.json）在测试函数执行期间会被替换为一个MagicMock实例。
因此，当serialize_user_data函数（或process_and_serialize_config函数，因为它内部调用了serialize_user_data）调用json.dumps()时，它实际上是在调用这个MagicMock实例的dumps方法。我们通过mock_json.dumps.return_value来指定这个dumps方法应该返回什么值，并通过mock_json.dumps.assert_called_once_with来验证它是否被正确调用以及调用时传递的参数。
这种方法确保了：
隔离性： 你的测试不再依赖于json.dumps()的实际内部实现或其性能。可控性： 你可以精确控制json.dumps()的返回值，以测试不同的场景（例如，成功序列化、特定格式输出等）。避免TypeError： 由于整个json模块都被替换，被测代码不会将MagicMock对象传递给真实的json.dumps，从而避免了TypeError。
5. 注意事项与最佳实践
“Where it’s looked up”原则是关键： 始终记住，mock.patch需要模拟对象在被测代码中被查找的位置。如果json是在my_app.utils中导入的，那么你应该模拟my_app.utils.json，而不是my_app.json。粒度选择： 通常，模拟整个模块（如json）比模拟单个函数（如json.dumps）更健壮，因为它能处理模块中其他可能被调用的函数（例如json.loads），并且避免了复杂的导入问题。清晰的测试意图： 确保你的模拟只影响你想要隔离的部分，并且测试仍然专注于被测单元的逻辑。不要过度模拟，否则可能导致测试变得脆弱且难以理解。使用unittest.mock.patch作为上下文管理器： 除了装饰器形式，patch也可以作为上下文管理器使用，这在需要更精细控制模拟范围时非常有用。
6. 总结
正确模拟json.dumps()对于编写可靠且高效的Python单元测试至关重要。通过理解Python的导入机制和unittest.mock.patch的“查找位置”原则
以上就是Python单元测试中模拟json.dumps()的正确姿势的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1371220.html
微信扫一扫 
支付宝扫一扫 
