Python程式設計中對Monkey Patch猴補丁開發方式

Monkey Patch猴子補丁方式是指在不修改程式原本程式碼的前提下,透過添加類別或模組等方式在程式運行過程中加入程式碼,下面就來進一步詳解Python程式設計中對Monkey Patch猴子補丁開發方式的運用

Monkey patch就是在執行時對現有的程式碼進行修改，達到hot patch的目的。 Eventlet中大量使用了該技巧，以替換標準庫中的元件，例如socket。首先來看看最簡單的monkey patch的實作。

class Foo(object):
  def bar(self):
    print 'Foo.bar'

def bar(self):
  print 'Modified bar'

Foo().bar()

Foo.bar = bar

Foo().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中尋找。這裡如果要替換掉一個標準模組，我們得做以下兩件事情

將我們自己的module加入到sys.modules中，替換掉原有的模組。如果被替換模組還沒加載，那麼我們得先對其進行加載，否則第一次加載時，還會加載標準模組。 （這裡有一個import hook可以用，不過這需要我們自己實作該hook，可能也可以使用該方法hook module import）

如果被替換模組引用了其他模組，那麼我們也需要進行替換，但是這裡我們可以修改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 exists
from eventlet.green import socket

patcher.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。

更多Python程式中對Monkey Patch猴子補丁開發方式相關文章請關注PHP中文網！

#