使用開源可視化工具來理解你的Python代碼
VizTracer 工具可以可視化并跟蹤 Python 代碼,讓你可以更深入地了解其工作原理。
隨著 Python 項目變得越來越大、越復雜,理解起它來就變得充滿挑戰(zhàn)性。即使是你自己獨自編寫了整個項目,也不可能完全知道項目是如何工作的。為了能更好的理解你的代碼,調(diào)試和分析代碼變得至關(guān)重要。
VizTracer 是一個這樣的工具,它通過跟蹤和可視化 Python 代碼的執(zhí)行過程,來幫助你對代碼的理解。無需對源代碼進行任何更改,VizTracer 即可記錄函數(shù)的入口 / 出口,函數(shù)參數(shù) / 返回值以及任意變量,然后通過 Trace-Viewer 使用直觀的谷歌前端界面來顯示數(shù)據(jù)。
下面是一個運行蒙特卡洛樹搜索的例子:
Monte Carlo tree search visualization
每個函數(shù)都在時間線上以堆棧的形式記錄和可視化,這樣你就可以看到在運行程序時發(fā)生了什么。你可以放大查看任意特定點的詳細信息:
Zooming in on VizTracer visualization
VizTracer 還可以自動記錄函數(shù)參數(shù)和返回值。你可以單擊函數(shù)條目并查看詳細信息:
Viewing VizTracer details
或者你可以創(chuàng)建一個全新的信號,并用它來記錄變量。例如,這顯示了執(zhí)行梯度下降時的成本值:
VizTracer gradient descent
與其他設置復雜的工具相比,VizTracer 使用起來非常簡單,并且沒有任何依賴關(guān)系。你可以從 pip 安裝它:
pip install viztracer
你也可以通過輸入來跟蹤你的程序(<your_script.py> 是你腳本的名稱):
viztracer <your_script.py>
VizTracer 將在你的工作目錄中生成一個 HTML 報告,你可以在 Chrome 瀏覽器中打開它。
VizTracer 還提供了其他高級功能,比如過濾器功能,你可以使用它過濾掉不想跟蹤的函數(shù),獲得更清晰的報告。例如,要僅包含文件中的函數(shù),你需要:
viztracer include_files ./ --run <your_script.py>
記錄函數(shù)參數(shù)和返回值:
viztracer --log_function_args --log_return_value <your_script.py>
記錄與某個正則表達式匹配的任意變量:
# log variables starts with aviztracer --log_var a.* --run <your_script.py>
你可以通過對源代碼進行較小的修改來獲得其他功能,例如自定義事件來記錄數(shù)值和對象。
VizTracer 還包括一個虛擬調(diào)試器(vdb),它可以調(diào)試 VizTracer 的日志文件??梢杂?vdb 調(diào)試你運行中的代碼(與 pdb 非常相似)以便你了解代碼流。有用的是,它還支持時間回溯,因為它知道發(fā)生的一切。
與一些原型不同,VizTracer 使用純 C 語言實現(xiàn)其核心,這將極大地減少開銷,使其達到類似于 cProfile 的水平。
VizTracer 是開源的,在 Apache 2.0 許可下發(fā)布,支持所有常見的操作系統(tǒng)平臺(Linux、macOS 和 Windows)。你可以在 GitHub 上了解關(guān)于它的更多特性并訪問源代碼。







































