什么是猴子补丁?

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

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

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

301911 次浏览

根据维基百科

在Python中,术语猴子补丁仅指动态修改运行时的类或模块,有动机通过修补现有的意图第三方代码作为解决方法不作为的bug或特征你想要的

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

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

因为Python类是可变的,而方法只是类的属性,所以您可以随心所欲地执行此操作-实际上,您甚至可以以完全相同的方式替换模块中的类和函数。

但是,正如评论者所指出的那样,在猴子修补时要小心:

  1. 如果除了您的测试逻辑之外的任何其他东西也调用get_data,它也会调用您的猴子补丁替换而不是原始-这可能是好的也可能是坏的。只是要小心。

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

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

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

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

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

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

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

一个简单的例子看起来像这样:

from SomeOtherProduct.SomeModule import SomeClass
def speak(self):return "ook ook eee eee eee!"
SomeClass.speak = speak

Zope wiki上的来源:猴子补丁页面。

什么是猴子补丁?

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

使用示例

在Pandas留档中有一个猴子补丁的例子:

import pandas as pddef 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 classdf = 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

名称篡改警告

如果你正在使用name-mangling(用双下划线作为属性的前缀,这会改变名称,我不建议这样做),你必须手动使用name-mangle。由于我不建议使用name-mangling,我不会在这里演示它。

测试示例

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

假设我们需要模拟对导致错误的外部数据源的数据检索调用,因为我们想确保在这种情况下的正确行为。我们可以对数据结构进行猴子修补以确保这种行为。(所以使用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库来修补代码可能是一个更好的主意。mockpatch装饰器比上面的方法更不容易出错,这将需要更多的代码行,从而有更多的机会引入错误。我还没有审查mock中的代码,但我想它以类似的方式使用猴子修补。)

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

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

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

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

结论猴子补丁是一种很酷的技术,现在我们已经学习了如何在Python中做到这一点。然而,正如我们所讨论的,它有它的#36825;的缺点,应该谨慎使用。