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

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