作者 | 喵叔

出品 | CSDN（ID：CSDNnews）

對於 python 代碼的調試我們通常都是使用 IDE 自帶的調試功能。但是 IDE 提供的調試功能存在侷限性，例如在測試服務器上調試代碼，但是又不可能在測試服務器上安裝 IDE 進行調試。這時我們就可以利用下面所講解的三個工具進行調試。

零、準備調試代碼

在講解三個調試工具前，我們先編寫待調試的代碼。代碼很簡單，就是計算兩個數的商。我們在編寫代碼的時候故意留下了除數為 0 的 bug。

<code>def division(start, end):
for i in range(start, end, -1):
num1 = i
num2 = i - 1
result = num1 / num2
print(result)

if __name__ == '__main__':
division(10, 0)
/<code>

PySnooper

PySnooper 是 Python 的第三方工具庫，它可以精確的顯示代碼的執行時間、執行順序和代碼中的局部變量值的變化等。PySnooper 使用方法很簡單，只需要將它作為裝飾器來使用即可。下面我們來看一下具體使用步驟：

1. 安裝 PySnooper

在控制檯輸入如下命令：

<code>pip install pysnooper
/<code>
等待兩秒鐘後 PySnooper 安裝完成。

2. 加入 PySnooper

• 首先需要引入 PySnooper

import pysnooper

• 接著在需要測試的函數上加上 pysnooper 裝飾器

<code>@pysnooper.snoop
def division(start, end):
for i in range(start, end, -1):
num1 = i
num2 = i - 1
result = num1 / num2
print(result)


if __name__ == '__main__':
division(10, 0)
/<code>
3. 調試代碼

在控制檯輸入命令：

<code>python text.py
/<code>
運行代碼後，控制檯輸出如下內容

上圖只截取了 PySnooper 輸出日誌的開頭內容和最後結尾的內容。從截圖中我們可以看到 PySnooper 輸出了每行代碼的運行順序、運行時間和代碼運行中變量值的變化，以及報錯信息。在實際項目中 PySnooper 輸出的日誌內容會很多，在控制檯查看會很不方便，這時我們可以將日誌輸出到本地文件中，我們只需在 PySnooper 裝飾器中加入日誌保存路徑即可:

<code>@pysnooper.snoop('/app/project_log.log')
/<code>
一些公司對日誌輸出會有要求，比如每行日誌要以某某字符串開頭，這時只需在裝飾器中加入需要字符穿即可： 

<code>@pysnooper.snoop(prefix='MyCompanyName: ')
/<code>
上述所講的都是 PySnooper 裝飾器的常用參數，例如監控自定義表達式、監控底層函數、多線程等 PySnooper 同樣支持，具體參數可以在官方項目文檔中查看。

前面我們所講的都是在函數上利用裝飾器來監控整個函數，但是在實際項目中往往一個函數內容會很多，如果監控整個函數會導致輸出的日誌過多，這時我們就可以利用 PySnooper 的局部監控功能來監控函數中需要監控的代碼片段。現在我們來修改一下代碼，只監控輸出的值：

<code>import pysnooper

def division(start, end):
for i in range(start, end, -1):
with pysnooper.snoop:
num1 = i
num2 = i - 1
result = num1 / num2
print(result)


if __name__ == '__main__':
division(10, 0)
/<code>
 
上述代碼運行後我們就會發現輸出的內容少了很多。

Better-exceptions

Better-exceptions 同樣是 Python 的第三方工具庫，它出現的原因是其實很簡單就是“美化異常信息”（是不是感覺作者很任性）。Better-exceptions 主要使用了 Python 的 sys 模塊的 excepthook 方法，這個方法在當系統拋出異常時，解釋器就會調用它，同時傳遞三個參數：異常類、異常實例和 traceback 對象，這就說明我們可以重寫這個方法來捕獲系統異常。但是，因為我們可以重寫 excepthook 方法來捕獲系統異常，因此 Better-exceptions 對與 Web 框架來說是不起任何作用的，因為 Web 框架都已經處理了系統拋出的異常，不會再以 hook 的方式觸發 Better-exceptions 。下面我們就來看一下該怎麼用。

1. 安裝 Better-exceptions

• 首先在控制檯輸入如下命令：

<code>pip install better-exceptions
/<code>
等待兩秒鐘後 Better-exceptions 安裝完成。

• 接著我們在控制檯輸入如下代碼，來設置環境變量：

<code>setx BETTER_EXCEPTIONS 1/<code>

1. 調試代碼

   在控制檯輸入命令：

<code>python text.py
/<code>
代碼運行後，控制檯輸出如下圖：

從上面的圖我們可以看到，Better-exceptions 對異常代碼進行了著色，並對產生異常的變量值進行了輸出。通過這兩項內容我們就可以很快捷的看到具體報錯位置和報錯原因。這裡有需要注意的地方就是，在 Windows 系統下輸出的日誌會存在亂碼問題，這是因為 Better-exceptions 的編碼格式造成的。要解決這個問題我們只需要修改 better-exceptions 目錄下的 encoding.py 文件，講文件中的 ENCODING = locale.getpreferredencoding 修改為 ENCODING = 'utf-8'即可。

PDB

PDB 是 Python 內置的模塊，我們可以利用 PDB 設置斷點和跟蹤調試。PDB 的使用不需要再安裝第三方插件，只需要在命令行輸入如下命令：

<code>python -m pdb Test.py
/<code>
命令執行後將會進入 PDB 調試模式。如果需要在代碼中加入斷點，只需要在需要加入斷點的位置加入 pdb.set_trace 即可。當進入到 PDB 模式後，輸入 c 就可以從當前斷點直接跳轉到下一個斷點，如果後續沒有斷點，則會將剩餘代碼執行完。當然，如果需要單步執行代碼，在控制檯輸入 s 指令，但是有時主函數會調用大量的其他函數，這時在命令行輸入 n 就可以只在主函數中執行單步調試。除了上述指令外，PDB 還有其他指令，如下表： 

總結

我們講解了 PySnooper 、Better-exceptions 和 PDB 的用法，這三種方法一般都使用在服務器上，這裡我推薦使用Better-exceptions，因為它對代碼的侵入性很小，幾乎不需要改變代碼。

作者簡介：朱鋼，筆名喵叔，CSDN博客專家，.NET高級開發工程師，7年一線開發經驗，參與過電子政務系統和AI客服系統的開發，以及互聯網招聘網站的架構設計，目前就職於北京恆創融慧科技發展有限公司，從事企業級安全監控系統的開發。

聲明：本文系作者獨立觀點，不代表CSDN立場。

【END】

☞BTC 固定的貨幣政策，真的無懈可擊嗎？

閱讀更多 CSDN 的文章

關鍵字: 知識 CSDN 作者