什么是猴子补丁?

时间:2011-04-11 19:05:42

标签: python terminology monkeypatching

我想了解什么是猴子补丁或猴子补丁?

这类似于方法/运算符重载或委托吗?

这些东西有什么共同之处吗?

8 个答案:

答案 0 :(得分:443)

不,它不像那些东西。它只是在运行时动态替换属性。

例如,考虑一个具有方法get_data的类。此方法执行外部查找(例如,在数据库或Web API上),并且类中的各种其他方法调用它。但是,在单元测试中,您不希望依赖外部数据源 - 因此您可以使用返回某些固定数据的存根动态替换get_data方法。

因为Python类是可变的,并且方法只是类的属性,所以你可以随意做到这一点 - 事实上,你甚至可以用完全相同的方式替换模块中的类和函数。 / p>

但是,正如commenter指出的那样,在monkeypatching时要小心:

  1. 除了你的测试逻辑之外的任何其他东西也会调用get_data,它也会调用你的猴子补丁而不是原来的 - 这可能是好的也可能是坏的。请注意。

  2. 如果某个变量或属性在您替换它时也指向get_data函数,则此别名不会更改其含义并将继续指向原始get_data 。 (为什么?Python只是将类中的名称get_data重新绑定到其他函数对象;其他名称绑定根本不受影响。)

答案 1 :(得分:335)

  

MonkeyPatch是一段扩展或修改的Python代码   运行时的其他代码(通常在启动时)。

一个简单的例子如下:

from SomeOtherProduct.SomeModule import SomeClass

def speak(self):
    return "ook ook eee eee eee!"

SomeClass.speak = speak
Zope wiki上的

来源: MonkeyPatch页面。

答案 2 :(得分:101)

  

什么是猴子补丁?

简单地说,猴子补丁正在程序运行时对模块或类进行更改。

使用示例

在Pandas文档中有一个猴子修补的例子:

import pandas as pd
def just_foo_cols(self):
    """Get a list of column names containing the string 'foo'

    """
    return [x for x in self.columns if 'foo' in x]

pd.DataFrame.just_foo_cols = just_foo_cols # monkey-patch the DataFrame class
df = pd.DataFrame([list(range(4))], columns=["A","foo","foozball","bar"])
df.just_foo_cols()
del pd.DataFrame.just_foo_cols # you can also remove the new method

为了解决这个问题,首先我们导入我们的模块:

import pandas as pd

接下来,我们创建一个方法定义,它在任何类定义的范围之外都是未绑定和空闲的(因为在函数和未绑定方法之间区别是没有意义的,Python 3取消了未绑定方法):

def just_foo_cols(self):
    """Get a list of column names containing the string 'foo'

    """
    return [x for x in self.columns if 'foo' in x]

接下来,我们只是将该方法附加到我们想要使用它的类上:

pd.DataFrame.just_foo_cols = just_foo_cols # monkey-patch the DataFrame class

然后我们可以在类的实例上使用该方法,并在完成后删除该方法:

df = pd.DataFrame([list(range(4))], columns=["A","foo","foozball","bar"])
df.just_foo_cols()
del pd.DataFrame.just_foo_cols # you can also remove the new method

警告名称错误

如果您正在使用名称修改(前缀属性带有双下划线,这会改变名称,我建议不要这样做),如果您这样做,则必须手动命名。由于我不建议使用名称修改,因此我不会在此处进行演示。

测试示例

我们如何使用这些知识,例如,在测试中?

假设我们需要模拟对导致错误的外部数据源的数据检索调用,因为我们希望在这种情况下确保正确的行为。我们可以修补数据结构以确保这种行为。 (所以使用Daniel Roseman建议的类似方法名称:)

import datasource

def get_data(self):
    '''monkey patch datasource.Structure with this to simulate error'''
    raise datasource.DataRetrievalError

datasource.Structure.get_data = get_data

当我们测试它依赖于此方法引发错误的行为时,如果正确实现,我们将在测试结果中获得该行为。

执行上述操作会在整个过程中改变Structure对象,因此您需要在单元测试中使用设置和拆卸以避免这样做,例如:

def setUp(self):
    # retain a pointer to the actual real method:
    self.real_get_data = datasource.Structure.get_data
    # monkey patch it:
    datasource.Structure.get_data = get_data

def tearDown(self):
    # give the real method back to the Structure object:
    datasource.Structure.get_data = self.real_get_data

(虽然以上情况很好,但使用mock库修补代码可能更好。mock的{​​{1}}装饰器不会比错误更容易出错。执行上述操作,这将需要更多代码行,从而有更多机会引入错误。我还没有审查patch中的代码,但我想它以类似的方式使用猴子修补。)

答案 3 :(得分:24)

根据Wikipedia

  

在Python中,只有猴子补丁这个词   是指a的动态修改   在运行时的类或模块,有动力   意图修补现有的   第三方代码作为一种解决方法   不起作用的bug或功能   你渴望。

答案 4 :(得分:17)

首先:猴子修补是一个邪恶的黑客(在我看来)。

它通常用于使用自定义实现替换模块或类级别的方法。

最常见的用例是在无法替换原始代码时为模块或类中的错误添加解决方法。在这种情况下,您可以通过使用自己的模块/包中的实现进行猴子修补来替换“错误”代码。

答案 5 :(得分:11)

猴子修补只能在动态语言中完成,其中python就是一个很好的例子。在运行时更改方法而不是更新对象定义是一个示例;类似地,在运行时添加属性(无论是方法还是变量)都被视为猴子修补。这些通常在使用没有源代码的模块时完成,因此无法轻易更改对象定义。

这被认为是错误的,因为它意味着对象的定义不能完全或准确地描述它的实际行为。

答案 6 :(得分:4)

Monkey补丁是在运行时重新打开类中现有的类或方法并改变行为,应谨慎使用,或者只在真正需要时才使用它。

由于Python是一种动态编程语言,因此类是可变的,因此您可以重新打开它们并修改甚至替换它们。

答案 7 :(得分:0)

  

什么是猴子补丁?猴子补丁是一种用于在运行时动态更新代码段行为的技术。

     

为什么使用猴子补丁?它使我们能够在运行时修改或扩展库,模块,类或方法的行为,而无需   实际修改源代码

     

结论猴子修补是一项很酷的技术,现在我们已经学习了如何在Python中进行修补。但是,正如我们所讨论的,它具有   自身的缺点,应谨慎使用。

有关更多信息,请参考[1]:https://medium.com/@nagillavenkatesh1234/monkey-patching-in-python-explained-with-examples-25eed0aea505