python 調(diào)試冷知識(小結(jié))
對于 python 代碼的調(diào)試我們通常都是使用 IDE 自帶的調(diào)試功能。但是 IDE 提供的調(diào)試功能存在局限性,例如在測試服務(wù)器上調(diào)試代碼,但是又不可能在測試服務(wù)器上安裝 IDE 進行調(diào)試。這時我們就可以利用下面所講解的三個工具進行調(diào)試。
零、準(zhǔn)備調(diào)試代碼
在講解三個調(diào)試工具前,我們先編寫待調(diào)試的代碼。代碼很簡單,就是計算兩個數(shù)的商。我們在編寫代碼的時候故意留下了除數(shù)為 0 的 bug。
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)
一、PySnooper
PySnooper 是 Python 的第三方工具庫,它可以精確的顯示代碼的執(zhí)行時間、執(zhí)行順序和代碼中的局部變量值的變化等。 PySnooper 使用方法很簡單,只需要將它作為裝飾器來使用即可。下面我們來看一下具體使用步驟:
安裝 PySnooper
1. 在控制臺輸入如下命令:
pip install pysnooper
等待兩秒鐘后 PySnooper 安裝完成。
2. 加入 PySnooper
首先需要引入 PySnooper
import pysnooper
接著在需要測試的函數(shù)上加上 pysnooper 裝飾器
@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)
調(diào)試代碼
在控制臺輸入命令:
python text.py
運行代碼后,控制臺輸出如下內(nèi)容
上圖只截取了 PySnooper 輸出日志的開頭內(nèi)容和最后結(jié)尾的內(nèi)容。從截圖中我們可以看到 PySnooper 輸出了每行代碼的運行順序、運行時間和代碼運行中變量值的變化,以及報錯信息。在實際項目中 PySnooper 輸出的日志內(nèi)容會很多,在控制臺查看會很不方便,這時我們可以將日志輸出到本地文件中,我們只需在 PySnooper 裝飾器中加入日志保存路徑即可:
@pysnooper.snoop('/app/project_log.log')
一些公司對日志輸出會有要求,比如每行日志要以某某字符串開頭,這時只需在裝飾器中加入需要字符穿即可:
@pysnooper.snoop(prefix='MyCompanyName: ')
上述所講的都是 PySnooper 裝飾器的常用參數(shù),例如監(jiān)控自定義表達式、監(jiān)控底層函數(shù)、多線程等 PySnooper 同樣支持,具體參數(shù)可以在官方項目文檔中查看。
前面我們所講的都是在函數(shù)上利用裝飾器來監(jiān)控整個函數(shù),但是在實際項目中往往一個函數(shù)內(nèi)容會很多,如果監(jiān)控整個函數(shù)會導(dǎo)致輸出的日志過多,這時我們就可以利用 PySnooper 的局部監(jiān)控功能來監(jiān)控函數(shù)中需要監(jiān)控的代碼片段?,F(xiàn)在我們來修改一下代碼,只監(jiān)控輸出的值:
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)
上述代碼運行后我們就會發(fā)現(xiàn)輸出的內(nèi)容少了很多。
二、Better-exceptions
Better-exceptions 同樣是 Python 的第三方工具庫,它出現(xiàn)的原因是其實很簡單就是“美化異常信息”(是不是感覺作者很任性)。 Better-exceptions 主要使用了 Python 的 sys 模塊的 excepthook 方法,這個方法在當(dāng)系統(tǒng)拋出異常時,解釋器就會調(diào)用它,同時傳遞三個參數(shù):異常類、異常實例和 traceback 對象,這就說明我們可以重寫這個方法來捕獲系統(tǒng)異常。但是,因為我們可以重寫 excepthook 方法來捕獲系統(tǒng)異常,因此 Better-exceptions 對與 Web 框架來說是不起任何作用的,因為 Web 框架都已經(jīng)處理了系統(tǒng)拋出的異常,不會再以 hook 的方式觸發(fā) Better-exceptions 。下面我們就來看一下該怎么用。
安裝 Better-exceptions
首先在控制臺輸入如下命令:
pip install better-exceptions
等待兩秒鐘后 Better-exceptions 安裝完成。
接著我們在控制臺輸入如下代碼,來設(shè)置環(huán)境變量:
setx BETTER_EXCEPTIONS 1
調(diào)試代碼
在控制臺輸入命令:
python text.py
代碼運行后,控制臺輸出如下圖:
從上面的圖我們可以看到,Better-exceptions 對異常代碼進行了著色,并對產(chǎn)生異常的變量值進行了輸出。通過這兩項內(nèi)容我們就可以很快捷的看到具體報錯位置和報錯原因。
這里有需要注意的地方就是,在 Windows 系統(tǒng)下輸出的日志會存在亂碼問題,這是因為 Better-exceptions 的編碼格式造成的。要解決這個問題我們只需要修改 better-exceptions 目錄下的 encoding.py 文件,講文件中的 ENCODING = locale.getpreferredencoding()
修改為 ENCODING = 'utf-8'
即可。
三、PDB
PDB 是 Python 內(nèi)置的模塊,我們可以利用 PDB 設(shè)置斷點和跟蹤調(diào)試。 PDB 的使用不需要再安裝第三方插件,只需要在命令行輸入如下命令:
python -m pdb Test.py
命令執(zhí)行后將會進入 PDB 調(diào)試模式。如果需要在代碼中加入斷點,只需要在需要加入斷點的位置加入 pdb.set_trace()
即可。當(dāng)進入到 PDB 模式后,輸入 c 就可以從當(dāng)前斷點直接跳轉(zhuǎn)到下一個斷點,如果后續(xù)沒有斷點,則會將剩余代碼執(zhí)行完。當(dāng)然,如果需要單步執(zhí)行代碼,在控制臺輸入 s 指令,但是有時主函數(shù)會調(diào)用大量的其他函數(shù),這時在命令行輸入 n 就可以只在主函數(shù)中執(zhí)行單步調(diào)試。除了上述指令外,PDB 還有其他指令,如下表:
指令 | 說明 |
---|---|
l | 顯示所有代碼 |
n | 執(zhí)行下一條代碼 |
c | 執(zhí)行當(dāng)前斷點后面的代碼,知道代碼執(zhí)行完畢 |
b x | 在代碼的第X行設(shè)置斷點 |
clear | 清除全部斷點 |
s | 單步執(zhí)行 |
s function_name | 進入 function_name 函數(shù)內(nèi)部執(zhí)行 |
q | 退出PDB |
a | 打印所有參數(shù)值 |
p | 打印指定變量值 |
r | 忽略剩余斷點,將剩余代碼執(zhí)行完畢 |
四、總結(jié)
我們講解了 PySnooper 、Better-exceptions 和 PDB 的用法,這三種方法一般都使用在服務(wù)器上,這里我推薦使用Better-exceptions,因為它對代碼的侵入性很小,幾乎不需要改變代碼。
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- 調(diào)試Python程序代碼的幾種方法總結(jié)
- Python代碼調(diào)試的幾種方法總結(jié)
- python pdb調(diào)試方法分享
- vscode 遠程調(diào)試python的方法
- python使用PyCharm進行遠程開發(fā)和調(diào)試
- 總結(jié)用Pdb庫調(diào)試Python的方式及常用的命令
- 使用Python中PDB模塊中的命令來調(diào)試Python代碼的教程
- 淺談Python在pycharm中的調(diào)試(debug)
- 在Python編程過程中用單元測試法調(diào)試代碼的介紹
- 對python程序內(nèi)存泄漏調(diào)試的記錄
相關(guān)文章
python pytest進階之xunit fixture詳解
這篇文章主要介紹了python pytest進階之xunit fixture詳解,了解unittest的同學(xué)應(yīng)該知道我們在初始化環(huán)境和銷毀工作時,unittest使用的是setUp,tearDown方法,那么在pytest框架中同樣存在類似的方法,今天我們就來具體說明,需要的朋友可以參考下2019-06-06基于Python實現(xiàn)剪切板實時監(jiān)控方法解析
這篇文章主要介紹了基于Python實現(xiàn)剪切板實時監(jiān)控方法解析,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-09-09python selenium對應(yīng)的瀏覽器chromedriver版本不一致問題
這篇文章主要介紹了python selenium對應(yīng)的瀏覽器chromedriver版本不一致問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-08-08centos 安裝python3.6環(huán)境并配置虛擬環(huán)境的詳細教程
這篇文章主要介紹了centos-安裝python3.6環(huán)境并配置虛擬環(huán)境的詳細教程,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2018-02-02