相信大部分人學習Python毁葱,肯定會用print()這個內(nèi)置函數(shù)垫言,來調(diào)試代碼的。
那么在一個大型的項目中倾剿,如果你也是使用print來調(diào)試你的Python代碼筷频,你就會發(fā)現(xiàn)你的終端有多個輸出。
那么你便不得不去分辨前痘,每一行的輸出是哪些代碼的運行結(jié)果凛捏。
舉個例子,運行下面這個程序芹缔。
輸出結(jié)果坯癣。
這些輸出中哪一個是num1?哪一個又是num2呢最欠?
找出兩個輸出可能不是很困難示罗,但是如果有五個以上的不同輸出呢?嘗試查找與輸出相關的代碼可能會很耗時芝硬。
當然你可以在打印語句中添加文本蚜点,使其更容易理解:
輸出結(jié)果。
這個結(jié)果就很容易理解了吵取,但是需要時間去寫相關的信息禽额。
這時就該「Icecream」上場了~
01. 什么是Icecream?
Icecream是一個Python第三方庫,可通過最少的代碼使打印調(diào)試更清晰明了脯倒。
使用pip安裝Icecream庫实辑。
下面,讓我們通過打印Python函數(shù)的輸出來進行嘗試藻丢。
輸出結(jié)果如下剪撬。
通過使用icecream,我們不僅可以看到函數(shù)輸出悠反,還可以看到函數(shù)及其參數(shù)残黑!
02. 檢查執(zhí)行情況
如果你想要找到執(zhí)行代碼的位置,可以通過執(zhí)行如下所示的操作斋否,來查找執(zhí)行了哪個語句梨水。
輸出結(jié)果。
使用icecream則無需多余的文本信息茵臭,就可以輕松地完成上述的操作疫诽。
輸出結(jié)果如下。
從輸出結(jié)果看旦委,函數(shù)hello中的第5行的代碼已被執(zhí)行奇徒,而第7行的代碼未執(zhí)行。
03. 自定義前綴
如果您想在打印語句中插入自定義前綴(例如代碼執(zhí)行時間)缨硝,icecream也是能實現(xiàn)的摩钙。
輸出結(jié)果如下。
可以看到代碼的執(zhí)行時間查辩,就顯示在輸出的前面胖笛。
04. 獲取更多的信息
除了知道和輸出相關的代碼之外,你可能還想知道代碼執(zhí)行的行和代碼文件宜肉。
在ic.configureOutput()中匀钧,設置includeecontext的參數(shù)值為True即可。
輸出結(jié)果如下谬返。
這里我們就知道了,第一個輸出是由函數(shù)plus_five在文件icecream_example.py的第7行執(zhí)行的日杈。
第二個輸出則是由函數(shù)plus_five在代碼文件的第8行執(zhí)行的遣铝。
上述兩個操作都用到了ic.configureOutput()函數(shù)。
通過查看源碼莉擒,可知有四個可供設置的參數(shù)酿炸。
prefix,自定義輸出前綴
outputFunction涨冀,更改輸出函數(shù)
argToStringFunction填硕,自定義參數(shù)序列化字符串
includeContext,顯示文件名、代碼行扁眯、函數(shù)信息
05. 刪除Icecream代碼
最后你可以將icecream僅用于調(diào)試壮莹,而將print用于其他目的(例如漂亮的打印)。
輸出結(jié)果姻檀。
由于你可以區(qū)分調(diào)試打印和漂亮打印命满,因此搜索和刪除所有ic調(diào)試語句非常容易。
刪除所有調(diào)試代碼后绣版,你的Python代碼就整潔了胶台。
總結(jié)
到此,你就應該就學會了如何使用icecream去打印調(diào)試。