在python单元测试中使用`unittest.mock`模拟方法抛出异常时，可能会遇到方法调用计数（`call_count`）为零的现象。本文深入分析了这一常见问题，指出其根源在于对模拟类对象而非其实例进行调用计数断言，并提供了正确的断言方式，确保在异常场景下也能准确验证方法调用。
在进行单元测试时，我们经常需要模拟（mock）依赖项的行为，包括模拟方法抛出异常以测试错误处理逻辑。然而，一个常见的误区是，在模拟一个类及其方法，并让实例方法抛出异常时，对模拟类的call_count进行断言可能会得到0，即使该方法确实被调用了。这通常发生在对模拟类本身进行断言，而不是对其返回的实例进行断言时。
问题场景描述
考虑一个服务类UploadService，其中包含一个upload方法，该方法内部调用Blob类的实例方法upload_from_string。我们希望测试当upload_from_string方法抛出异常时，UploadService的错误处理逻辑是否正确执行。
示例代码：
upload_service.py
立即学习“Python免费学习笔记（深入）”；
import json
import logging
# 假设 GoogleCloudError 和 Blob 类定义在其他地方或通过外部库引入
# 这里为了演示，我们简化它们
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):
"""模拟上传文件到云存储"""
if "error" in data: # 模拟特定条件抛出异常
raise GoogleCloudError("Simulated upload error")
print(f"Uploading {len(data)} bytes to {self.bucket}/{self.name}")
return True
class UploadService:
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 f"Upload failed: {e}"
现在，我们编写一个单元测试来模拟upload_from_string抛出GoogleCloudError异常，并断言该方法被调用了一次。
test_upload_service.py
import unittest
from unittest.mock import patch, MagicMock
from upload_service import UploadService, GoogleCloudError, Blob # 导入相关类
import json
class TestUploadService(unittest.TestCase):
def test_upload_failure(self):
us = UploadService()
test_data = {"key": "value"}
test_name = "test_file"
test_bucket = "test_bucket"
with patch("upload_service.Blob") as mocked_blob_class:
# 配置模拟的 Blob 实例，使其 upload_from_string 方法抛出异常
gcs_blob_instance = mocked_blob_class.return_value
gcs_blob_instance.upload_from_string.side_effect = GoogleCloudError("Google Cloud error")
result = us.upload(test_name, test_data, test_bucket)
# 期望的结果：upload_from_string 被调用了一次
# 错误的断言方式：对模拟类对象进行断言
self.assertEqual(1, mocked_blob_class.upload_from_string.call_count) # 错误！
# 验证错误处理逻辑
self.assertIn("Upload failed", result)
self.assertIn("Google Cloud error", result)
运行上述测试，我们会发现self.assertEqual(1, mocked_blob_class.upload_from_string.call_count)这一行会失败，提示0 != 1。
根本原因分析
这个问题的核心在于对unittest.mock的工作原理理解不透彻。当我们使用patch("upload_service.Blob")时，mocked_blob_class实际上是对upload_service模块中Blob类的模拟。
在UploadService的upload方法中，实际的调用序列是：
- gcs_blob = Blob(name, gcs_bucket)：这里调用了被模拟的Blob类（即mocked_blob_class），它会返回一个模拟的Blob实例。这个实例就是mocked_blob_class.return_value。
- gcs_blob.upload_from_string(...)：这里调用的是实例gcs_blob上的upload_from_string方法。
因此，upload_from_string方法是在mocked_blob_class.return_value（也就是gcs_blob_instance）上被调用的，而不是在mocked_blob_class本身上。所以，对mocked_blob_class.upload_from_string.call_count进行断言，其值自然是0，因为这个方法从未在mocked_blob_class这个类对象上直接被调用。
解决方案
要正确地断言upload_from_string方法的调用次数，我们应该对模拟实例上的upload_from_string方法进行断言。
根据测试代码中的赋值：gcs_blob_instance = mocked_blob_class.return_value，我们可以直接使用gcs_blob_instance。
修正后的测试代码：
import unittest
from unittest.mock import patch, MagicMock
from upload_service import UploadService, GoogleCloudError, Blob
import json
class TestUploadService(unittest.TestCase):
def test_upload_failure_fixed(self): # 修改方法名以示区分
us = UploadService()
test_data = {"key": "value"}
test_name = "test_file"
test_bucket = "test_bucket"
with patch("upload_service.Blob") as mocked_blob_class:
# 配置模拟的 Blob 实例，使其 upload_from_string 方法抛出异常
gcs_blob_instance = mocked_blob_class.return_value
gcs_blob_instance.upload_from_string.side_effect = GoogleCloudError("Google Cloud error")
result = us.upload(test_name, test_data, test_bucket)
# 正确的断言方式：对模拟实例的 upload_from_string 方法进行断言
self.assertEqual(1, gcs_blob_instance.upload_from_string.call_count) # 正确！
# 验证错误处理逻辑
self.assertIn("Upload failed", result)
self.assertIn("Google Cloud error", result)
运行修正后的测试，它将成功通过。
关键点与最佳实践
- 理解mock.return_value： 当你patch一个类时，例如patch("module.ClassName")，mocked_class是这个类的模拟对象。当代码中调用ClassName()（即实例化类）时，mocked_class会被调用，并返回mocked_class.return_value。这个return_value才是模拟的类实例。
- 区分类方法与实例方法： 如果你模拟的是一个类，并且要测试的是该类实例的方法调用，那么你需要断言的是mocked_class.return_value.method_name.call_count，而不是mocked_class.method_name.call_count。
- 明确变量指代： 在测试中，将mocked_class.return_value赋值给一个有意义的变量（如gcs_blob_instance），可以提高代码的可读性，并避免混淆。
- 异常不影响call_count： 无论方法是否成功执行或抛出异常，只要方法被调用，call_count都会递增。本问题并非异常导致call_count为0，而是断言对象选择错误。
总结
在Python单元测试中使用unittest.mock时，正确理解被模拟对象是类还是其实例，以及方法调用实际发生在哪个对象上，是编写健壮测试的关键。当模拟一个类并配置其实例方法抛出异常时，务必对模拟实例（即mocked_class.return_value）上的方法调用进行计数断言，而非直接对模拟类对象进行断言。遵循这一原则，可以有效避免因混淆类与实例而导致的测试失败，确保单元测试的准确性和可靠性。
