什么是猴子补丁?

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

这是像方法/运营商重载或委托?

这些东西有什么共同点吗?

不,这不像那些东西。 这只是在运行时dynamicreplace属性。

例如,考虑一个具有方法get_data 。 此方法执行外部查找(例如,在数据库或Web API上),而类中的其他各种方法调用它。 但是,在unit testing中,您不希望依赖外部数据源,因此您可以dynamic地将get_data方法replace为可返回一些固定数据的存根。

因为Python类是可变的,而且方法只是类的属性,所以你可以尽可能地做到这一点 – 事实上,甚至可以用完全相同的方式replace模块中的类和函数。

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

一个简单的例子是这样的:

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

来源: Zope维基上的MonkeyPatch页面。

什么是猴子补丁?

简而言之,在程序运行时,猴子补丁正在对模块或类进行更改。

使用示例

在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 

接下来我们创build一个方法定义,该定义在任何类定义的范围之外都是无约束和自由的(因为在函数和未绑定方法之间的区别是毫无意义的,所以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(带有双下划线的前缀属性,这会改变名字,而我不build议这样做),如果你这样做的话,你必须手工命名。 既然我不推荐名字,我不会在这里展示。

testing例子

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

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

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

而当我们testing依赖这种方法的行为时,如果正确实施,我们会在testing结果中得到这种行为。

只是做了上面的事情就会改变整个过程的Structure对象,所以你需要在你的unit testing中使用设置和拆卸来避免这样做,例如:

 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中,“猴子补丁”这个术语只是指在运行时对类或模块进行dynamic修改,其目的是将现有的第三方代码作为解决scheme修补到一个不能满足您需求的错误或function。

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

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

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

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

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

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

由于Python是一种dynamic编程语言,类是可变的,所以你可以重新打开它们,修改甚至replace它们。