使用开源可视化工具来理解你的Python代码
VizTracer 工具可以可视化并跟踪 Python 代码,让你可以更深入地了解其工作原理。
随着 Python 项目变得越来越大、越复杂,理解起它来就变得充满挑战性。即使是你自己独自编写了整个项目,也不可能完全知道项目是如何工作的。为了能更好的理解你的代码,调试和分析代码变得至关重要。
VizTracer 是一个这样的工具,它通过跟踪和可视化 Python 代码的执行过程,来帮助你对代码的理解。无需对源代码进行任何更改,VizTracer 即可记录函数的入口 / 出口,函数参数 / 返回值以及任意变量,然后通过 Trace-Viewer 使用直观的谷歌前端界面来显示数据。
下面是一个运行蒙特卡洛树搜索的例子:
Monte Carlo tree search visualization
每个函数都在时间线上以堆栈的形式记录和可视化,这样你就可以看到在运行程序时发生了什么。你可以放大查看任意特定点的详细信息:
Zooming in on VizTracer visualization
VizTracer 还可以自动记录函数参数和返回值。你可以单击函数条目并查看详细信息:
Viewing VizTracer details
或者你可以创建一个全新的信号,并用它来记录变量。例如,这显示了执行梯度下降时的成本值:
VizTracer gradient descent
与其他设置复杂的工具相比,VizTracer 使用起来非常简单,并且没有任何依赖关系。你可以从 pip 安装它:
pip install viztracer
你也可以通过输入来跟踪你的程序(<your_script.py>
是你脚本的名称):
viztracer <your_script.py>
VizTracer 将在你的工作目录中生成一个 HTML 报告,你可以在 Chrome 浏览器中打开它。
VizTracer 还提供了其他高级功能,比如过滤器功能,你可以使用它过滤掉不想跟踪的函数,获得更清晰的报告。例如,要仅包含文件中的函数,你需要:
viztracer include_files ./ --run <your_script.py>
记录函数参数和返回值:
viztracer --log_function_args --log_return_value <your_script.py>
记录与某个正则表达式匹配的任意变量:
# log variables starts with a viztracer --log_var a.* --run <your_script.py>
你可以通过对源代码进行较小的修改来获得其他功能,例如自定义事件来记录数值和对象。
VizTracer 还包括一个虚拟调试器(vdb),它可以调试 VizTracer 的日志文件。可以用 vdb 调试你运行中的代码(与 pdb 非常相似)以便你了解代码流。有用的是,它还支持时间回溯,因为它知道发生的一切。