Python自动绘制UML图、函数调用图（Call Graph）

widuu 发布于2021-10-14 09:43 / 4340人阅读

摘要：借助，自动提取代码的动态调用流程图。绘制类图安装是一个开源图形可视化软件。循环曲线表示递归过程调用。绘制的常用工具有静态调用图等。包括模块之间的调用流程函数调用次数及耗时等。

文章目录

1. 引言

在设计软件、分析代码时，我们常常会借助UML以及函数调用图，来帮自己梳理思路。

尤其是遇到bug时，借助这些可视化手段，也可以帮你在调试过程中发现逻辑错误。

本文主要介绍以下两个方法：

借助graphviz+pyreverse，自动提取python代码的UML类图和包依赖关系。
借助graphviz+pycallgraph，自动提取python代码的动态调用流程图。

2. 绘制UML类图

2.1 安装graphviz

Graphviz 是一个开源图形可视化软件。

Graphviz 以简单的文本语言对图形进行描述，并以多种有用的格式制作图表，例如用于网页的图像和 SVG，用于包含在 PDF 或其他文档中的 Postscript；或显示在交互式图形浏览器中。

步骤①：从官网下载graphviz软件

官网下载：http://www.graphviz.org/download/

下载exe安装包，完成graphviz软件安装，并找到bin路径。

步骤②：设置环境变量

步骤③：安装对应python库

$ conda install python-graphviz

2.2 安装pyreverse

pyreverse是一组用于对 Python 代码进行逆向工程的实用程序。

可以分析Python代码并提取 UML 类图和包依赖关系¹：

类属性，及其类型
类方法
类之间的继承链接
类之间的关联链接
异常和接口的表示

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即可。

2.3 绘制UML类图

UML类图常用于面向对象的建模中，UML类图的每个方框是一个对象类，每个框从上到下分为三部分，第一部分是对象类名称，第二部分是类的属性，第三部分是类的函数。

在命令行输入语句，生成package的UML图：

$ pyreverse -o png -p Pyreverse pylint/pyreverse/[...]creating diagram packages_Pyreverse.pngcreating diagram classes_Pyreverse.png

-o :设置保存图像的格式，如png
-p Name: 输出图形以packages_Name.png为名称保存

3. 绘制函数调用图

函数调用图（Call Graph）是一个控制流程图，用于表示程序中各个单元之间的调用关系。每个节点之间的边缘表示调用过程。循环曲线表示递归过程调用。²

绘制Call Graph的常用工具有：pycallgraph、pyan（静态调用图）、gprof2dot 、code2flow等。本文主要介绍pycallgraph的用法。

pycallgraph是一个python模块，可以对python代码进行动态调用图分析³。包括模块之间的调用流程、函数调用次数及耗时等。

3.1 安装graphviz

同2.1节。

步骤①：从官网下载graphviz软件

官网下载：http://www.graphviz.org/download/

下载exe安装包，完成graphviz软件安装，并找到bin路径。

步骤②：设置环境变量

步骤③：安装对应python库

$ pip install graphviz

3.2 安装pycallgraph

安装pycallgraph：

$ pip install pycallgraph

3.3 使用示例

第一种：从命令行调用

$ pycallgraph graphviz -- ./mypythonscript.py

第二种：从API调用

最简单的例子，直接在要分析的函数调用前，加上with PyCallGraph(output=GraphvizOutput()):：

from pycallgraph import PyCallGraphfrom pycallgraph.output import GraphvizOutputwith PyCallGraph(output=GraphvizOutput()):	# 调用你要分析的函数    code_to_profile()

如果需要指定调用图中包含（include）哪些函数、排除（exclude）哪些函数，就要用到GlobbingFilter(include=[....])、GlobbingFilter(exclude=[....])，例如这样⁴：

from pycallgraph import PyCallGraphfrom pycallgraph.output import GraphvizOutputfrom pycallgraph import Configfrom pycallgraph import GlobbingFilterdef 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 ↩︎

超融合服务器私有云 java绘制函数图 python绘制图 uml图 uml活动图

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/122568.html

Tensorflow代码解析（四）

摘要：联合查找算法是并查集数据结构一种应用。并查集是一种树型的数据结构，其保持着用于处理一些不相交集合的合并及查询问题。的特征是删除节点。目前就职于腾讯事业部，从事神经机器翻译工作。 5. TF - Graph模块TF把神经网络模型表达成一张拓扑结构的Graph，Graph中的一个节点表示一种计算算子。Graph从输入到输出的Tensor数据流动完成了一个运算过程，这是对类似概率图、神经网络等连接...

马龙驹 2019-04-25 18:10 评论0 收藏0
Tensorflow代码解析（一）

摘要：本文依据对简称白皮书和官方教程的理解，从系统和代码实现角度讲解的内部实现原理。这一点是和包括在内的符号编程框架较大的不同。的做法是引入了来处理。这样就几乎让本身成为一门独立的语言。当为是，执行操作当为时，执行操作。支持的控制算子有和等。摘要2015年11月9日，Google发布深度学习框架TensorFlow并宣布开源，并迅速得到广泛关注，在图形分类、音频处理、推荐系统和自然语言处理等场景...

李世赞 2019-04-25 18:09 评论0 收藏0
用 Matplotlib 库生成动画图表

摘要：相对于静态图表，人类总是容易被动画和交互式图表所吸引。可以使用轻松生成图表直方图功率谱，条形图，错误图表，散点图等。然而，也有一些方面落后于同类的库。动画使用一组固定的对象。稍后将用数据对行对象进行填充。现在用将它们转换为动画。翻译：疯狂的技术宅https://towardsdatascience.co... showImg(https://segmentfault.com/img...

call_me_R 2019-07-31 10:20 评论0 收藏0
用 Matplotlib 库生成动画图表

摘要：相对于静态图表，人类总是容易被动画和交互式图表所吸引。可以使用轻松生成图表直方图功率谱，条形图，错误图表，散点图等。然而，也有一些方面落后于同类的库。动画使用一组固定的对象。稍后将用数据对行对象进行填充。现在用将它们转换为动画。翻译：疯狂的技术宅https://towardsdatascience.co... showImg(https://segmentfault.com/img...

不知名网友 2019-06-26 18:54 评论0 收藏0
C++源码调用图生成器实现

摘要：前言之前受知乎用户启发，写了个源码的调用图生成器，可以以图示法显示函数的调用关系，代码放在了仓库里，仅供参考主要思路利用的的注入选项，得到每个函数的调用地址信息，生成一个文件，然后利用和将函数名及其所在源码位置从地址中解析出来，从而得到前言之前受知乎用户mailto1587启发，写了个C++源码的调用图生成器，可以以图示法显示C++函数的调用关系，代码放在了github仓库里，仅供...

oysun 2019-07-25 11:27 评论0 收藏0