全网最适合入门的面向对象编程教程：13 类和对象的 Python 实现-可视化阅读代码神器 Sourcetrail 的安装使用

全网最适合入门的面向对象编程教程：13 类和对象的 Python 实现-可视化阅读代码神器 Sourcetrail 的安装使用

摘要：

本文主要介绍了可视化阅读代码神器Sourcetrail的安装与使用，包括软件简介和特性、下载地址、安装方式、新建工程和如何查看分析源码，同时简单介绍了PyCharm中Sourcetrail插件的使用。

原文链接：

FreakStudio 的博客

往期推荐：

可能是全网最适合入门的面向对象编程教程：Python实现-嵌入式爱好者必看！

全网最适合入门的面向对象编程教程：00 面向对象设计方法导论

全网最适合入门的面向对象编程教程：01 面向对象编程的基本概念

全网最适合入门的面向对象编程教程：02 类和对象的Python实现-使用Python创建类

全网最适合入门的面向对象编程教程：03 类和对象的Python实现-为自定义类添加属性

全网最适合入门的面向对象编程教程：04 类和对象的 Python 实现-为自定义类添加方法

全网最适合入门的面向对象编程教程：05 类和对象的Python实现-PyCharm代码标签

全网最适合入门的面向对象编程教程：06 类和对象的 Python 实现-自定义类的数据封装

全网最适合入门的面向对象编程教程：07 类和对象的Python实现-类型注解

全网最适合入门的面向对象编程教程：08 类和对象的 Python 实现-@property 装饰器

全网最适合入门的面向对象编程教程：09 类和对象的Python实现-类之间的关系

全网最适合入门的面向对象编程教程：10 类和对象的Python实现-类的继承和里氏替换原则

全网最适合入门的面向对象编程教程：11 类和对象的Python实现-子类调用父类方法

全网最适合入门的面向对象编程教程：12 类和对象的 Python 实现-Python 使用 logging 模块输出程序运行日志

更多精彩内容可看：

CM3调试系统简析

肝了半个月，嵌入式技术栈大汇总出炉

比赛获奖的武林秘籍：05 电子计算机类比赛国奖队伍技术如何分工和学习内容

比赛获奖的武林秘籍：04 电子类比赛嵌入式开发快速必看的上手指南

比赛获奖的武林秘籍：03 好的创意选取-获得国奖的最必要前提

比赛获奖的武林秘籍：02 国奖秘籍-大学生电子计算机类竞赛快速上手的流程，小白必看

比赛获奖的武林秘籍：01 如何看待当代大学生竞赛中“卷”“祖传老项目”“找关系”的现象？

比赛获奖的武林秘籍：00 学科竞赛-工科类大学生绕不开的话题，你了解多少？

电子计算机类比赛的“武林秘籍”-电赛光电设计大赛计算机设计大赛嵌入式芯片与系统设计竞赛，你要的都在这里！

文档和代码获取：

可访问如下链接进行对文档下载：

https://github.com/leezisheng/Doc

本文档主要介绍如何使用 Python 进行面向对象编程，需要读者对 Python 语法和单片机开发具有基本了解。相比其他讲解 Python 面向对象编程的博客或书籍而言，本文档更加详细、侧重于嵌入式上位机应用，以上位机和下位机的常见串口数据收发、数据处理、动态图绘制等为应用实例，同时使用 Sourcetrail 代码软件对代码进行可视化阅读便于读者理解。

相关示例代码获取链接如下：https://github.com/leezisheng/Python-OOP-Demo

正文

这里，我们可以使用 Sourcetrail 软件对代码进行可视化阅读。Sourcetrail 是一个免费开源、跨平台的可视化源码探索项目，可以使用图形直观地表示了调用上游和下游，类成员列表等等细节，使得理解源代码的结构变得很容易。下图是我们用 Sourcetrail 分析示例代码得到的图形化类图，可以很容易的看出 SerialClass 和 SensorClass、MasterClass 间的继承关系以及每个类的方法和属性:

关于 Sourcetrail 的下载安装可以查看：

https://github.com/CoatiSoftware/Sourcetrail/releases

我们选择 Sourcetrail_2021_4_19_Windows_64bit_Installer.zip 版本进行下载，下载安装包解压后，可以看到有一个 msi 文件，双击安装即可：

如果安装过程中遇到错误代码 2053 提示，查看以下链接解决：

https://zhuanlan.zhihu.com/p/356008224

接下来我们来看如何用 sourcetrail 分析源代码，打开 sourcetrail 软件，首先点击新建工程：

接着填写项目名称和需要解析文件的地址：

接着点击添加源码组：

选择 Python 文件，创建空的源码分析组，点击 next：

按照下图所示填写信息即可：

这里，使用虚拟环境的同学可以使用 conda env list 获取虚拟环境解释器位置：

配置好后点击创建：

开始创建，注意一定要勾选 shallow python index 选项，点击开始：

这里，可以看到我们的分析结果，Sourcetrail 将解析结果按“文件”、“模块”等大致分了类，可以极大便利我们阅读他人代码的工作。点击 classes：

可以看到我们文件中包含哪些类：

点击 SerialClass 类可以看查看属性和方法，右边有对应源码：

点击任意方法，可以看到该方法的调用情况：

项目中的符号都可以点击，支持来回跳转，还支持模糊搜索。左侧源码结构非常清晰，对于熟悉陌生代码结构非常有用。

我们也可以在 Pycharm 中安装插件 idea-sourcetrail 与其配合使用，sourcetrail 支持跟你喜欢的代码编辑器链接，在编辑器中右键，就能激活 sourcetrail 查看上下可视化内容。当然也可以反过来，在 sourcetrail 中点击，直接可以在编辑器中编辑该文件。

点击安装并应用，重启 IDE。具体使用可以参考：

https://cloud.tencent.com/developer/news/594864

Sourcetrail 还可以与其他编辑器链接，比如： Atom, Clion, Eclipse, Emacs, IntelliJ IDEA 等等。还有更多功能可以参见官方文档：

https://www.sourcetrail.com/python/

实际上这类源码分析工具还有很多，比如 Source Insight 和 Understand。