719

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

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

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

4

8 回答 8

660

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

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

因为 Python 类是可变的，而方法只是类的属性，所以您可以随心所欲地这样做——事实上，您甚至可以用完全相同的方式替换模块中的类和函数。

但是，正如评论者指出的那样，在进行猴子补丁时要小心：

  1. 如果除了您的测试逻辑之外还有其他调用get_data，它还将调用您的猴子补丁替换而不是原始替换 - 这可能是好是坏。请注意。

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

于 2011-04-11T19:10:57.340 回答
413

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

一个简单的示例如下所示：

from SomeOtherProduct.SomeModule import SomeClass

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

SomeClass.speak = speak

来源： Zope wiki 上的 MonkeyPatch页面。

于 2011-07-11T08:52:36.207 回答
152

什么是猴子补丁？

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

使用示例

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

名称修改的警告

如果您正在使用名称修饰（使用双下划线为属性添加前缀，这会改变名称，我不建议这样做），如果您这样做，您将不得不手动进行名称修饰。由于我不推荐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（虽然上面很好，但使用库来修补代码可能是一个更好的主意。 mock' 的patch装饰器会比上面的更不容易出错，这需要更多的代码行，因此有更多的机会引入错误.我还没有查看代码，mock但我想它以类似的方式使用猴子补丁。）

于 2014-12-14T04:57:48.733 回答
36

根据维基百科：

在 Python 中，monkey patch 一词仅指在运行时对类或模块的动态修改，其动机是为了修补现有的第三方代码，以解决不符合您要求的错误或功能。

于 2011-04-11T19:08:52.473 回答
18

第一：猴子补丁是一种邪恶的黑客（在我看来）。

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

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

于 2011-04-11T19:11:13.617 回答
13

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

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

于 2011-04-11T20:01:14.570 回答
5

猴子补丁是在运行时重新打开类中现有的类或方法并改变行为，应谨慎使用，或者仅在确实需要时使用。

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

于 2016-01-14T16:48:28.287 回答
4

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

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

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

于 2019-11-02T06:38:38.520 回答