我可以在包装函数之前修补Python装饰器吗？

Question

我有一个装饰器的功能,我正在尝试借助Python Mock库进行测试.我想使用mock.patch将模拟'旁路'装饰器替换为真正的装饰器,它只调用该函数.我无法弄清楚的是如何在真正的装饰器包装函数之前应用补丁.我已经在补丁目标上尝试了一些不同的变体,并重新排序补丁和导入语句,但没有成功.有任何想法吗？

Answer 1

装饰器在功能定义时应用.对于大多数功能,这是在加载模块时.(每次调用封闭函数时,在其他函数中定义的函数都会应用装饰器.)

所以如果你想修饰装饰器,你需要做的是:

1. 导入包含它的模块
2. 定义模拟装饰器功能
3. 设置例如 module.decorator = mymockdecorator
4. 导入使用装饰器的模块,或在您自己的模块中使用它

如果包含装饰器的模块也包含使用它的函数,那么当你看到它们时它们已经被装饰了,你可能是SOL

编辑以反映Python的变化,因为我最初写这个:如果装饰者使用functools.wraps()并且Python的版本足够新,你可以使用__wrapped__attritube 挖掘原始函数并重新装饰它,但这绝不是保证,你要替换的装饰器也可能不是唯一应用的装饰器.

Answer 2

应该注意的是,这里的几个答案将修补整个测试会话的装饰器而不是单个测试实例; 这可能是不受欢迎的.以下是如何修补仅通过单个测试持续存在的装饰器.

我们的单位要与不受欢迎的装饰师一起测试:

# app/uut.py

from app.decorators import func_decor

@func_decor
def unit_to_be_tested():
    # Do stuff
    pass

来自装饰模块:

# app/decorators.py

def func_decor(func):
    def inner(*args, **kwargs):
        print "Do stuff we don't want in our test"
        return func(*args, **kwargs)
    return inner

当我们的测试在测试运行期间被收集时,不需要的装饰器已经应用于我们的测试单元(因为这在导入时发生).为了摆脱这种情况,我们需要手动替换装饰器模块中的装饰器,然后重新导入包含UUT的模块.

我们的测试模块:

#  test_uut.py

from unittest import TestCase
from app import uut  # Module with our thing to test
from app import decorators  # Module with the decorator we need to replace
import imp  # Library to help us reload our UUT module
from mock import patch


class TestUUT(TestCase):
    def setUp(self):
        # Do cleanup first so it is ready if an exception is raised
        def kill_patches():  # Create a cleanup callback that undoes our patches
            patch.stopall()  # Stops all patches started with start()
            imp.reload(uut)  # Reload our UUT module which restores the original decorator
        self.addCleanup(kill_patches)  # We want to make sure this is run so we do this in addCleanup instead of tearDown

        # Now patch the decorator where the decorator is being imported from
        patch('app.decorators.func_decor', lambda x: x).start()  # The lambda makes our decorator into a pass-thru. Also, don't forget to call start()          
        # HINT: if you're patching a decor with params use something like:
        # lambda *x, **y: lambda f: f
        imp.reload(uut)  # Reloads the uut.py module which applies our patched decorator

清理回调kill_patches恢复原始装饰器并将其重新应用到我们测试的单元.这样,我们的补丁仅通过单个测试而不是整个会话持续存在 - 这正是任何其他补丁应该如何表现的.此外,由于清理调用patch.stopall(),我们可以启动我们需要的setUp()中的任何其他补丁,它们将在一个地方得到清理.

理解这个方法的重要一点是重新加载会如何影响事物.如果模块需要太长时间或者在导入时运行逻辑,那么您可能只需要耸肩并测试装饰器作为单元的一部分.:(希望你的代码写得比那更好.对吧？

如果不关心修补程序是否应用于整个测试会话,最简单的方法就是在测试文件的顶部:

# test_uut.py

from mock import patch
patch('app.decorators.func_decor', lambda x: x).start()  # MUST BE BEFORE THE UUT GETS IMPORTED ANYWHERE!

from app import uut

确保使用装饰器修补文件而不是UUT的本地范围,并在使用装饰器导入单元之前启动修补程序.

有趣的是,即使补丁已停止,已导入的所有文件仍将补丁应用于装饰器,这与我们开始的情况相反.请注意,此方法将修补之后导入的测试运行中的任何其他文件 - 即使它们本身未声明修补程序.

Answer 3

当我第一次遇到这个问题时，我常常花了数小时的时间。我发现了一种更简单的方法来处理此问题。

这将完全绕过装饰器，就像目标一开始就没有装饰。

这分为两部分。我建议阅读以下文章。

http://alexmarandon.com/articles/python_mock_gotchas/

我一直遇到的两个陷阱：

1.）在导入功能/模块之前模拟装饰器。

装饰器和函数是在模块加载时定义的。如果您在导入前不进行模拟，它将忽略该模拟。加载后，您必须执行一个怪异的mock.patch.object，这会更加令人沮丧。

2.）确保您在模拟通往装饰器的正确路径。

请记住，您正在模拟的装饰器的补丁基于模块如何加载装饰器，而不是测试如何加载装饰器。这就是为什么我建议始终使用完整路径进行导入的原因。这使测试变得容易得多。

脚步：

1.）模拟功能：

from functools import wraps

def mock_decorator(*args, **kwargs):
    def decorator(f):
        @wraps(f)
        def decorated_function(*args, **kwargs):
            return f(*args, **kwargs)
        return decorated_function
    return decorator

2.）模拟装饰器：

2a。）里面的路径。

with mock.patch('path.to.my.decorator', mock_decorator):
     from mymodule import myfunction

2b。）在文件顶部或在TestCase.setUp中打补丁

mock.patch('path.to.my.decorator', mock_decorator).start()

这些方式中的任何一种都将允许您随时在TestCase或其方法/测试用例中导入函数。

from mymodule import myfunction

2）使用一个单独的函数作为模拟。补丁的副作用。

现在，您可以对要模拟的每个装饰器使用嘲笑装饰器。您将不得不分别模拟每个装饰器，因此请注意您错过的装饰器。