什么是猴子补丁?

Ser*_*rov 496 python monkeypatching terminology

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

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

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

Dan*_*man 480

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

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

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

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

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

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

  • @LutzPrechelt 只是为了让我清楚,“指向原始 get_data 函数”是什么意思?您的意思是,当您将函数存储在变量中时,如果有人更改该函数,该变量将继续指向旧函数吗? (2认同)
  • @fabriciorissetto:您通常不会在Python中更改函数对象.当你修补`get_data`时,你将名称`get_data`重新绑定到模拟函数.如果程序中其他位置的某个其他名称绑定到-function-formerly-known-as-`get_data`,那么该名称的其他任何名称都不会改变. (2认同)

Pao*_*olo 348

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

一个简单的例子如下:

from SomeOtherProduct.SomeModule import SomeClass

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

SomeClass.speak = speak
Run Code Online (Sandbox Code Playgroud)

来源: Zope wiki上的MonkeyPatch页面.


Aar*_*all 113

什么是猴子补丁?

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

使用示例

在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
Run Code Online (Sandbox Code Playgroud)

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

import pandas as pd
Run Code Online (Sandbox Code Playgroud)

接下来,我们创建一个方法定义,它在任何类定义的范围之外都是未绑定和空闲的(因为在函数和未绑定方法之间区别是没有意义的,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]
Run Code Online (Sandbox Code Playgroud)

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

pd.DataFrame.just_foo_cols = just_foo_cols # monkey-patch the DataFrame class
Run Code Online (Sandbox Code Playgroud)

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

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
Run Code Online (Sandbox Code Playgroud)

警告名称错误

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

测试示例

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

假设我们需要模拟对导致错误的外部数据源的数据检索调用,因为我们希望在这种情况下确保正确的行为.我们可以修补数据结构以确保这种行为.(所以使用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
Run Code Online (Sandbox Code Playgroud)

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

只是执行上述操作将改变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
Run Code Online (Sandbox Code Playgroud)

(虽然上面是好的,它很可能是一个更好的主意,使用mock图书馆修补代码mockpatch装饰将误差小于做上述容易,这需要更多的代码,从而有更多机会引入错误我还没有查看代码,mock但我想它以类似的方式使用猴子修补.)

  • @Tommy如果对“覆盖”方法的引用为零-则将其垃圾回收,从而在进程的生命周期内“丢失”(或除非重新加载了它所在的模块,但通常不鼓励这样做)。 (3认同)

Dav*_*nan 29

根据维基百科:

在Python中,术语"猴子补丁"仅指在运行时对类或模块进行动态修改,其动机是将现有第三方代码修补为对不符合您需要的错误或功能的变通方法.


小智 17

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

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

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

  • 虽然它的功率一般来说确实很危险,但它对于测试来说非常有用 (43认同)
  • 为什么这是邪恶的? (14认同)
  • 如果某些模块在修补同样的事情:你注定要失败. (8认同)
  • 它不是邪恶的,我用它来修补其他人软件中的错误,直到新版本发布,而不是分叉并创建新的依赖项。 (4认同)
  • 最常见的用例实际上是用于测试,尤其是单元测试。您只想测试您的代码,因此您修补任何外部调用以返回预期结果。 (2认同)
  • 猴子修补可以通过“纯功能方式”而不是可变的、“上下文敏感的”、类似 goto 的方式来完成,只需在返回类/方法的新修补版本的装饰器内部进行修补(而不是修改它)。许多 C# / Java 程序员不了解 REPL 驱动开发,因此他们在 IDE 中编写代码,要求所有内容都是静态定义的。由于 C#/Java 没有猴子补丁,因此当他们在 JavaScript、Smalltalk、Lisp、Python 等中看到它时,他们就会认为它是邪恶的……因为它违背了他们的静态 IDE 驱动开发实践。 (2认同)

Aar*_*our 13

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

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


kam*_*mal 5

猴子修补程序是在运行时重新打开类中的现有类或方法,并更改其行为,应谨慎使用,或者仅在确实需要时使用它。

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


aka*_*mar 5

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

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

结论Monkey patching 是一项很酷的技术,现在我们已经学会了如何在 Python 中做到这一点。然而,正如我们所讨论的,它有其自身的缺点,应谨慎使用。