Python 探针实现原理

470 查看

本文将简单讲述一下 Python 探针的实现原理。同时为了验证这个原理，我们也会一起来实现一个简单的统计指定函数执行时间的探针程序。

探针的实现主要涉及以下几个知识点:

sys.meta_path
sitecustomize.py

sys.meta_path

sys.meta_path 这个简单的来说就是可以实现 import hook 的功能，
当执行 import 相关的操作时，会触发 sys.meta_path 列表中定义的对象。
关于 sys.meta_path 更详细的资料请查阅 python 文档中 sys.meta_path 相关内容以及
PEP 0302 。

sys.meta_path 中的对象需要实现一个 find_module 方法，
这个 find_module 方法返回 None 或一个实现了 load_module 方法的对象
(代码可以从 github 上下载 part1) :

import sys

class MetaPathFinder:

def find_module(self, fullname, path=None):

print('find_module {}'.format(fullname))

return MetaPathLoader()

class MetaPathLoader:

def load_module(self, fullname):

print('load_module {}'.format(fullname))

sys.modules[fullname] = sys

return sys

sys.meta_path.insert(0, MetaPathFinder())

if __name__ == '__main__':

import http

print(http)

print(http.version_info)

load_module 方法返回一个 module 对象，这个对象就是 import 的 module 对象了。
比如我上面那样就把 http 替换为 sys 这个 module 了。

$ python meta_path1.py

find_module http

load_module http

sys.version_info(major=3, minor=5, micro=1, releaselevel='final', serial=0)

通过 sys.meta_path 我们就可以实现 import hook 的功能：
当 import 预定的 module 时，对这个 module 里的对象来个狸猫换太子，
从而实现获取函数或方法的执行时间等探测信息。

上面说到了狸猫换太子，那么怎么对一个对象进行狸猫换太子的操作呢？
对于函数对象，我们可以使用装饰器的方式来替换函数对象(代码可以从 github 上下载 part2) :

import functools

import time

def func_wrapper(func):

@functools.wraps(func)

def wrapper(*args, **kwargs):

print('start func')

start = time.time()

result = func(*args, **kwargs)

end = time.time()

print('spent {}s'.format(end - start))

return result

return wrapper

def sleep(n):

time.sleep(n)

return n

if __name__ == '__main__':

func = func_wrapper(sleep)

print(func(3))

执行结果:

$ python func_wrapper.py

start func

spent 3.004966974258423s

下面我们来实现一个计算指定模块的指定函数的执行时间的功能(代码可以从 github 上下载 part3) 。

假设我们的模块文件是 hello.py:

import time

def sleep(n):

time.sleep(n)

return n

我们的 import hook 是 hook.py:

import functools

import importlib

import sys

import time

_hook_modules = {'hello'}

class MetaPathFinder:

def find_module(self, fullname, path=None):

print('find_module {}'.format(fullname))

if fullname in _hook_modules:

return MetaPathLoader()

class MetaPathLoader:

def load_module(self, fullname):

print('load_module {}'.format(fullname))

# ``sys.modules`` 中保存的是已经导入过的 module

if fullname in sys.modules:

return sys.modules[fullname]

# 先从 sys.meta_path 中删除自定义的 finder

# 防止下面执行 import_module 的时候再次触发此 finder

# 从而出现递归调用的问题

finder = sys.meta_path.pop(0)

# 导入 module

module = importlib.import_module(fullname)

module_hook(fullname, module)

sys.meta_path.insert(0, finder)

return module

sys.meta_path.insert(0, MetaPathFinder())

def module_hook(fullname, module):

if fullname == 'hello':

module.sleep = func_wrapper(module.sleep)

def func_wrapper(func):

@functools.wraps(func)

def wrapper(*args, **kwargs):

print('start func')

start = time.time()

result = func(*args, **kwargs)

end = time.time()

print('spent {}s'.format(end - start))

return result

return wrapper

测试代码:

>>> import hook

>>> import hello

find_module hello

load_module hello

>>>

>>> hello.sleep(3)

start func

spent 3.0029919147491455s

>>>

其实上面的代码已经实现了探针的基本功能。不过有一个问题就是上面的代码需要显示的
执行 import hook 操作才会注册上我们定义的 hook。

那么有没有办法在启动 python 解释器的时候自动执行 import hook 的操作呢？
答案就是可以通过定义 sitecustomize.py 的方式来实现这个功能。

sitecustomize.py

简单的说就是，python 解释器初始化的时候会自动 import PYTHONPATH 下存在的 sitecustomize 和 usercustomize 模块:

实验项目的目录结构如下(代码可以从 github 上下载 part4)

$ tree

├── sitecustomize.py

└── usercustomize.py