在python单元测试中，我们经常需要模拟（mock）外部依赖，以隔离测试目标并控制其行为。`unittest.mock.patch`是实现这一目标的核心工具。然而，当模拟一个类及其方法，并且该方法被配置为抛出异常时，一个常见的困惑是，即使异常被捕获，对该方法调用次数的断言（`call_count`）却显示为零，导致测试失败。本文将详细解析这一现象的根本原因，并提供正确的测试策略。
1. 问题描述：Mocked方法抛出异常时调用计数异常
考虑以下场景：我们有一个UploadService类，其中包含一个upload方法，该方法内部调用了Blob类的一个实例方法upload_from_string。我们希望测试当upload_from_string方法抛出GoogleCloudError时，upload方法如何处理。
原始代码示例 (upload_service.py):
import logging
import json
from unittest.mock import MagicMock # 假设Blob和GoogleCloudError是外部库
# 为了示例运行，这里简单定义一下
class GoogleCloudError(Exception):
pass
class Blob:
def __init__(self, name, bucket):
self.name = name
self.bucket = bucket
def upload_from_string(self, data, content_type):
# 实际操作可能抛出GoogleCloudError
raise GoogleCloudError("Simulated upload error")
class UploadService:
def __init__(self, config):
self.config = config # 示例配置
def upload(self, name, data, gcs_bucket):
try:
gcs_blob = Blob(name, gcs_bucket)
gcs_blob.upload_from_string(data=json.dumps(data), content_type="application/json")
return "Upload successful"
except GoogleCloudError as e:
logging.exception("Error uploading file")
return "Upload failed due to error"错误的测试代码示例 (test_upload_service.py):
import unittest
from unittest.mock import patch, MagicMock
from upload_service import UploadService, Blob, GoogleCloudError # 导入相关类
class TestUploadService(unittest.TestCase):
def test_upload_failure(self):
us = UploadService(config={}) # 实例化服务
with patch("upload_service.Blob") as mocked_blob_class: # 模拟Blob类
# 配置模拟实例的方法，使其抛出异常
gcs_blob_instance = mocked_blob_class.return_value
gcs_blob_instance.upload_from_string.side_effect = GoogleCloudError("Google Cloud error")
# 调用被测试的方法
result = us.upload("test_file", {"key": "value"}, "test_bucket")
# 错误的断言方式：试图在模拟的类对象上检查实例方法的调用计数
self.assertEqual(1, mocked_blob_class.upload_from_string.call_count)
self.assertEqual("Upload failed due to error", result)
运行上述测试，会得到如下失败信息：
立即学习“Python免费学习笔记（深入）”；
AssertionError: 1 != 0 Expected :1 Actual :0
这表明mocked_blob_class.upload_from_string.call_count的值是0，而不是预期的1。
2. 理解unittest.mock.patch对类的模拟
要理解为何会出现上述问题，我们需要明确unittest.mock.patch在模拟类时的行为：
- 当使用@patch('module.ClassName')或with patch('module.ClassName') as MockedClass:时，MockedClass实际上是ClassName这个类本身的模拟对象。
- 当被测试的代码中调用ClassName(...)来实例化一个对象时，MockedClass会被调用，并返回一个新的模拟对象。这个新的模拟对象就是MockedClass.return_value。
- 所有对ClassName实例方法的调用，实际上都是发生在MockedClass.return_value这个模拟实例上的。
因此，在我们的例子中：
- patch("upload_service.Blob") as mocked_blob_class：mocked_blob_class是Blob类的模拟。
- gcs_blob = Blob(name, gcs_bucket)：这行代码会调用mocked_blob_class()，并返回mocked_blob_class.return_value。因此，gcs_blob实际上是mocked_blob_class.return_value。
- gcs_blob.upload_from_string(...)：此方法调用发生在gcs_blob（即mocked_blob_class.return_value）上。
3. 根本原因与正确断言方式
问题在于，我们错误地在mocked_blob_class.upload_from_string上检查了call_count。mocked_blob_class.upload_from_string是Blob类的模拟方法，它只会在直接通过Blob.upload_from_string()（如果这是一个类方法或静态方法）调用时才会被计数。
然而，upload_from_string是一个实例方法，它通过gcs_blob.upload_from_string()被调用，而gcs_blob是mocked_blob_class.return_value。因此，正确的call_count应该在mocked_blob_class.return_value.upload_from_string上进行断言。
正确的测试代码示例 (test_upload_service.py):
import unittest
from unittest.mock import patch, MagicMock
from upload_service import UploadService, Blob, GoogleCloudError # 导入相关类
import logging
# 配置logging，确保异常信息在测试输出中可见
logging.basicConfig(level=logging.INFO)
class TestUploadService(unittest.TestCase):
def test_upload_failure_correct_assertion(self):
us = UploadService(config={})
with patch("upload_service.Blob") as mocked_blob_class:
# 获取模拟的Blob实例
gcs_blob_instance = mocked_blob_class.return_value
# 配置模拟实例的方法，使其抛出异常
gcs_blob_instance.upload_from_string.side_effect = GoogleCloudError("Google Cloud error")
# 调用被测试的方法
result = us.upload("test_file", {"key": "value"}, "test_bucket")
# 正确的断言方式：在模拟的实例对象上检查方法调用计数
self.assertEqual(1, gcs_blob_instance.upload_from_string.call_count)
# 也可以这样写，效果相同：
# self.assertEqual(1, mocked_blob_class().upload_from_string.call_count)
self.assertEqual("Upload failed due to error", result)
# 还可以进一步断言Blob类本身被调用了一次
self.assertEqual(1, mocked_blob_class.call_count)
# 断言Blob类被调用的参数
mocked_blob_class.assert_called_once_with("test_file", "test_bucket")
通过将断言目标从mocked_blob_class.upload_from_string改为gcs_blob_instance.upload_from_string（即mocked_blob_class.return_value.upload_from_string），测试将成功通过。这证明了即使方法抛出异常，unittest.mock也能正确记录其调用计数，关键在于正确地引用被调用的模拟对象。
4. 总结与最佳实践
- 区分类Mock和实例Mock： 当使用patch模拟一个类时，被patch的变量（如mocked_blob_class）是类的Mock。而该类的实例（如gcs_blob）是mocked_blob_class.return_value。
- 断言实例方法调用： 对实例方法的调用（例如gcs_blob.upload_from_string()）应该在模拟的实例对象上进行断言，即mocked_blob_class.return_value.method_name.call_count。
- 断言类实例化： 如果需要断言类的构造函数被调用，则应该在类Mock对象上进行断言，即mocked_blob_class.call_count或mocked_blob_class.assert_called_once_with(...)。
- side_effect与call_count： side_effect机制在模拟方法抛出异常时不会影响call_count的记录。只要方法被调用，无论是否抛出异常，其call_count都会正确递增。
- 明确变量名： 在测试中为模拟的类和模拟的实例使用清晰的变量名（例如mocked_blob_class和gcs_blob_instance），有助于避免混淆和定位问题。
遵循这些原则，可以确保在Python单元测试中对unittest.mock的正确使用，尤其是在处理方法抛出异常的复杂场景时，能够准确无误地验证代码行为。
