Python猴子补丁详解

猴子补丁(Monkey Patching)

目录

• 猴子补丁(Monkey Patching)
  • 1.什么是猴子补丁
  • 2.其他对象使用猴子补丁
    • 2.1 使用猴子补丁修复类的实例
    • 2.2 其他对象使用猴子补丁
  • 3. 使用场景与注意事情
  • 4 猴子补丁的用法

1.什么是猴子补丁

Python是一种典型的 脚本语言。 他不仅具有 动态类型(dynamic type), 而且它的 对象模型(object model)也是动态的。 Python的类 是可变的(mutable), 方法(methods)只是类的属性(attributes); 这允许我们在 运行时(run time) 修改其行为。这被称为猴子补丁(Monkey Patching),它值得是偷偷地更改代码

Monkey Patching只是在 运行时(run time) 动态替换属性(attributes)

而在Python中，术语monkey patch指地是对函数(function)、类(class)或者模块(module)的动态(或运行时)修改。

举例说明：

假设在monkey.py文件中已经定义了一个类:

# monkey.py
 
class Me:
    def who_am_i(self):
        print("I am a Moneky")

假设moneky.py文件中的 Me这类不是我写的，我只是用到了这个类

现在我在另外一个文件中想要调用这个类，但是发现这个类里面的who_am_i()方法不是我想要的内容

由于我是一个人类，我不喜欢打印我是一个猴子，我想要打印'I am human'

所以我给猴子对象打补丁(这里是一个双关语，就是monkey patch的名字的来源)，我们可以这么实现:

# test.py
import monkey
 
 
def i_am_human(self):
    print("I am human")
 
 
print(f"{monkey.Me.who_am_i = }")  # 替换前，将原来的方法地址打印出来
monkey.Me.who_am_i = i_am_human  # 将‘who_am_i’ 的地址替换为 'i_am_human'
print(f"{monkey.Me.who_am_i = }")
 
obj = monkey.Me()  # 实例化一个对象
 
print(f"{hasattr(obj, 'i_am_human') = }")
print(f"{hasattr(obj, 'who_am_i') = }")
obj.who_am_i()  # 直接调用"who_am_i",而不是"i_am_human"
 

输出结果：

monkey.Me.who_am_i = <function Me.who_am_i at 0x000002AF4760C3A0>
monkey.Me.who_am_i = <function i_am_human at 0x000002AF474C8820>
hasattr(obj, 'i_am_human') = False
hasattr(obj, 'who_am_i') = True
I am human

这个例子的结论：

1. 我们可以自己定义一个新的方法(或者函数)来更改掉原来类的方法
2. 替换以后，原来类的方法名称还在，但是它的内存地址已经发生变化了
3. 调用的时候，只能使用原来的方法名来调用，而不是新的方法名称
4. 新的方法名称只是包含了实现过程，对于类本身，是看不到这个方法名称的

2.其他对象使用猴子补丁

2.1 使用猴子补丁修复类的实例

上面使用了猴子补丁来修复了一个类的方法，那么该类的所有实例使用该方法的时候都将使用修补后的方法。

如果我们想要减少影响，只修补特定的实例对象， 是可以完成的，代码如下：

import types
import momkey
 
monkey1 = monkey.Me()
monkey2 = monkey.Me()
 
def i_am_human(self):
    print("I am human")
 
 
monkey2.who_am_i = types.MethodType(i_am_human, monkey2)
 
monkey1.who_am_i()
monkey2.who_am_i()

输出的结果：

I am a Monkey
I am human

这个例子的结论：

1. 同一个类的两个实例中，我们可以单独给某一个实例打猴子补丁，而完全不影响另外一个实例

2.2 其他对象使用猴子补丁

我们还可以对其他的对象使用猴子补丁，比如模块等，这里有一个比较使用的例子：

比如你的项目中，很多python文件中都用到了 import json，后来发现使用 ujson性能会更高，但是把每个文件的import json都改成import ujson as json 成本较高(不要光想着替换，很多项目不仅仅有一个开发人员)；或者仅仅想测试一下用ujson替换json是否符合预期

对于这种需求，只需要在程序的主入口处加上下面代码：

import json
import ujson
 
def monkey_patch_json():
    json.__name__ = 'ujson'
    json.dumps = ujson.dumps
    json.loads = ujson.loads
   
monkey_patch_json()

这样后面:

• 所有用到json.dumps就会自动调用ujson.dumps
• 所有用到json.loads就会自动调用ujson.loads

3. 使用场景与注意事情

可以看到猴子修补非常强大，几户可以在任何地方修改原来类的实现或者对象的原有功能。但是恰恰是由于其可以随时随地修改，会造成某个对象的具体功能是在哪儿实现的这个点非常不明确(破坏封装)，这回严重影响程序的鲁棒性，容易引起不必要的Bug。所以要慎用

猴子补丁适合的使用场景：

1. 我们正在处理来自其他人写的公共代码，优化了一个小的实现，我们目前不想对其源码进行修改（因为其他人还有可能再用这些代码，或者其他版本中有可能使用），我可以将这个补丁放在自己的代码中，即保证了功能的实现，也不影响别人实现
2. 我们正在处理来自其他人的遗留代码或代码，我们不想对其进行广泛修改，但仍然希望使其与不同版本的库或环境一起运行, 这非常有用。

因此：建议

1. 如果代码的影响范围可控，不要使用猴子补丁，直接更改原来方法的实现
2. 如果要使用猴子补丁，尽量在最终端的类或者实例中，不要在中间类中使用

4 猴子补丁的用法

• 运行时动态替换模块的方法
• 运行时动态增加模块的方法
• 运行时动态改变类的方法