在设计软件、分析代码时,我们常常会借助UML以及函数调用图,来帮自己梳理思路。
尤其是遇到bug时,借助这些可视化手段,也可以帮你在调试过程中发现逻辑错误。
本文主要介绍以下两个方法:
借助graphviz+pyreverse,自动提取python代码的UML类图和包依赖关系。
借助graphviz+pycallgraph,自动提取python代码的动态调用流程图。
Graphviz 是一个开源图形可视化软件。
Graphviz 以简单的文本语言对图形进行描述,并以多种有用的格式制作图表,例如用于网页的图像和 SVG,用于包含在 PDF 或其他文档中的 Postscript;或显示在交互式图形浏览器中。
步骤①:从官网下载graphviz软件
官网下载:http://www.graphviz.org/download/
下载exe安装包,完成graphviz软件安装,并找到bin路径。
步骤②:设置环境变量
$ conda install python-graphviz
pyreverse是一组用于对 Python 代码进行逆向工程的实用程序。
可以分析Python代码并提取 UML 类图和包依赖关系1:
Pyreverse 现在已集成到 pylint 中:http://pypi.python.org/pypi/pylint/
安装pylint:
$ pip install pylint
注意:pip install pyreverse时,会发现已经找不到这个库了:ERROR: Could not find a version that satisfies the requirement pyreverse
,不过pylint中已经包含了pyreverse,所以直接安装pylint即可。
UML类图常用于面向对象的建模中,UML类图的每个方框是一个对象类,每个框从上到下分为三部分,第一部分是对象类名称,第二部分是类的属性,第三部分是类的函数。
在命令行输入语句,生成package的UML图:
$ pyreverse -o png -p Pyreverse pylint/pyreverse/
[...]
creating diagram packages_Pyreverse.png
creating diagram classes_Pyreverse.png
函数调用图(Call Graph)是一个控制流程图,用于表示程序中各个单元之间的调用关系。每个节点之间的边缘表示调用过程。循环曲线表示递归过程调用。2
绘制Call Graph的常用工具有:pycallgraph、pyan(静态调用图)、gprof2dot 、code2flow等。本文主要介绍pycallgraph的用法。
pycallgraph是一个python模块,可以对python代码进行动态调用图分析3。包括模块之间的调用流程、函数调用次数及耗时等。
同2.1节。
步骤①:从官网下载graphviz软件
官网下载:http://www.graphviz.org/download/
下载exe安装包,完成graphviz软件安装,并找到bin路径。
步骤②:设置环境变量
$ pip install graphviz
安装pycallgraph:
$ pip install pycallgraph
$ pycallgraph graphviz -- ./mypythonscript.py
最简单的例子,直接在要分析的函数调用前,加上with PyCallGraph(output=GraphvizOutput()):
:
from pycallgraph import PyCallGraph
from pycallgraph.output import GraphvizOutput
with PyCallGraph(output=GraphvizOutput()):
# 调用你要分析的函数
code_to_profile()
如果需要指定调用图中包含(include)哪些函数、排除(exclude)哪些函数,就要用到GlobbingFilter(include=[....])
、GlobbingFilter(exclude=[....])
,例如这样4:
from pycallgraph import PyCallGraph
from pycallgraph.output import GraphvizOutput
from pycallgraph import Config
from pycallgraph import GlobbingFilter
def main():
# TODO: 调用各种类、函数
return
if __name__ == "__main__":
config = Config()
# 调用图中包括(include)哪些函数
# 用moduleName.*表示,包含某个模块内的所有函数
config.trace_filter = GlobbingFilter(include=[
'main',
'app.*',
'widgets.list_widget.*',
'utils.RegionInfo.*'
])
# 调用图中不包括(exclude)哪些函数
# config.trace_filter = GlobbingFilter(exclude=[
# 'moduleA.*',
# 'moduleB.*',
# '*.funcB'
# ])
graphviz = GraphvizOutput()
graphviz.output_file = 'graph.png'
with PyCallGraph(output=graphviz, config=config):
main()
在程序正常运行完之后,就会在当前路径生成graph.png文件。
越是复杂的程序,生成的调用图就会越大,注意选取你最关注的函数进行可视化。
其他高级用法可以参考:
官方文档:https://pycallgraph.readthedocs.io/en/master/
本文介绍了两个python代码可视化工具:
借助graphviz+pyreverse,可以自动提取python代码的UML类图。
借助graphviz+pycallgraph,可以自动提取python代码的动态调用图。
如果对你有帮助的话,欢迎一键三连支持下博主。
https://www.logilab.org/blogentry/6883 ↩︎
https://encyclopedia.thefreedictionary.com/Call+graph ↩︎
https://zhuanlan.zhihu.com/p/108481835 ↩︎
https://blog.csdn.net/qq_37177765/article/details/95886071 ↩︎