我试图理解,什么是猴子补丁或猴子补丁?

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

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


当前回答

根据维基百科:

在Python中,术语monkey补丁指对运行时的类或模块,受激励通过修补现有第三方代码作为不起作用的错误或功能您的愿望。

其他回答

什么是猴子补丁?

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

用法示例

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

姓名变更注意事项

如果您使用的是名称mangling(在属性前面加上双下划线,这会改变名称,我不建议这样做),那么您必须手动命名mangle。由于我不建议使用名称mangling,所以我不会在这里演示它。

测试示例

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

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

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的修补程序装饰器比上面的操作更不容易出错,这将需要更多的代码行,从而有更多的机会引入错误。我还没有审查mock中的代码,但我认为它以类似的方式使用了monkey修补。)

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

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

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

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

第一:猴子补丁是一种邪恶的黑客(在我看来)。

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

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

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

一个简单的示例如下:

from SomeOtherProduct.SomeModule import SomeClass

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

SomeClass.speak = speak

来源:Zopewiki上的MonkeyPatch页面。