00340 python monkey patch

发布日期: 2025-05-31

更新日期: 2025-05-31

前言

python monkey patch。

Operating System: Ubuntu 22.04.4 LTS

Python Monkey Patch 详解

Monkey Patch（猴子补丁） 是一种在运行时动态修改代码的技术，允许开发者在不修改原始源码的情况下，改变类、模块或函数的行为。它利用了 Python 的动态特性（如动态类型和命名空间），常用于热修复、测试模拟或扩展第三方库。

核心原理

动态替换：在运行时替换对象（类、方法、函数、属性）的引用。
命名空间操作：直接修改模块（module）、类（class）或实例（instance）的属性。
无侵入性：无需改动原始代码，适合修复闭源库或紧急问题。

典型应用场景

修复第三方库的 Bug

当无法直接修改库源码时，临时替换有问题的函数。

import somelib

def fixed_function():
    # 修复后的逻辑
    return "Fixed"

# 应用 Monkey Patch
somelib.buggy_function = fixed_function

单元测试中的 Mock 对象

模拟外部依赖（如网络请求、数据库调用）。

import requests

def mock_get(*args, **kwargs):
    class MockResponse:
        status_code = 200
        def json(self):
            return {"data": "mocked"}
    return MockResponse()

# 测试前替换 requests.get
requests.get = mock_get

扩展功能

为现有类动态添加新方法。

class MyClass:
    pass

def new_method(self):
    return "New method added!"

# 动态添加方法
MyClass.new_method = new_method

obj = MyClass()
print(obj.new_method())  # 输出: New method added!

兼容性适配

使旧代码兼容新接口。

import legacy_module

# 新接口适配旧函数
legacy_module.old_function = new_compatible_function

实现方式

修改类或模块的属性

# 修改类方法
class Original:
    def method(self):
        return "Original"

def patched_method(self):
    return "Patched"

Original.method = patched_method  # Monkey Patch

obj = Original()
print(obj.method())  # 输出: Patched

修改实例的方法（需处理绑定方法）

import types

obj = Original()

# 将函数绑定到实例
obj.method = types.MethodType(patched_method, obj)
print(obj.method())  # 输出: Patched

使用第三方库简化

**unittest.mock**（标准库，推荐用于测试）：

from unittest.mock import patch

with patch("module.Class.method", new=patched_method):
    # 在此作用域内方法被替换
    call_function()

pytest 的 monkeypatch 夹具：

def test_example(monkeypatch):
    monkeypatch.setattr("module.Class", "method", patched_method)
    # 测试期间方法被替换

优缺点分析

优点	缺点
✅ 快速修复生产环境问题	❌ 破坏代码可读性（行为隐藏）
✅ 无侵入式扩展第三方库	❌ 增加维护难度（补丁难以追踪）
✅ 简化单元测试	❌ 可能引发副作用（全局修改）
✅ 避免继承或重构的复杂操作	❌ 破坏封装性（绕过原始设计）

最佳实践

明确注释：在补丁处添加详细注释，说明原因和范围。
作用域最小化：
- 使用 with 语句（unittest.mock.patch）限制补丁范围。
- 测试后恢复原始状态（如 pytest 的 monkeypatch 自动恢复）。
优先选择官方方案：测试场景用 unittest.mock，避免手动替换。
避免滥用：仅作为临时方案，长期修复应提交给上游或重构代码。

示例：修复 requests 库超时

import requests

# 原始函数未设置超时
response = requests.get("https://example.com")  # 可能卡住

# 应用 Monkey Patch 添加默认超时
def safe_get(url, **kwargs):
    kwargs.setdefault("timeout", 5)  # 添加默认超时
    return requests._orig_get(url, **kwargs)

# 备份原函数并替换
requests._orig_get = requests.get
requests.get = safe_get

# 后续调用自动带超时
response = requests.get("https://example.com")  # 5秒超时