答应我,调试Python代码,不要再用Print了!
相信大部分人學習Python,肯定會用print()這個內置函數,來調試代碼的。
那么在一個大型的項目中,如果你也是使用print來調試你的Python代碼,你就會發現你的終端有多個輸出。
那么你便不得不去分辨,每一行的輸出是哪些代碼的運行結果。
舉個例子,運行下面這個程序。
輸出結果。
這些輸出中哪一個是num1?哪一個又是num2呢?
找出兩個輸出可能不是很困難,但是如果有五個以上的不同輸出呢?嘗試查找與輸出相關的代碼可能會很耗時。
當然你可以在打印語句中添加文本,使其更容易理解:
num1?=?30 num2?=?40?print("num1"?num1) print("num2"?num1)輸出結果。
num1?30 num2?40這個結果就很容易理解了,但是需要時間去寫相關的信息。
這時就該「Icecream」上場了~
01. 什么是Icecream?
Icecream是一個Python第三方庫,可通過最少的代碼使打印調試更清晰明了。
使用pip安裝Icecream庫。
pip?install?icecream下面,讓我們通過打印Python函數的輸出來進行嘗試。
from?icecream?import?ic?def?plus_five(num):return?num?+?5ic(plus_five(4)) ic(plus_five(5))輸出結果如下。
ic|?plus_five(4):?9 ic|?plus_five(5):?10通過使用icecream,我們不僅可以看到函數輸出,還可以看到函數及其參數!
02. 檢查執行情況
如果你想要找到執行代碼的位置,可以通過執行如下所示的操作,來查找執行了哪個語句。
def?hello(user:bool):if?user:print("I'm?user")else:print("I'm?not?user")hello(user=True)輸出結果。
使用icecream則無需多余的文本信息,就可以輕松地完成上述的操作。
from?icecream?import?ic?def?hello(user:bool):if?user:ic()else:ic()hello(user=True)輸出結果如下。
ic|?ice_1.py:5?in?hello()?at?02:34:41.391從輸出結果看,函數hello中的第5行的代碼已被執行,而第7行的代碼未執行。
03. 自定義前綴
如果您想在打印語句中插入自定義前綴(例如代碼執行時間),icecream也是能實現的。
from?datetime?import?datetime from?icecream?import?ic? import?time from?datetime?import?datetimedef?time_format():return?f'{datetime.now()}|>?'ic.configureOutput(prefix=time_format)for?_?in?range(3):time.sleep(1)ic('Hello')輸出結果如下。
可以看到代碼的執行時間,就顯示在輸出的前面。
04. 獲取更多的信息
除了知道和輸出相關的代碼之外,你可能還想知道代碼執行的行和代碼文件。
在ic.configureOutput()中,設置includeecontext的參數值為True即可。
from?icecream?import?ic?def?plus_five(num):return?num?+?5ic.configureOutput(includeContext=True) ic(plus_five(4)) ic(plus_five(5))輸出結果如下。
這里我們就知道了,第一個輸出是由函數plus_five在文件icecream_example.py的第7行執行的。
第二個輸出則是由函數plus_five在代碼文件的第8行執行的。
上述兩個操作都用到了ic.configureOutput()函數。
通過查看源碼,可知有四個可供設置的參數。
prefix,自定義輸出前綴
outputFunction,更改輸出函數
argToStringFunction,自定義參數序列化字符串
includeContext,顯示文件名、代碼行、函數信息
05. 刪除Icecream代碼
最后你可以將icecream僅用于調試,而將print用于其他目的(例如漂亮的打印)。
輸出結果。
ic|?ice_1.py:7?in?<module>-?plus_five(4):?9 ic|?ice_1.py:8?in?<module>-?plus_five(5):?10 ******?Training?model?0?****** ******?Training?model?1?****** ******?Training?model?2?****** ******?Training?model?3?****** ******?Training?model?4?****** ******?Training?model?5?****** ******?Training?model?6?****** ******?Training?model?7?****** ******?Training?model?8?****** ******?Training?model?9?******由于你可以區分調試打印和漂亮打印,因此搜索和刪除所有ic調試語句非常容易。
刪除所有調試代碼后,你的Python代碼就整潔了。
總結
到此,你就應該就學會了如何使用icecream去打印調試。
更多功能可以訪問「GitHub」,了解詳情~
https://github.com/gruns/icecream
萬水千山總是情,點個??????行不行。
推薦閱讀誤執行了rm -fr /*之后,除了跑路還能怎么辦?! 程序員必備58個網站匯總 大幅提高生產力:你需要了解的十大Jupyter Lab插件總結
以上是生活随笔為你收集整理的答应我,调试Python代码,不要再用Print了!的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: IT大佬廖雪峰带你玩转Python数据分
- 下一篇: 应用上云 2 小时烧掉近 50 万,创始