Python 偵錯程式入門

發表於2018-09-04

Python 生態系統包含豐富的工具和庫,可以讓開發人員更加舒適。 例如,我們之前已經介紹瞭如何使用互動式 shell 增強 Python。本文重點介紹另一種可以節省時間並提高 Python 技能的工具:Python 偵錯程式。

Python 偵錯程式

Python 標準庫提供了一個名為 pdb 的偵錯程式。此偵錯程式提供了除錯所需的大多數功能,如斷點、單行步進、堆疊幀的檢查等等。

瞭解一些pdb 的基本知識很有用,因為它是標準庫的一部分。 你可以在無法安裝其他增強的偵錯程式的環境中使用它。

執行 pdb

執行 pdb 的最簡單方法是從命令列,將程式作為引數傳遞來除錯。 看看以下指令碼:

你可以從命令列執行 pdb,如下所示:

使用 pdb 的另一種方法是在程式中設定斷點。為此,請匯入 pdb 模組並使用set_trace 函式:

指令碼在斷點處停止,pdb 顯示指令碼中的下一行。 你也可以在失敗後執行偵錯程式。 這稱為事後除錯postmortem debugging。

穿行於執行堆疊

除錯中的一個常見用例是在執行堆疊中穿行。 Python 偵錯程式執行後,可以使用以下命令:

  • w(here):顯示當前執行的行以及執行堆疊的位置。

  • l(ist):顯示當前位置周圍更多的上下文(程式碼)

  • u(p)/d(own):向上或向下穿行呼叫堆疊。

單步執行程式

pdb提供以下命令來執行和單步執行程式碼:

  • n(ext):繼續執行,直到達到當前函式中的下一行,或者返回
  • s(tep):執行當前行並在第一個可能的場合停止(在被呼叫的函式或當前函式中)
  • c(ontinue):繼續執行,僅在斷點處停止。

該示例顯示了 nextstep 之間的區別。 實際上,當使用 step 時,偵錯程式會進入 pdb 模組原始碼,而接下來就會執行 set_trace 函式。

檢查變數內容

  • pdb 非常有用的地方是檢查執行堆疊中儲存的變數的內容。 例如,a(rgs) 命令列印當前函式的變數,如下所示:

pdb 列印變數的值,在本例中是 10。

  • 可用於列印變數值的另一個命令是 p(rint)

如示例中最後的命令所示,print 可以在顯示結果之前計算表示式。

Python 文件包含每個 pdb 命令的參考和示例。 對於開始使用 Python 偵錯程式人來說,這是一個有用的讀物。

增強的偵錯程式

一些增強的偵錯程式提供了更好的使用者體驗。 大多數為 pdb 新增了有用的額外功能,例如語法突出高亮、更好的回溯和自省。 流行的增強偵錯程式包括 IPython 的 ipdbpdb++

這些示例顯示如何在虛擬環境中安裝這兩個偵錯程式。 這些示例使用新的虛擬環境,但在除錯應用程式的情況下,應使用應用程式的虛擬環境。

安裝 IPython 的 ipdb

要安裝 IPython ipdb,請在虛擬環境中使用 pip

要在指令碼中呼叫 ipdb,必須使用以下命令。 請注意,該模組稱為 ipdb 而不是 pdb:

IPython 的 ipdb 也可以用 Fedora 包安裝,所以你可以使用 Fedora 的包管理器 dnf 來安裝它:

安裝 pdb++

你可以類似地安裝 pdb++:

pdb++ 重寫了 pdb 模組,因此你可以使用相同的語法在程式中新增斷點:

總結

學習如何使用 Python 偵錯程式可以節省你在排查應用程式問題時的時間。 對於瞭解應用程式或某些庫的複雜部分如何工作也是有用的,從而提高 Python 開發人員的技能。

 

相關文章