501 lines
17 KiB
Python
501 lines
17 KiB
Python
import collections
|
|
import imp
|
|
import sys
|
|
import types
|
|
|
|
from eventlet.support import six
|
|
|
|
|
|
__all__ = ['inject', 'import_patched', 'monkey_patch', 'is_monkey_patched']
|
|
|
|
__exclude = set(('__builtins__', '__file__', '__name__'))
|
|
_MISSING = object()
|
|
|
|
|
|
class SysModulesSaver(object):
|
|
"""Class that captures some subset of the current state of
|
|
sys.modules. Pass in an iterator of module names to the
|
|
constructor."""
|
|
|
|
def __init__(self, module_names=()):
|
|
self._saved = {}
|
|
imp.acquire_lock()
|
|
self.save(*module_names)
|
|
|
|
def save(self, *module_names):
|
|
"""Saves the named modules to the object."""
|
|
for modname in module_names:
|
|
self._saved[modname] = sys.modules.get(modname, None)
|
|
|
|
def restore(self):
|
|
"""Restores the modules that the saver knows about into
|
|
sys.modules.
|
|
"""
|
|
try:
|
|
for modname, mod in six.iteritems(self._saved):
|
|
if mod is not None:
|
|
sys.modules[modname] = mod
|
|
else:
|
|
sys.modules.pop(modname, None)
|
|
finally:
|
|
imp.release_lock()
|
|
|
|
|
|
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.
|
|
|
|
**Note:** This function does not create or change any sys.modules item, so
|
|
if your greened module use code like 'sys.modules["your_module_name"]', you
|
|
need to update sys.modules by yourself.
|
|
|
|
*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 (<name>, <module>). 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.
|
|
"""
|
|
patched_name = '__patched_module_' + module_name
|
|
if patched_name in sys.modules:
|
|
# returning already-patched module so as not to destroy existing
|
|
# references to patched modules
|
|
return sys.modules[patched_name]
|
|
|
|
if not additional_modules:
|
|
# supply some defaults
|
|
additional_modules = (
|
|
_green_os_modules() +
|
|
_green_select_modules() +
|
|
_green_socket_modules() +
|
|
_green_thread_modules() +
|
|
_green_time_modules())
|
|
# _green_MySQLdb()) # enable this after a short baking-in period
|
|
|
|
# after this we are gonna screw with sys.modules, so capture the
|
|
# state of all the modules we're going to mess with, and lock
|
|
saver = SysModulesSaver([name for name, _ in additional_modules])
|
|
saver.save(module_name)
|
|
|
|
# Cover the target modules so that when you import the module it
|
|
# sees only the patched versions
|
|
for name, mod in additional_modules:
|
|
sys.modules[name] = mod
|
|
|
|
# Remove the old module from sys.modules and reimport it while
|
|
# the specified modules are in place
|
|
sys.modules.pop(module_name, None)
|
|
|
|
import_control = _patch_import(dict(additional_modules))
|
|
try:
|
|
import_control.begin()
|
|
try:
|
|
module = import_control.original(module_name, fromlist=module_name.split('.')[:-1])
|
|
finally:
|
|
import_control.end()
|
|
|
|
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_name] = module
|
|
finally:
|
|
saver.restore() # Put the original modules back
|
|
|
|
return module
|
|
|
|
|
|
ImportControl = collections.namedtuple('ImportControl', 'begin end original patched')
|
|
|
|
|
|
def _patch_import(patch_map, _missing=object()):
|
|
original = __builtins__['__import__']
|
|
|
|
def fun(name, *args, **kwargs):
|
|
module = original(name, *args, **kwargs)
|
|
for k in dir(module):
|
|
v = getattr(module, k, None)
|
|
replacement = patch_map.get(k)
|
|
if isinstance(v, types.ModuleType) and replacement is not None:
|
|
# print(' _patch_import {0}.{1} = {2}'.format(name, k, v))
|
|
setattr(module, k, replacement)
|
|
return module
|
|
|
|
def begin():
|
|
__builtins__['__import__'] = fun
|
|
|
|
def end():
|
|
__builtins__['__import__'] = original
|
|
|
|
control = ImportControl(begin, end, original, fun)
|
|
return control
|
|
|
|
|
|
def import_patched(module_name, *additional_modules, **kw_additional_modules):
|
|
"""Imports a module in a way that ensures that the module uses "green"
|
|
versions of the standard library modules, so that everything works
|
|
nonblockingly.
|
|
|
|
The only required argument is the name of the module to be imported.
|
|
"""
|
|
return inject(
|
|
module_name,
|
|
None,
|
|
*additional_modules + tuple(kw_additional_modules.items()))
|
|
|
|
|
|
def patch_function(func, *additional_modules):
|
|
"""Decorator that returns a version of the function that patches
|
|
some modules for the duration of the function call. This is
|
|
deeply gross and should only be used for functions that import
|
|
network libraries within their function bodies that there is no
|
|
way of getting around."""
|
|
if not additional_modules:
|
|
# supply some defaults
|
|
additional_modules = (
|
|
_green_os_modules() +
|
|
_green_select_modules() +
|
|
_green_socket_modules() +
|
|
_green_thread_modules() +
|
|
_green_time_modules())
|
|
|
|
def patched(*args, **kw):
|
|
saver = SysModulesSaver()
|
|
for name, mod in additional_modules:
|
|
saver.save(name)
|
|
sys.modules[name] = mod
|
|
try:
|
|
return func(*args, **kw)
|
|
finally:
|
|
saver.restore()
|
|
return patched
|
|
|
|
|
|
def _original_patch_function(func, *module_names):
|
|
"""Kind of the contrapositive of patch_function: decorates a
|
|
function such that when it's called, sys.modules is populated only
|
|
with the unpatched versions of the specified modules. Unlike
|
|
patch_function, only the names of the modules need be supplied,
|
|
and there are no defaults. This is a gross hack; tell your kids not
|
|
to import inside function bodies!"""
|
|
def patched(*args, **kw):
|
|
saver = SysModulesSaver(module_names)
|
|
for name in module_names:
|
|
sys.modules[name] = original(name)
|
|
try:
|
|
return func(*args, **kw)
|
|
finally:
|
|
saver.restore()
|
|
return patched
|
|
|
|
|
|
def original(modname):
|
|
""" This returns an unpatched version of a module; this is useful for
|
|
Eventlet itself (i.e. tpool)."""
|
|
# note that it's not necessary to temporarily install unpatched
|
|
# versions of all patchable modules during the import of the
|
|
# module; this is because none of them import each other, except
|
|
# for threading which imports thread
|
|
original_name = '__original_module_' + modname
|
|
if original_name in sys.modules:
|
|
return sys.modules.get(original_name)
|
|
|
|
# re-import the "pure" module and store it in the global _originals
|
|
# dict; be sure to restore whatever module had that name already
|
|
saver = SysModulesSaver((modname,))
|
|
sys.modules.pop(modname, None)
|
|
# some rudimentary dependency checking -- fortunately the modules
|
|
# we're working on don't have many dependencies so we can just do
|
|
# some special-casing here
|
|
if six.PY2:
|
|
deps = {'threading': 'thread', 'Queue': 'threading'}
|
|
if six.PY3:
|
|
deps = {'threading': '_thread', 'queue': 'threading'}
|
|
if modname in deps:
|
|
dependency = deps[modname]
|
|
saver.save(dependency)
|
|
sys.modules[dependency] = original(dependency)
|
|
try:
|
|
real_mod = __import__(modname, {}, {}, modname.split('.')[:-1])
|
|
if modname in ('Queue', 'queue') and not hasattr(real_mod, '_threading'):
|
|
# tricky hack: Queue's constructor in <2.7 imports
|
|
# threading on every instantiation; therefore we wrap
|
|
# it so that it always gets the original threading
|
|
real_mod.Queue.__init__ = _original_patch_function(
|
|
real_mod.Queue.__init__,
|
|
'threading')
|
|
# save a reference to the unpatched module so it doesn't get lost
|
|
sys.modules[original_name] = real_mod
|
|
finally:
|
|
saver.restore()
|
|
|
|
return sys.modules[original_name]
|
|
|
|
already_patched = {}
|
|
|
|
|
|
def monkey_patch(**on):
|
|
"""Globally patches certain system modules to be greenthread-friendly.
|
|
|
|
The keyword arguments afford some control over which modules are patched.
|
|
If no keyword arguments are supplied, all possible modules are patched.
|
|
If keywords are set to True, only the specified modules are patched. E.g.,
|
|
``monkey_patch(socket=True, select=True)`` patches only the select and
|
|
socket modules. Most arguments patch the single module of the same name
|
|
(os, time, select). The exceptions are socket, which also patches the ssl
|
|
module if present; and thread, which patches thread, threading, and Queue.
|
|
|
|
It's safe to call monkey_patch multiple times.
|
|
"""
|
|
accepted_args = set(('os', 'select', 'socket',
|
|
'thread', 'time', 'psycopg', 'MySQLdb',
|
|
'builtins', 'subprocess'))
|
|
# To make sure only one of them is passed here
|
|
assert not ('__builtin__' in on and 'builtins' in on)
|
|
try:
|
|
b = on.pop('__builtin__')
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
on['builtins'] = b
|
|
|
|
default_on = on.pop("all", None)
|
|
|
|
for k in six.iterkeys(on):
|
|
if k not in accepted_args:
|
|
raise TypeError("monkey_patch() got an unexpected "
|
|
"keyword argument %r" % k)
|
|
if default_on is None:
|
|
default_on = not (True in on.values())
|
|
for modname in accepted_args:
|
|
if modname == 'MySQLdb':
|
|
# MySQLdb is only on when explicitly patched for the moment
|
|
on.setdefault(modname, False)
|
|
if modname == 'builtins':
|
|
on.setdefault(modname, False)
|
|
on.setdefault(modname, default_on)
|
|
|
|
if on['thread'] and not already_patched.get('thread'):
|
|
_green_existing_locks()
|
|
|
|
modules_to_patch = []
|
|
for name, modules_function in [
|
|
('os', _green_os_modules),
|
|
('select', _green_select_modules),
|
|
('socket', _green_socket_modules),
|
|
('thread', _green_thread_modules),
|
|
('time', _green_time_modules),
|
|
('MySQLdb', _green_MySQLdb),
|
|
('builtins', _green_builtins),
|
|
('subprocess', _green_subprocess_modules),
|
|
]:
|
|
if on[name] and not already_patched.get(name):
|
|
modules_to_patch += modules_function()
|
|
already_patched[name] = True
|
|
|
|
if on['psycopg'] and not already_patched.get('psycopg'):
|
|
try:
|
|
from eventlet.support import psycopg2_patcher
|
|
psycopg2_patcher.make_psycopg_green()
|
|
already_patched['psycopg'] = True
|
|
except ImportError:
|
|
# note that if we get an importerror from trying to
|
|
# monkeypatch psycopg, we will continually retry it
|
|
# whenever monkey_patch is called; this should not be a
|
|
# performance problem but it allows is_monkey_patched to
|
|
# tell us whether or not we succeeded
|
|
pass
|
|
|
|
imp.acquire_lock()
|
|
try:
|
|
for name, mod in modules_to_patch:
|
|
orig_mod = sys.modules.get(name)
|
|
if orig_mod is None:
|
|
orig_mod = __import__(name)
|
|
for attr_name in mod.__patched__:
|
|
patched_attr = getattr(mod, attr_name, None)
|
|
if patched_attr is not None:
|
|
setattr(orig_mod, attr_name, patched_attr)
|
|
deleted = getattr(mod, '__deleted__', [])
|
|
for attr_name in deleted:
|
|
if hasattr(orig_mod, attr_name):
|
|
delattr(orig_mod, attr_name)
|
|
finally:
|
|
imp.release_lock()
|
|
|
|
if sys.version_info >= (3, 3):
|
|
import importlib._bootstrap
|
|
thread = original('_thread')
|
|
# importlib must use real thread locks, not eventlet.Semaphore
|
|
importlib._bootstrap._thread = thread
|
|
|
|
# Issue #185: Since Python 3.3, threading.RLock is implemented in C and
|
|
# so call a C function to get the thread identifier, instead of calling
|
|
# threading.get_ident(). Force the Python implementation of RLock which
|
|
# calls threading.get_ident() and so is compatible with eventlet.
|
|
import threading
|
|
threading.RLock = threading._PyRLock
|
|
|
|
|
|
def is_monkey_patched(module):
|
|
"""Returns True if the given module is monkeypatched currently, False if
|
|
not. *module* can be either the module itself or its name.
|
|
|
|
Based entirely off the name of the module, so if you import a
|
|
module some other way than with the import keyword (including
|
|
import_patched), this might not be correct about that particular
|
|
module."""
|
|
return module in already_patched or \
|
|
getattr(module, '__name__', None) in already_patched
|
|
|
|
|
|
def _green_existing_locks():
|
|
"""Make locks created before monkey-patching safe.
|
|
|
|
RLocks rely on a Lock and on Python 2, if an unpatched Lock blocks, it
|
|
blocks the native thread. We need to replace these with green Locks.
|
|
|
|
This was originally noticed in the stdlib logging module."""
|
|
import gc
|
|
import threading
|
|
import eventlet.green.thread
|
|
lock_type = type(threading.Lock())
|
|
rlock_type = type(threading.RLock())
|
|
if sys.version_info[0] >= 3:
|
|
pyrlock_type = type(threading._PyRLock())
|
|
# We're monkey-patching so there can't be any greenlets yet, ergo our thread
|
|
# ID is the only valid owner possible.
|
|
tid = eventlet.green.thread.get_ident()
|
|
for obj in gc.get_objects():
|
|
if isinstance(obj, rlock_type):
|
|
if (sys.version_info[0] == 2 and
|
|
isinstance(obj._RLock__block, lock_type)):
|
|
_fix_py2_rlock(obj, tid)
|
|
elif (sys.version_info[0] >= 3 and
|
|
not isinstance(obj, pyrlock_type)):
|
|
_fix_py3_rlock(obj)
|
|
|
|
|
|
def _fix_py2_rlock(rlock, tid):
|
|
import eventlet.green.threading
|
|
old = rlock._RLock__block
|
|
new = eventlet.green.threading.Lock()
|
|
rlock._RLock__block = new
|
|
if old.locked():
|
|
new.acquire()
|
|
rlock._RLock__owner = tid
|
|
|
|
|
|
def _fix_py3_rlock(old):
|
|
import gc
|
|
import threading
|
|
new = threading._PyRLock()
|
|
while old._is_owned():
|
|
old.release()
|
|
new.acquire()
|
|
if old._is_owned():
|
|
new.acquire()
|
|
gc.collect()
|
|
for ref in gc.get_referrers(old):
|
|
try:
|
|
ref_vars = vars(ref)
|
|
except TypeError:
|
|
pass
|
|
else:
|
|
for k, v in ref_vars.items():
|
|
if v == old:
|
|
setattr(ref, k, new)
|
|
|
|
|
|
def _green_os_modules():
|
|
from eventlet.green import os
|
|
return [('os', os)]
|
|
|
|
|
|
def _green_select_modules():
|
|
from eventlet.green import select
|
|
modules = [('select', select)]
|
|
|
|
if sys.version_info >= (3, 4):
|
|
from eventlet.green import selectors
|
|
modules.append(('selectors', selectors))
|
|
|
|
return modules
|
|
|
|
|
|
def _green_socket_modules():
|
|
from eventlet.green import socket
|
|
try:
|
|
from eventlet.green import ssl
|
|
return [('socket', socket), ('ssl', ssl)]
|
|
except ImportError:
|
|
return [('socket', socket)]
|
|
|
|
|
|
def _green_subprocess_modules():
|
|
from eventlet.green import subprocess
|
|
return [('subprocess', subprocess)]
|
|
|
|
|
|
def _green_thread_modules():
|
|
from eventlet.green import Queue
|
|
from eventlet.green import thread
|
|
from eventlet.green import threading
|
|
if six.PY2:
|
|
return [('Queue', Queue), ('thread', thread), ('threading', threading)]
|
|
if six.PY3:
|
|
return [('queue', Queue), ('_thread', thread), ('threading', threading)]
|
|
|
|
|
|
def _green_time_modules():
|
|
from eventlet.green import time
|
|
return [('time', time)]
|
|
|
|
|
|
def _green_MySQLdb():
|
|
try:
|
|
from eventlet.green import MySQLdb
|
|
return [('MySQLdb', MySQLdb)]
|
|
except ImportError:
|
|
return []
|
|
|
|
|
|
def _green_builtins():
|
|
try:
|
|
from eventlet.green import builtin
|
|
return [('__builtin__' if six.PY2 else 'builtins', builtin)]
|
|
except ImportError:
|
|
return []
|
|
|
|
|
|
def slurp_properties(source, destination, ignore=[], srckeys=None):
|
|
"""Copy properties from *source* (assumed to be a module) to
|
|
*destination* (assumed to be a dict).
|
|
|
|
*ignore* lists properties that should not be thusly copied.
|
|
*srckeys* is a list of keys to copy, if the source's __all__ is
|
|
untrustworthy.
|
|
"""
|
|
if srckeys is None:
|
|
srckeys = source.__all__
|
|
destination.update(dict([
|
|
(name, getattr(source, name))
|
|
for name in srckeys
|
|
if not (name.startswith('__') or name in ignore)
|
|
]))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.argv.pop(0)
|
|
monkey_patch()
|
|
with open(sys.argv[0]) as f:
|
|
code = compile(f.read(), sys.argv[0], 'exec')
|
|
exec(code)
|