Python性能分析工具py-spy原理用法解析

Py-Spy介紹

引用官方的介紹：

Py-Spy是Python程序的抽樣分析器。 它允許您可視化查看Python程序在哪些地方花了更多時間，整個監控方式無需重新啟動程序或以任何方式修改工程代碼。 Py-Spy的開銷非常低：它是用Rust編寫的，速度與編譯的Python程序不在同一個進程中運行。 這意味著Py-Spy可以安全地用于生成生產環境中的Python應用調優分析。

github：https://github.com/benfred/py-spy

安裝

pip install py-spy

安裝后使用py-spy - h可以驗證安裝，并查看使用幫助。

py-spy從命令行工作，并獲取要從中采樣的程序的PID或要運行的python程序的命令行。py-spy具有三個子命令record，top和dump：

record生成火焰圖 top實時查看每個函數運行時間并統計 dump顯示每個python線程的當前調用堆棧

使用py-spy 生成火焰圖

​ py-spy是一個非常好用而且簡單的庫，看完他的readme 介紹文檔基本就可以入手使用spy。這個工具一是可以生成profile 火焰圖，二是可以定位到程序中最耗時間的代碼的位置。它的優點在于完全不用修改代碼，相比較其他的一些性能調查工具，py-spy這一點非常棒，當你debug 一個線上正在運行的程序的時候，只需要提供進程id，py-spy 就可以直接生成火焰圖。

py-spy record -o profile.svg --pid 12345

或者

py-spy record -o profile.svg-python myprogram.py

'12345' 為程序運行的pid，當運行這行命令的時候，py-spy 開始抽樣的程序simlple 并且生成火焰圖，我們可以等待1分鐘左右 ctrl+c 結束，這時候會在運行這行命令的當前目錄下生成 profile.svg 火焰圖, 如下圖:

火焰圖的分析非常簡單直觀，主要是看'平頂'，看圖中最下方那個峰頂是平的，那么程序的性能問題就可以從這里入手去解決，這里不詳細介紹火焰圖看法，不明白的同學可以自行百度。

​ 通過生成火焰圖分析程序瓶頸大概率可以找到并解決80%的程序性能問題，但是還有一種問題，如果我的火焰圖沒有平頂，但是程序依舊很慢，該如何定位問題？

沒有平頂情況下，定位程序中耗時最多函數/代碼

如下圖，通過火焰圖并沒有發現程序中的平頂

Top功能

這時候要用到py-spy 提供的 top 命令，Top顯示了在python程序中花費最多時間的功能的實時視圖，類似于unix top命令。

py-spy top --pid 12345

或

py-spy top-python myprogram.py

​ 輸入上述命令后，在控制臺會顯示程序實時的運行狀態，這里可以介紹一下圖中4個參數的含義, 然后可以通過按1，2，3，4 四個按鍵，讓程序按照下圖所述排序。

按％Own排序（當前在該函數中花費的時間的百分比） 按％Total排序（函數及其子級中當前的時間百分比） 按OwnTime排序（函數中花費的總時間） 按TotalTime排序（該函數及其子項花費的總時間）

比較直觀的 使用3 , 可以比較直接的看出程序運行中，所占比消耗時間最多的函數，然后從函數如圖進行分析，如下圖，可以看出 是wrap 裝飾器函數消耗的時間最長，我們用wrapt 這個c寫的裝飾器進行替換后效率有了明顯的提升。

​

總結 ： 使用py-spy 相對于其他一些python性能分析工具，優勢在于使用非常簡單，而且無須對代碼做任何改動，并且可以在保護現場情況下，直接生成火焰圖，還可查看實時程序運行狀態。

火焰圖怎么看

首先你需要知道：

X方向是采樣時間。

Y方向是函數調用棧。

如果給你一個這樣的火焰圖，你應該得出什么信息：

1.a()是開始的執行函數，但沒有消耗cpu，在這個函數里執行了b(),h()。

2.a()的兩個分支b()和h()，這表明a()里面可能有一個條件語句，繼續可以看到b()分支消耗的 CPU 大大高于h()。

3.h()函數沒有消耗cpu，cpu全被i()函數占有。

4.b()函數這條支路繼續往上，一直到d()，由d()函數的子函數e()消耗一部分cpu,f()下的g()消耗一部分cpu,你會發現d()的最右邊往上缺了一塊，這塊就是d()執行消耗的cpu。

結論：

消耗cpu的函數為e(),g(),d(),i()。

因此，如果要調查性能問題，首先應該調查g()，其次是i()。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持好吧啦網。