如何使用模拟修补模块的内部函数？

Question

我所说的“内部函数”是指从定义它的同一模块内调用的函数。

我正在使用 在我的单元测试中，mock 库，特别是 patch 装饰器。它们是 Django 单元测试，但这应该适用于任何 python 测试。

我有一个具有多个函数的模块，其中许多函数相互调用。例如（虚构代码，忽略缺少decimal.Decimal）：

TAX_LOCATION = 'StateName, United States'

def add_tax(price, user):
    tax = 0
    if TAX_LOCATION == 'StateName, UnitedStates':
        tax = price * .75
    return (tax, price+tax)

def build_cart(...):
    # build a cart object for `user`
    tax, price = add_tax(cart.total, cart.user)
    return cart

这些是更深层次调用链的一部分（func1 -> func2 -> build_cart -> add_tax），所有这些都在同一个模块中。

在我的单元测试中，我想禁用税收以获得一致的结果。在我看来，我的两个选择是：1）修补TAX_LOCATION（例如，使用空字符串），以便add_tax实际上不执行任何操作，或者2）修补add_tax以简单地返回（0，价格）。

然而，当我尝试修补其中任何一个时，修补程序似乎在外部工作（我可以在测试中导入修补部分并将其打印出来，获得预期值），但似乎在内部没有效果（我从代码的行为就像未应用补丁一样）。

我的测试是这样的（再次是虚构的代码）：

from mock import patch
from django.test import TestCase

class MyTests(TestCase):

    @patch('mymodule.TAX_LOCATION', '')
    def test_tax_location(self):
        import mymodule
        print mymodule.TAX_LOCATION # ''
        mymodule.func1()
        self.assertEqual(cart.total, original_price) # fails, tax applied

    @patch('mymodule.add_tax', lambda p, u: (0, p))
    def test_tax_location(self):
        import mymodule
        print mymodule.add_tax(50, None) # (0, 50)
        mymodule.func1()
        self.assertEqual(cart.total, original_price) # fails, tax applied

有谁知道模拟是否可以修补像这样内部使用的函数，还是我运气不好？

Answer 1

答案：清理你该死的导入

@patch('mymodule.TAX_LOCATION', '') 确实适当地修补了东西，但因为我们当时的导入非常随意-- 有时我们导入 mymodule.build_cart，有时我们导入 project.mymodule.build_cart -- “完整”导入的实例根本没有修补。无论如何，在没有明确告知的情况下，不能期望 Mock 了解两个单独的导入路径。

从那时起，我们已经在更长的路径上标准化了所有导入，现在事情表现得好多了。

Answer 2

另一种选择是在函数上显式调用 patch：

mock.patch('function_name')

并支持直接运行或从 py.test 等运行：

mock.patch(__name__ + '.' + 'function_name')

Answer 3

我想添加除已接受的解决方案之外的解决方案。您还可以在将模块导入任何其他模块之前对其进行修补，并在测试用例末尾删除修补程序。

#import some modules that don't use module you are going to patch
import unittest
from mock import patch
import json
import logging
...


patcher = patch('some.module.path.function', lambda x: x)
patcher.start()

import some.module.path

class ViewGetTests(unittest.TestCase):

  @classmethod
  def tearDownClass(cls):
      patcher.stop()

Answer 4

我很确定你的问题是你在测试函数中导入“mymodule”，因此补丁装饰器没有机会实际修补。像任何其他导入一样，在模块顶部进行导入。

Answer 5

如果您的模块位于包含 __init__.py 文件的文件夹中，并且该文件具有 from [module_file] import * ，请确保您的补丁参数具有文件夹和文件名 (module_folder.module_file ），或者补丁会成功（没有“模块没有此属性”错误），但函数不会成功（调用将转到实际函数而不是模拟），无论测试中的函数如何导入。