Skip to main content
 首页 » 编程设计

python之覆盖 python 模块中的 "private"方法

2024年10月25日17cloudgamer

我想在 python 中测试一个函数,但它依赖于模块级“私有(private)”函数,我不想调用它,但我无法覆盖/模拟它。场景:

模块.py

_cmd(command, args): 
  # do something nasty 
 
function_to_be_tested(): 
  # do cool things 
  _cmd('rm', '-rf /') 
  return 1 

测试模块.py

import module 
test_function(): 
  assert module.function_to_be_tested() == 1 

理想情况下,在此测试中我不想调用 _cmd。我看过其他一些线程,但没有成功地尝试了以下方法:

 test_function(): 
   def _cmd(command, args): 
     # do nothing 
     pass 
   module._cmd = _cmd 

尽管根据 _cmd 检查 module._cmd 没有给出正确的引用。使用模拟:

from mock import patch 
 
def _cmd_mock(command, args): 
  # do nothing 
  pass 
 
@patch('module._cmd', _cmd_mock)  
test_function(): 
   ... 

在检查 module._cmd 时给出了正确的引用,尽管 `function_to_be_tested' 仍然使用原始的 _cmd(正如它所做的令人讨厌的事情所证明的那样)。

这很棘手,因为 _cmd 是模块级函数,我不想将它移到模块中

请您参考如下方法:

[免责声明]

此问题中发布的综合示例有效,所描述的问题来自生产代码中的特定实现。也许这个问题应该作为题外话结束,因为这个问题是不可重现的。


[注意]对于没有耐心的人解决方案在答案的最后。


无论如何,这个问题给了我一个很好的思考点:当我们无法访问引用所在的变量时,我们如何修补方法引用?

很多时候我发现了这样的问题。有很多方法可以满足这种情况,常见的是

  • 装饰器:我们想要替换的实例作为装饰器参数传递或用于装饰器静态实现
  • 我们想要修补的是一个方法的默认参数

在这两种情况下,重构代码也许是最好的解决方法,但是如果我们正在使用一些遗留代码或者装饰器是第三方装饰器呢?

好的,我们已经知道了,但我们使用的是 python,在 python 中没有什么是不可能的。我们需要的只是要修补的函数/方法的引用,而不是修补它的引用,我们可以修补 __code__:是的,我说的是修补字节码而不是函数。

举个真实的例子。我使用的是简单的默认参数大小写,但它可以在装饰器大小写中使用。

def cmd(a): 
    print("ORIG {}".format(a)) 
def cmd_fake(a): 
    print("NEW {}".format(a)) 
def do_work(a, c=cmd): 
    c(a) 
 
do_work("a") 
cmd=cmd_fake 
do_work("b") 

输出:

ORIG a 
ORIG b 

好的,在这种情况下,我们可以通过传递 cmd_fake 来测试 do_work,但在某些情况下是不可能的:例如,如果我们需要调用类似的东西怎么办:

def what_the_hell(): 
    list(map(lambda a:do_work(a), ["c","d"])) 

我们可以做的是修补 cmd.__code__ 而不是 _cmd

cmd.__code__ = cmd_fake.__code__ 

所以按照代码

do_work("a") 
what_the_hell() 
cmd.__code__ = cmd_fake.__code__ 
do_work("b") 
what_the_hell() 

给出以下输出:

ORIG a 
ORIG c 
ORIG d 
NEW b 
NEW c 
NEW d 

此外,如果我们想使用模拟,我们可以通过添加以下行来实现:

from unittest.mock import Mock, call 
cmd_mock = Mock() 
def cmd_mocker(a): 
    cmd_mock(a) 
 
cmd.__code__=cmd_mocker.__code__ 
what_the_hell() 
cmd_mock.assert_has_calls([call("c"),call("d")]) 
print("WORKS") 

打印出来

WORKS 

也许我已经完成了...但 OP 仍在等待他的问题的解决方案

from mock import patch, Mock 
 
cmd_mock = Mock() 
#A closure for grabbing the right function code 
def cmd_mocker(a): 
    cmd_mock(a) 
 
@patch.object(module._cmd,'__code__', new=cmd_mocker.__code__)  
test_function(): 
   ... 

现在我应该说永远不要使用这个技巧,除非你背靠墙。测试应该易于理解和调试......尝试调试这样的东西,你会发疯的!