簡單實用的Python代碼調(diào)試?yán)?/h1>
1.簡介
盡管有那么多花里胡哨的debug工具和方式供我們選擇,但不得不承認(rèn),在大多數(shù)情況下,print()才是最方便的代碼調(diào)試方式😂,通過手動在程序中的關(guān)鍵位置書寫合適的打印語句,可以很快速地幫助我們了解到程序運行的過程,發(fā)現(xiàn)問題所在。
而icecream就是一個將print大法發(fā)揮到極致的Python庫,它的工作方式有些像vscode中針對javascript的插件Turbo Console Log,下面就讓我們一起來領(lǐng)略icecream中的實用功能吧。
2 利用icecream進(jìn)行高效debug
讓我們先來看看icecream最基礎(chǔ)的使用方式,假如我們需要在循環(huán)過程中打印每一輪對應(yīng)的幾個變量,為了使得顯示的信息更為清楚,傳統(tǒng)的方式可以這樣做:
- from icecream import ic
- for i in range(3):
- j = i + 1
- k = i ** 2
- print('i : ', i, 'j : ', j, 'k : ', k)
而基于icecream,事情就變得簡單了一些:
- for i in range(3):
- j = i + 1
- k = i ** 2
- ic(i, j, k)
比較一下差異,效果一目了然:
這就是icecream的基礎(chǔ)用法,下面我們來學(xué)習(xí)其更加豐富的功能特性:
2.1 利用icecream檢查各種變量
icecream可以對任何類型的變量進(jìn)行檢查,只需將變量傳入ic()中即可,甚至連pandas中的數(shù)據(jù)框都可以友好地進(jìn)行打印輸出:
- import pandas as pd
- def demo_func(x):
- return x + 1
- class DemoClass:
- a = 1
- demo_df = pd.DataFrame({
- 'a': [1, 2, 3],
- 'b': ['a', 'b', 'c']
- })
- ic(demo_func(1))
- ic(DemoClass.a)
- ic(demo_df);
2.2 檢查代碼執(zhí)行位置
很多時候我們在調(diào)試代碼打印一些關(guān)鍵位置結(jié)果時,希望可以快速找到對應(yīng)結(jié)果在代碼中的位置,利用ic(),不傳遞任何參數(shù)時,會自動打印出所在位置、所屬父級函數(shù)等信息:
- from icecream import ic
- def demo():
- ic()
- a = 1
- if 1 > 0:
- ic()
- a += 1
- else:
- ic()
- a -= 1
- demo()
2.3 一處導(dǎo)入處處使用
當(dāng)你的項目擁有一個主文件,其他的子模塊都在主文件中被調(diào)用時,那么你就可以在主文件開頭執(zhí)行下列代碼,之后無需在子模塊中導(dǎo)入icecream也可以使用ic():
- from icecream import install
- install()
2.4 個性化設(shè)置
除了使用icecream默認(rèn)的信息打印格式之外,我們還可以利用ic.configureOutput()來自定義一些顯示參數(shù),譬如:
更多自定義參數(shù)可以訪問https://github.com/gruns/icecream#configuration查看更多。
正如icecream的簡介中所說的那樣:別再使用print()進(jìn)行debug,大家可以在日常使用過程中多多使用icecream,體會其便捷之處。