pycallgraph 追踪Python函数内部调用

简介: 安装安装pycallgraph安装依赖使用待测脚本追踪脚本追踪结果高级篇隐藏私密函数控制最大追踪深度总结GitHub上好代码真的是太多了,名副其实的一个宝藏。

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()

控制深度输出

总结

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

目录
相关文章
|
20天前
|
Python
【python从入门到精通】-- 第五战:函数大总结
【python从入门到精通】-- 第五战:函数大总结
56 0
|
17天前
|
Python
Python之函数详解
【10月更文挑战第12天】
Python之函数详解
|
18天前
|
存储 数据安全/隐私保护 索引
|
8天前
|
测试技术 数据安全/隐私保护 Python
探索Python中的装饰器:简化和增强你的函数
【10月更文挑战第24天】在Python编程的海洋中,装饰器是那把可以令你的代码更简洁、更强大的魔法棒。它们不仅能够扩展函数的功能,还能保持代码的整洁性。本文将带你深入了解装饰器的概念、实现方式以及如何通过它们来提升你的代码质量。让我们一起揭开装饰器的神秘面纱,学习如何用它们来打造更加优雅和高效的代码。
|
9天前
|
弹性计算 安全 数据处理
Python高手秘籍:列表推导式与Lambda函数的高效应用
列表推导式和Lambda函数是Python中强大的工具。列表推导式允许在一行代码中生成新列表,而Lambda函数则是用于简单操作的匿名函数。通过示例展示了如何使用这些工具进行数据处理和功能实现,包括生成偶数平方、展平二维列表、按长度排序单词等。这些工具在Python编程中具有高度的灵活性和实用性。
|
12天前
|
Python
python的时间操作time-函数介绍
【10月更文挑战第19天】 python模块time的函数使用介绍和使用。
18 4
|
14天前
|
存储 Python
[oeasy]python038_ range函数_大小写字母的起止范围_start_stop
本文介绍了Python中`range`函数的使用方法及其在生成大小写字母序号范围时的应用。通过示例展示了如何利用`range`和`for`循环输出指定范围内的数字,重点讲解了小写和大写字母对应的ASCII码值范围,并解释了`range`函数的参数(start, stop)以及为何不包括stop值的原因。最后,文章留下了关于为何`range`不包含stop值的问题,留待下一次讨论。
13 1
|
19天前
|
索引 Python
Python中的其他内置函数有哪些
【10月更文挑战第12天】Python中的其他内置函数有哪些
13 1
|
1月前
|
数据处理 Python
深入探索:Python中的并发编程新纪元——协程与异步函数解析
深入探索:Python中的并发编程新纪元——协程与异步函数解析
25 3
|
1月前
|
机器学习/深度学习 算法 C语言
【Python】Math--数学函数(详细附解析~)
【Python】Math--数学函数(详细附解析~)