非常干货：Python 探针实现原理

文章目录[隐藏]

sys.meta_path
sitecustomize.py
agent

多人学习 python，不知道从何学起。

很多人学习python，掌握了基本语法过后，不知道在哪里寻找案例上手。

很多已经做案例的人，却不知道如何去学习更加高深的知识。

那么针对这三类人，我给大家提供一个好的学习平台，免费领取视频教程，电子书籍，以及课程的源代码！??¤

QQ群：1057034340

One old watch, like brief python

原文：

关于 Python 的导入机制，我以前写过一篇文章，非常详细，感兴趣的可以点击这个链接进行查看：深入探讨 Python 的 import 机制：实现远程导入模块

另外，今天再给你推荐这篇文章，同样是介绍 Python 的导入机制，和上面的文章一起食用更佳。

本文呢，将简单讲述一下 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_) :

<span class="hljs-keyword">import sys

<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">MetaPathFinder:

    <span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">find_module<span class="hljs-params">(self, fullname, path=None):
        print(<span class="hljs-string">"find_module {}".format(fullname))
        <span class="hljs-keyword">return MetaPathLoader()

<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">MetaPathLoader:

    <span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">load_module<span class="hljs-params">(self, fullname):
        print(<span class="hljs-string">"load_module {}".format(fullname))
        sys.modules[fullname] = sys
        <span class="hljs-keyword">return sys

sys.meta_path.insert(<span class="hljs-number">0, MetaPathFinder())

<span class="hljs-keyword">if __name__ == <span class="hljs-string">"__main__":
    <span class="hljs-keyword">import http
    print(http)
    print(http.version_info)
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

www#gaodaima.com来源gao!%daima.com搞$代*!码网搞代码

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

<span class="hljs-variable">$ python meta_path1.py
find_module http
load_module http
<<span class="hljs-keyword">module <span class="hljs-string">"sys" (built-<span class="hljs-keyword">in)>
sys.version_info(major=<span class="hljs-number">3, minor=<span class="hljs-number">5, micro=<span class="hljs-number">1, releaselevel=<span class="hljs-string">"final", serial=<span class="hljs-number">0)
</span></span></span></span></span></span></span></span></span>

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

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

<span class="hljs-keyword">import functools
<span class="hljs-keyword">import time

<span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">func_wrapper<span class="hljs-params">(func):
<span class="hljs-meta">    @functools.wraps(func)
    <span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">wrapper<span class="hljs-params">(*args, **kwargs):
        print(<span class="hljs-string">"start func")
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(<span class="hljs-string">"spent {}s".format(end - start))
        <span class="hljs-keyword">return result
    <span class="hljs-keyword">return wrapper

<span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">sleep<span class="hljs-params">(n):
    time.sleep(n)
    <span class="hljs-keyword">return n

<span class="hljs-keyword">if __name__ == <span class="hljs-string">"__main__":
    func = func_wrapper(sleep)
    print(func(<span class="hljs-number">3))
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

执行结果:

$ <span class="hljs-keyword">python func_wrapper.<span class="hljs-keyword">py
start func
spent <span class="hljs-number">3.004966974258423s
<span class="hljs-number">3
</span></span></span></span>

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

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

<span class="hljs-keyword">import time

<span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">sleep<span class="hljs-params">(n):
    time.sleep(n)
    <span class="hljs-keyword">return n
</span></span></span></span></span></span>

我们的 import hook 是 hook.py:

<span class="hljs-keyword">import functools
<span class="hljs-keyword">import importlib
<span class="hljs-keyword">import sys
<span class="hljs-keyword">import time

_hook_modules = {<span class="hljs-string">"hello"}

<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">MetaPathFinder:

    <span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">find_module<span class="hljs-params">(self, fullname, path=None):
        print(<span class="hljs-string">"find_module {}".format(fullname))
        <span class="hljs-keyword">if fullname <span class="hljs-keyword">in _hook_modules:
            <span class="hljs-keyword">return MetaPathLoader()

<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">MetaPathLoader:

    <span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">load_module<span class="hljs-params">(self, fullname):
        print(<span class="hljs-string">"load_module {}".format(fullname))
        <span class="hljs-comment"># ``sys.modules`` 中保存的是已经导入过的 module
        <span class="hljs-keyword">if fullname <span class="hljs-keyword">in sys.modules:
            <span class="hljs-keyword">return sys.modules[fullname]

        <span class="hljs-comment"># 先从 sys.meta_path 中删除自定义的 finder
        <span class="hljs-comment"># 防止下面执行 import_module 的时候再次触发此 finder
        <span class="hljs-comment"># 从而出现递归调用的问题
        finder = sys.meta_path.pop(<span class="hljs-number">0)
        <span class="hljs-comment"># 导入 module
        module = importlib.import_module(fullname)

        module_hook(fullname, module)

        sys.meta_path.insert(<span class="hljs-number">0, finder)
        <span class="hljs-keyword">return module

sys.meta_path.insert(<span class="hljs-number">0, MetaPathFinder())

<span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">module_hook<span class="hljs-params">(fullname, module):
    <span class="hljs-keyword">if fullname == <span class="hljs-string">"hello":
        module.sleep = func_wrapper(module.sleep)

<span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">func_wrapper<span class="hljs-params">(func):
<span class="hljs-meta">    @functools.wraps(func)
    <span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">wrapper<span class="hljs-params">(*args, **kwargs):
        print(<span class="hljs-string">"start func")
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(<span class="hljs-string">"spent {}s".format(end - start))
        <span class="hljs-keyword">return result
    <span class="hljs-keyword">return wrapper
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

测试代码:

<span class="hljs-meta">>>> import hook
<span class="hljs-meta">>>> import hello
find_module hello
load_module hello
<span class="hljs-meta">>>>
>>> hello.sleep(<span class="hljs-number">3)
start func
spent <span class="hljs-number">3.0029919147491455s
<span class="hljs-number">3
<span class="hljs-meta">>>>
</span></span></span></span></span></span></span>

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

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

sitecustomize.py

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

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

$ tree
.
├── sitecustomize.<span class="hljs-keyword">py
└── usercustomize.<span class="hljs-keyword">py
</span></span>

sitecustomize.py:

$ <span class="hljs-keyword">cat sitecustomize.<span class="hljs-keyword">py
<span class="hljs-keyword">print(<span class="hljs-string">"this is sitecustomize")
</span></span></span></span>

usercustomize.py:

$ <span class="hljs-keyword">cat usercustomize.<span class="hljs-keyword">py
<span class="hljs-keyword">print(<span class="hljs-string">"this is usercustomize")
</span></span></span></span>

把当前目录加到 PYTHONPATH 中，然后看看效果:

$ <span class="hljs-keyword">export PYTHONPATH=.
$ python
<span class="hljs-keyword">this <span class="hljs-keyword">is sitecustomize       <----
<span class="hljs-keyword">this <span class="hljs-keyword">is usercustomize       <----
Python <span class="hljs-number">3.5.<span class="hljs-number">1 (<span class="hljs-keyword">default, Dec <span class="hljs-number">24 <span class="hljs-number">2015, <span class="hljs-number">17:<span class="hljs-number">20:<span class="hljs-number">27)
[GCC <span class="hljs-number">4.2.<span class="hljs-number">1 Compatible Apple LLVM <span class="hljs-number">7.0.<span class="hljs-number">2 (clang-<span class="hljs-number">700.1.<span class="hljs-number">81)] <span class="hljs-literal">on darwin
Type <span class="hljs-string">"help", <span class="hljs-string">"copyright", <span class="hljs-string">"credits" <span class="hljs-keyword">or <span class="hljs-string">"license" <span class="hljs-keyword">for more information.
>>>
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

可以看到确实自动导入了。所以我们可以把之前的探测程序改为支持自动执行 import hook (代码可以从 github 上下载 part5) 。

目录结构:

$ tree
.
├── hello.<span class="hljs-keyword">py
├── hook.<span class="hljs-keyword">py
├── sitecustomize.<span class="hljs-keyword">py
</span></span></span>

sitecustomize.py:

$ <span class="hljs-keyword">cat sitecustomize.<span class="hljs-keyword">py
import hook
</span></span>

结果:

$ export PYTHONPATH=.
$ python
find_module usercustomize
Python <span class="hljs-number">3.5.<span class="hljs-number">1 (default, Dec <span class="hljs-number">24 <span class="hljs-number">2015, <span class="hljs-number">17<span class="hljs-symbol">:<span class="hljs-number">20<span class="hljs-symbol">:<span class="hljs-number">27)
[GCC <span class="hljs-number">4.2.<span class="hljs-number">1 Compatible Apple LLVM <span class="hljs-number">7.0.<span class="hljs-number">2 (clang-<span class="hljs-number">700.1.<span class="hljs-number">81)] on darwin
Type <span class="hljs-string">"help", <span class="hljs-string">"copyright", <span class="hljs-string">"credits" <span class="hljs-keyword">or <span class="hljs-string">"license" <span class="hljs-keyword">for more information.
find_module readline
find_module atexit
find_module rlcompleter
<span class="hljs-meta">>>>
>>> import hello
find_module hello
load_module hello
<span class="hljs-meta">>>>
>>> hello.sleep(<span class="hljs-number">3)
start func
spent <span class="hljs-number">3.005002021789551s
<span class="hljs-number">3
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

不过上面的探测程序其实还有一个问题，那就是需要手动修改 PYTHONPATH 。用过探针程序的朋友应该会记得，使用 newrelic 之类的探针只需要执行一条命令就可以了： newrelic-admin run-program python hello.py 实际上修改 PYTHONPATH 的操作是在 newrelic-admin 这个程序里完成的。

下面我们也要来实现一个类似的命令行程序，就叫 agent.py 吧。

agent

还是在上一个程序的基础上修改。先调整一个目录结构，把 hook 操作放到一个单独的目录下，方便设置 PYTHONPATH 后不会有其他的干扰（代码可以从 github 上下载 part6 ）。

$ <span class="hljs-built_in">mkdir bootstrap
$ mv hook.<span class="hljs-keyword">py bootstrap/_hook.<span class="hljs-keyword">py
$ touch bootstrap/__init__.<span class="hljs-keyword">py
$ touch agent.<span class="hljs-keyword">py
$ tree
.
├── bootstrap
│   ├── __init__.<span class="hljs-keyword">py
│   ├── _hook.<span class="hljs-keyword">py
│   └── sitecustomize.<span class="hljs-keyword">py
├── hello.<span class="hljs-keyword">py
├── test.<span class="hljs-keyword">py
├── agent.<span class="hljs-keyword">py
</span></span></span></span></span></span></span></span></span></span></span>

bootstrap/sitecustomize.py 的内容修改为:

$ <span class="hljs-keyword">cat bootstrap/sitecustomize.<span class="hljs-keyword">py
import _hook
</span></span>

agent.py 的内容如下:

<span class="hljs-keyword">import os
<span class="hljs-keyword">import sys

current_dir = os.path.dirname(os.path.realpath(__file__))
boot_dir = os.path.join(current_dir, <span class="hljs-string">"bootstrap")

<span class="hljs-function"><span class="hljs-keyword">def <span class="hljs-title">main<span class="hljs-params">():
    args = sys.argv[<span class="hljs-number">1:]
    os.environ[<span class="hljs-string">"PYTHONPATH"] = boot_dir
    <span class="hljs-comment"># 执行后面的 python 程序命令
    <span class="hljs-comment"># sys.executable 是 python 解释器程序的绝对路径 ``which python``
    <span class="hljs-comment"># >>> sys.executable
    <span class="hljs-comment"># "/usr/local/var/pyenv/versions/3.5.1/bin/python3.5"
    os.execl(sys.executable, sys.executable, *args)

<span class="hljs-keyword">if __name__ == <span class="hljs-string">"__main__":
    main()
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

test.py 的内容为:

$ <span class="hljs-keyword">cat test.<span class="hljs-keyword">py
import sys
import hello

<span class="hljs-keyword">print(sys.<span class="hljs-built_in">argv)
<span class="hljs-keyword">print(hello.<span class="hljs-keyword">sleep(<span class="hljs-number">3))
</span></span></span></span></span></span></span>

使用方法:

$ <span class="hljs-keyword">python agent.<span class="hljs-keyword">py test.<span class="hljs-keyword">py arg1 arg2
find_module usercustomize
find_module hello
load_module hello
[<span class="hljs-string">"test.py", <span class="hljs-string">"arg1", <span class="hljs-string">"arg2"]
start func
spent <span class="hljs-number">3.005035161972046s
<span class="hljs-number">3
</span></span></span></span></span></span></span></span>

至此，我们就实现了一个简单的 python 探针程序。当然，跟实际使用的探针程序相比肯定是有很大的差距的，这篇文章主要是讲解一下探针背后的实现原理。

搞代码网（gaodaima.com）提供的所有资源部分来自互联网，如果有侵犯您的版权或其他权益，请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected]‍，我们会在看到邮件的第一时间内为您处理，或直接联系QQ：872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接：非常干货：Python 探针实现原理

sys.meta_path

sitecustomize.py

agent

Hi，您需要填写昵称和邮箱！