pycallgraph 追踪Python函数内部调用

2021-12-05 23:51:42

GitHub上好代码真的是太多了，名副其实的一个宝藏。但是最近自己也反思了一下，为什么别人的代码看起来那么的费劲。很多时候还不得要领，博主的笨方法就是先看下代码的结构，目录。然后就从程序的入口出发了，一步步的往底层去追溯，但是因为忒懒，也没有超大的临时记忆空间，于是代码跟着跟着就跑偏了，这也是看别人代码的时候效率不高的主要原因。

幸运的是，发现了一款神器，pycallgraph，其作用就是追踪函数的相互调用的情况，如此一来，对每个函数的的追踪将一览无余。

安装

安装这个库是比较简单的，但是安装好了是不能用的。

因为还需要一个图形库的依赖（graphviz）, 这个依赖是著名的贝尔实验室的一位大牛写的一个命令行下的作图工具库。超赞。

安装pycallgraph

pip install pycallgraph

安装依赖

graphviz2.38 画图库下载链接为：

http://www.softpedia.com/dyn-postdownload.php/adf89304319dca207ef04cd94d39e586/57ff4c63/1e6eb/4/1?tsf=0

下载完之后，为了不出现之前的那个command命令实效。我们还得将graphviz的path添加到电脑的系统变量中。

具体做法：

系统属性->高级设置->环境变量->path->记得环境变量之间用英文的；号分隔开

使用

配置好了上面的步骤之后，就可以正式的使用pycallgraph咯。为了方便演示,这里写了一段简单的脚本。

待测脚本

# downloadmusic.py
# 之前适用于下载QQ音乐的，这里的作用就是下载一张图片

import urllib2
import threading

def download(url, path):
    data = urllib2.urlopen(url).read()
    open(path, 'wb').write(data)
    print "success!"

然后我们就可以使用pycallgraph来完成简单的追踪过程了。

追踪脚本

# 追踪代码
# coding: utf8
from pycallgraph import PyCallGraph
from pycallgraph import Config
from pycallgraph.output import GraphvizOutput

from downloadmusic import *

graphviz = GraphvizOutput(output_file=r'./trace_detail.png')
with PyCallGraph(output=graphviz):
    download('http://www.baidu.com/img/bd_logo1.png', r'./baidu.png')

追踪结果

运行完脚本后，此文件夹中的细节如下：

F:\temp\downloadmusic>tree /F
卷 娱乐 的文件夹 PATH 列表
卷序列号为 0000-4823
F:.
    baidu.png
    calldetails.py
    downloadmusic.py
    downloadmusic.pyc
    trace_detail.png

没有子文件夹

在成功的下载了一张百度的logo照片之后，我们不难发现，多了一个叫trace_detail.png 的文件。

如下：

是不是感觉还不赖呢？函数之间的依赖关系，调用情况都可以得到很好的追溯。

高级篇

所谓高级，就是附加了点小情况而已。无非加个过滤条件，控制一下函数调用的追踪深度。

隐藏私密函数

如题，隐藏那些不想看到的函数的名称，这一点在某些情况下还是很好用的。

rom pycallgraph import PyCallGraph
from pycallgraph import Config
from pycallgraph import GlobbingFilter
from pycallgraph.output import GraphvizOutput

from banana import Banana

config = Config()
config.trace_filter = GlobbingFilter(exclude=[
    'pycallgraph.*',
    '*.secret_function',
])

graphviz = GraphvizOutput(output_file='filter_exclude.png')

with PyCallGraph(output=graphviz, config=config):
    banana = Banana()
    banana.eat()

控制最大追踪深度

这一点也很好理解了吧，待会看完图就更加清晰了。

from pycallgraph import PyCallGraph
from pycallgraph import Config
from pycallgraph.output import GraphvizOutput

from banana import Banana

config = Config(max_depth=1)
graphviz = GraphvizOutput(output_file='filter_max_depth.png')

with PyCallGraph(output=graphviz, config=config):
    banana = Banana()
    banana.eat()

总结

这次的文章没什么技术含量，但是确实很实用的一篇介绍性的文章。下次读代码遇到瓶颈的时候，不妨来尝试一把这个工具。相信会让你眼前一亮的。

码农公寓

安装