Python Mock 仅在特定导入方式下生效的原因解析

本文旨在解释 Python 单元测试中，Mock 对象仅在特定模块导入方式下才能生效的现象。通过分析 from utils import get_id 和 from . import utils 两种导入方式的差异，深入剖析 Python 的模块导入机制，并提供正确的 Mock 使用方法，帮助开发者避免类似问题。

问题背景

在 Python 单元测试中，我们经常需要 Mock 掉一些外部依赖，以隔离测试目标代码。然而，有时我们会发现 Mock 对象并没有生效，仍然执行了原始代码。本文将通过一个具体的例子，分析这种现象的原因，并提供解决方案。

示例代码

假设我们有以下三个文件：

• utils.py:

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

  # utils.py
  def get_id():
      # 实际实现可能涉及复杂的逻辑
      return "original_id"

  登录后复制

• car.py:

  # car.py
  from utils import get_id
  
  class Car:
      def __init__(self):
          self.id = None
  
      def setup(self):
          self.id = get_id()

  登录后复制

• test_car.py:

  # test_car.py
  import unittest
  from unittest.mock import Mock
  import utils
  from car import Car
  import car as module_car
  
  class TestCar(unittest.TestCase):
      def test_car_setup(self):
          # 错误的 Mock 方式
          # utils.get_id = Mock(return_value="my-testing-id")
  
          # 正确的 Mock 方式
          module_car.get_id = Mock(return_value="my-testing-id")
  
          car = Car()
          car.setup()
          self.assertEqual(car.id, "my-testing-id")
  
  if __name__ == '__main__':
      unittest.main()

  登录后复制

问题分析

上述代码中，我们希望在 test_car.py 中 Mock 掉 utils.get_id 函数，使其返回一个特定的测试 ID。然而，如果使用 utils.get_id = Mock(...) 这种方式，Mock 并不会生效。这是因为 car.py 中使用了 from utils import get_id 这种导入方式。

from utils import get_id 语句会在 car.py 模块的命名空间中创建一个名为 get_id 的变量，该变量指向 utils.py 模块中的 get_id 函数。因此，即使我们在 test_car.py 中修改了 utils.get_id，car.py 中使用的 get_id 仍然指向原始的函数。

因赛AIGC

因赛AIGC解决营销全链路应用场景

73

查看详情

要解决这个问题，我们需要修改 test_car.py 中的 Mock 方式，或者修改 car.py 中的导入方式。

解决方案

方案一：Mock car.py 模块中的 get_id

我们可以通过导入 car 模块，并 Mock 该模块中的 get_id 变量来实现。

# test_car.py
import unittest
from unittest.mock import Mock
from car import Car
import car as module_car

class TestCar(unittest.TestCase):
    def test_car_setup(self):
        module_car.get_id = Mock(return_value="my-testing-id")
        car = Car()
        car.setup()
        self.assertEqual(car.id, "my-testing-id")

在这个方案中，我们使用 import car as module_car 导入 car 模块，并使用 module_car.get_id = Mock(...) 来 Mock car.py 模块中的 get_id 变量。这样，当 car.py 中的 setup 函数调用 get_id() 时，实际上调用的是我们 Mock 的函数。

方案二：修改 car.py 中的导入方式

我们可以将 car.py 中的导入方式改为 from . import utils，然后使用 utils.get_id() 来调用 get_id 函数。

# car.py
from . import utils

class Car:
    def __init__(self):
        self.id = None

    def setup(self):
        self.id = utils.get_id()

在这种情况下，car.py 中使用的 utils.get_id() 实际上指向的是 test_car.py 中 Mock 的 utils.get_id。

# test_car.py
import unittest
from unittest.mock import Mock
import utils
from car import Car

class TestCar(unittest.TestCase):
    def test_car_setup(self):
        utils.get_id = Mock(return_value="my-testing-id")
        car = Car()
        car.setup()
        self.assertEqual(car.id, "my-testing-id")

总结

在 Python 单元测试中，Mock 的生效与模块的导入方式密切相关。

• 当使用 from utils import get_id 导入函数时，Mock utils.get_id 并不会影响 car.py 中 get_id 的行为。
• 要解决这个问题，可以 Mock car.py 模块中的 get_id，或者修改 car.py 中的导入方式为 from . import utils。

理解 Python 的模块导入机制，可以帮助我们更好地使用 Mock 对象，编写更可靠的单元测试。在实际开发中，建议根据具体情况选择合适的 Mock 方案。

以上就是Python Mock 仅在特定导入方式下生效的原因解析的详细内容，更多请关注php中文网其它相关文章！