首页 > 代码库 > Python Monkey patch猴子补丁

Python Monkey patch猴子补丁

monkey patch (猴子补丁)
   用来在运行时动态修改已有的代码,而不需要修改原始代码。

简单的monkey patch 实现:
[python] 
#coding=utf-8 
def originalFunc(): 
    print ‘this is original function!‘ 
     
def modifiedFunc(): 
    modifiedFunc=1 
    print ‘this is modified function!‘ 
     
def main(): 
    originalFunc() 
     
if __name__==‘__main__‘: 
    originalFunc=modifiedFunc 
    main() 

 

python中所有的东西都是object,包括基本类型。查看一个object的所有属性的方法是:dir(obj)
函数在python中可以像使用变量一样对它进行赋值等操作。
查看属性的方法:
 
print locals() 
print globals() 

 

当我们import一个module时,python会做以下几件事情


  •导入一个module
  •将module对象加入到sys.modules,后续对该module的导入将直接从该dict中获得
  •将module对象加入到globals dict中


当我们引用一个模块时,将会从globals中查找。这里如果要替换掉一个标准模块,我们得做以下两件事情


    1.将我们自己的module加入到sys.modules中,替换掉原有的模块。如果被替换模块还没加载,那么我们得先对其进行加载,否则第一次加载时,还会加载标准模块。(这里有一个import hook可以用,不过这需要我们自己实现该hook,可能也可以使用该方法hook module import)
    2.如果被替换模块引用了其他模块,那么我们也需要进行替换,但是这里我们可以修改globals dict,将我们的module加入到globals以hook这些被引用的模块。

一篇文章:

What is Monkey Patch

 

Monkey patch就是在运行时对已有的代码进行修改,达到hot patch的目的。Eventlet中大量使用了该技巧,以替换标准库中的组件,比如socket。首先来看一下最简单的monkey patch的实现。

class Foo(object):    def bar(self):        print Foo.bardef bar(self):    print Modified barFoo().bar()Foo.bar = barFoo().bar()

由于Python中的名字空间是开放,通过dict来实现,所以很容易就可以达到patch的目的。

Python namespace

Python有几个namespace,分别是

  • locals
  • globals
  • builtin

其中定义在函数内声明的变量属于locals,而模块内定义的函数属于globals。

Python module Import & Name Lookup

当我们import一个module时,python会做以下几件事情

  • 导入一个module
  • 将module对象加入到sys.modules,后续对该module的导入将直接从该dict中获得
  • 将module对象加入到globals dict中

当我们引用一个模块时,将会从globals中查找。这里如果要替换掉一个标准模块,我们得做以下两件事情

  1. 将我们自己的module加入到sys.modules中,替换掉原有的模块。如果被替换模块还没加载,那么我们得先对其进行加载,否则第一次加载时,还会加载标准模块。(这里有一个import hook可以用,不过这需要我们自己实现该hook,可能也可以使用该方法hook module import)
  2. 如果被替换模块引用了其他模块,那么我们也需要进行替换,但是这里我们可以修改globals dict,将我们的module加入到globals以hook这些被引用的模块。

Eventlet Patcher Implementation

现在我们先来看一下eventlet中的Patcher的调用代码吧,这段代码对标准的ftplib做monkey patch,将eventlet的GreenSocket替换标准的socket。

from eventlet import patcher# *NOTE: there might be some funny business with the "SOCKS" module# if it even still existsfrom eventlet.green import socketpatcher.inject(ftplib, globals(), (socket, socket))del patcher

inject函数会将eventlet的socket模块注入标准的ftplib中,globals dict被传入以做适当的修改。

让我们接着来看一下inject的实现。

__exclude = set((__builtins__, __file__, __name__))def inject(module_name, new_globals, *additional_modules):    """Base method for "injecting" greened modules into an imported module.  It    imports the module specified in *module_name*, arranging things so    that the already-imported modules in *additional_modules* are used when    *module_name* makes its imports.    *new_globals* is either None or a globals dictionary that gets populated    with the contents of the *module_name* module.  This is useful when creating    a "green" version of some other module.    *additional_modules* should be a collection of two-element tuples, of the    form (, ).  If it‘s not specified, a default selection of    name/module pairs is used, which should cover all use cases but may be    slower because there are inevitably redundant or unnecessary imports.    """    if not additional_modules:        # supply some defaults        additional_modules = (            _green_os_modules() +            _green_select_modules() +            _green_socket_modules() +            _green_thread_modules() +            _green_time_modules())    ## Put the specified modules in sys.modules for the duration of the import    saved = {}    for name, mod in additional_modules:        saved[name] = sys.modules.get(name, None)        sys.modules[name] = mod    ## Remove the old module from sys.modules and reimport it while    ## the specified modules are in place    old_module = sys.modules.pop(module_name, None)    try:        module = __import__(module_name, {}, {}, module_name.split(.)[:-1])        if new_globals is not None:            ## Update the given globals dictionary with everything from this new module            for name in dir(module):                if name not in __exclude:                    new_globals[name] = getattr(module, name)        ## Keep a reference to the new module to prevent it from dying        sys.modules[__patched_module_ + module_name] = module    finally:        ## Put the original module back        if old_module is not None:            sys.modules[module_name] = old_module        elif module_name in sys.modules:            del sys.modules[module_name]        ## Put all the saved modules back        for name, mod in additional_modules:            if saved[name] is not None:                sys.modules[name] = saved[name]            else:                del sys.modules[name]    return module

注释比较清楚的解释了代码的意图。代码还是比较容易理解的。这里有一个函数__import__,这个函数提供一个模块名(字符串),来加载一个模块。而我们import或者reload时提供的名字是对象。

if new_globals is not None:    ## Update the given globals dictionary with everything from this new module    for name in dir(module):        if name not in __exclude:            new_globals[name] = getattr(module, name)
这段代码的作用是将标准的ftplib中的对象加入到eventlet的ftplib模块中。因为我们在eventlet.ftplib中调用了inject,传入了globals,而inject中我们手动__import__了这个module,只得到了一个模块对象,所以模块中的对象不会被加入到globals中,需要手动添加。

这里为什么不用from ftplib import *的缘故,应该是因为这样无法做到完全替换ftplib的目的。因为from … import *会根据__init__.py中的__all__列表来导入public symbol,而这样对于下划线开头的private symbol将不会导入,无法做到完全patch。

转自:http://blog.csdn.net/seizef/article/details/5732657