Python中探針的實現原理是什么

這篇文章將為大家詳細講解有關Python中探針的實現原理是什么，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。

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 sysclass 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 syssys.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_path2.pyfind_module httpload_module http<module 'sys' (built-in)>sys.version_info(major=3, minor=5, micro=1, releaselevel='final', serial=0)

通過 sys.meta_path 我們就可以實現 import hook 的功能：當 import 預定的 module 時，對這個 module 里的對象來個貍貓換太子， 從而實現獲取函數或方法的執行時間等探測信息。上面說到了貍貓換太子，那么怎么對一個對象進行貍貓換太子的操作呢？對于函數對象，我們可以使用裝飾器的方式來替換函數對象(代碼可以從 github 上下載 part2) :

import functoolsimport timedef 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 wrapperdef sleep(n):    time.sleep(n)    return nif __name__ == '__main__':    func = func_wrapper(sleep)    print(func(3))

執行結果:

$ python func_wrapper.pystart funcspent 3.004966974258423s3

下面我們來實現一個計算指定模塊的指定函數的執行時間的功能(代碼可以從 github 上下載 part3) 。假設我們的模塊文件是 hello.py:

import timedef sleep(n):    time.sleep(n)    return n

我們的 import hook 是 hook.py:

import functoolsimport importlibimport sysimport 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 modulesys.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 hellofind_module helloload_module hello>>>>>> hello.sleep(3)start funcspent 3.0029919147491455s3>>>

其實上面的代碼已經實現了探針的基本功能。不過有一個問題就是上面的代碼需要顯示的 執行 import hook 操作才會注冊上我們定義的 hook。那么有沒有辦法在啟動 python 解釋器的時候自動執行 import hook 的操作呢？答案就是可以通過定義 sitecustomize.py 的方式來實現這個功能。

sitecustomize.py

簡單的說就是，python 解釋器初始化的時候會自動 import PYTHONPATH 下存在的 sitecustomize 和 usercustomize 模塊:實驗項目的目錄結構如下(代碼可以從 github 上下載 part4) :

$ tree.├── sitecustomize.py└── usercustomize.py

sitecustomize.py:

$ cat sitecustomize.pyprint('this is sitecustomize')

usercustomize.py:

$ cat usercustomize.pyprint('this is usercustomize')

把當前目錄加到 PYTHONPATH 中，然后看看效果:

$ export PYTHONPATH=.$ pythonthis is sitecustomize       <----this is usercustomize       <----Python 3.5.1 (default, Dec 24 2015, 17:20:27)[GCC 4.2.1 Compatible Apple LLVM 7.0.2 (clang-700.1.81)] on darwinType "help", "copyright", "credits" or "license" for more information.>>>

可以看到確實自動導入了。所以我們可以把之前的探測程序改為支持自動執行 import hook (代碼可以從 github 上下載 part5) 。目錄結構:

$ tree.├── hello.py├── hook.py├── sitecustomize.py

sitecustomize.py:

$ cat sitecustomize.pyimport hook

結果:

$ export PYTHONPATH=.$ pythonfind_module usercustomizePython 3.5.1 (default, Dec 24 2015, 17:20:27)[GCC 4.2.1 Compatible Apple LLVM 7.0.2 (clang-700.1.81)] on darwinType "help", "copyright", "credits" or "license" for more information.find_module readlinefind_module atexitfind_module rlcompleter>>>>>> import hellofind_module helloload_module hello>>>>>> hello.sleep(3)start funcspent 3.005002021789551s3

不過上面的探測程序其實還有一個問題，那就是需要手動修改 PYTHONPATH 。用過探針程序的朋友應該會記得， 使用 newrelic 之類的探針只需要執行一條命令就 可以了：newrelic-admin run-program python hello.py 實際上修改 PYTHONPATH 的操作是在newrelic-admin 這個程序里完成的。下面我們也要來實現一個類似的命令行程序，就叫 agent.py 吧。

agent

還是在上一個程序的基礎上修改。先調整一個目錄結構，把 hook 操作放到一個單獨的目錄下， 方便設置 PYTHONPATH 后不會有其他的干擾（代碼可以從 github 上下載 part6 ）。

$ mkdir bootstrap$ mv hook.py bootstrap/_hook.py$ touch bootstrap/__init__.py$ touch agent.py$ tree.├── bootstrap│   ├── __init__.py│   ├── _hook.py│   └── sitecustomize.py├── hello.py├── test.py├── agent.py

bootstrap/sitecustomize.py 的內容修改為:

$ cat bootstrap/sitecustomize.pyimport _hook

agent.py 的內容如下:

import osimport syscurrent_dir = os.path.dirname(os.path.realpath(__file__))boot_dir = os.path.join(current_dir, 'bootstrap')def main():    args = sys.argv[1:]    os.environ['PYTHONPATH'] = boot_dir    # 執行后面的 python 程序命令    # sys.executable 是 python 解釋器程序的絕對路徑 ``which python``    # >>> sys.executable    # '/usr/local/var/pyenv/versions/3.5.1/bin/python3.5'    os.execl(sys.executable, sys.executable, *args)if __name__ == '__main__':    main()

test.py 的內容為:

$ cat test.pyimport sysimport helloprint(sys.argv)print(hello.sleep(3))

使用方法:

$ python agent.py test.py arg1 arg2find_module usercustomizefind_module helloload_module hello['test.py', 'arg1', 'arg2']start funcspent 3.005035161972046s3

關于Python中探針的實現原理是什么就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。