pycallgraph 追踪Python函数内部调用

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

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

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


安装

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

这里写链接内容

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

安装pycallgraph

pip install pycallgraph

安装依赖

graphviz2.38

下载完之后,为了不出现之前的那个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()

控制深度输出

总结

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

目录
相关文章
|
3月前
|
Python
【python从入门到精通】-- 第五战:函数大总结
【python从入门到精通】-- 第五战:函数大总结
105 0
|
2月前
|
搜索推荐 Python
利用Python内置函数实现的冒泡排序算法
在上述代码中,`bubble_sort` 函数接受一个列表 `arr` 作为输入。通过两层循环,外层循环控制排序的轮数,内层循环用于比较相邻的元素并进行交换。如果前一个元素大于后一个元素,就将它们交换位置。
146 67
|
4天前
|
Python
[oeasy]python057_如何删除print函数_dunder_builtins_系统内建模块
本文介绍了如何删除Python中的`print`函数,并探讨了系统内建模块`__builtins__`的作用。主要内容包括: 1. **回忆上次内容**:上次提到使用下划线避免命名冲突。 2. **双下划线变量**:解释了双下划线(如`__name__`、`__doc__`、`__builtins__`)是系统定义的标识符,具有特殊含义。
18 3
|
8天前
|
JSON 监控 安全
深入理解 Python 的 eval() 函数与空全局字典 {}
`eval()` 函数在 Python 中能将字符串解析为代码并执行,但伴随安全风险,尤其在处理不受信任的输入时。传递空全局字典 {} 可限制其访问内置对象,但仍存隐患。建议通过限制函数和变量、使用沙箱环境、避免复杂表达式、验证输入等提高安全性。更推荐使用 `ast.literal_eval()`、自定义解析器或 JSON 解析等替代方案,以确保代码安全性和可靠性。
22 2
|
1月前
|
Python
Python中的函数是**一种命名的代码块,用于执行特定任务或计算
Python中的函数是**一种命名的代码块,用于执行特定任务或计算
50 18
|
26天前
|
数据可视化 DataX Python
Seaborn 教程-绘图函数
Seaborn 教程-绘图函数
56 8
|
1月前
|
Python
Python中的函数
Python中的函数
45 8
|
2月前
|
监控 测试技术 数据库
Python中的装饰器:解锁函数增强的魔法####
本文深入探讨了Python语言中一个既强大又灵活的特性——装饰器(Decorator),它以一种优雅的方式实现了函数功能的扩展与增强。不同于传统的代码复用机制,装饰器通过高阶函数的形式,为开发者提供了在不修改原函数源代码的前提下,动态添加新功能的能力。我们将从装饰器的基本概念入手,逐步解析其工作原理,并通过一系列实例展示如何利用装饰器进行日志记录、性能测试、事务处理等常见任务,最终揭示装饰器在提升代码可读性、维护性和功能性方面的独特价值。 ####
|
2月前
|
Python
Python中的`range`函数与负增长
在Python中,`range`函数用于生成整数序列,支持正向和负向增长。本文详细介绍了如何使用`range`生成负增长的整数序列,并提供了多个实际应用示例,如反向遍历列表、生成倒计时和计算递减等差数列的和。通过这些示例,读者可以更好地掌握`range`函数的使用方法。
57 5
|
3月前
|
Python
Python之函数详解
【10月更文挑战第12天】
Python之函数详解