本文示例程式碼及檔案已上傳至我的Github倉庫https://github.com/CNFeffery/DataScienceStudyNotes

1 簡介

  儘管有那麼多花裡胡哨的debug工具和方式供我們選擇,但不得不承認,在大多數情況下,print()才是最方便的程式碼除錯方式,通過手動在程式中的關鍵位置書寫合適的列印語句,可以很快速地幫助我們瞭解到程式執行的過程,發現問題所在。

  而icecream就是一個將print大法發揮到極致的Python庫,它的工作方式有些像vscode中針對javascript的外掛Turbo Console Log,下面就讓我們一起來領略icecream中的實用功能吧~

2 利用icecream進行高效debug

  讓我們先來看看icecream最基礎的使用方式,假如我們需要在迴圈過程中列印每一輪對應的幾個變數,為了使得顯示的資訊更為清楚,傳統的方式可以這樣做:

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的基礎用法,下面我們來學習其更加豐富的功能特性:

2.1 利用icecream檢查各種變數

  icecream可以對任何型別的變數進行檢查,只需將變數傳入ic()中即可,甚至連pandas中的資料框都可以友好地進行列印輸出:

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 檢查程式碼執行位置

  很多時候我們在除錯程式碼列印一些關鍵位置結果時,希望可以快速找到對應結果在程式碼中的位置,利用ic(),不傳遞任何引數時,會自動打印出所在位置、所屬父級函式等資訊:

from icecream import ic

def demo():
ic()
a = 1 if 1 > 0:
ic()
a += 1
else:
ic()
a -= 1 demo()

2.3 一處匯入處處使用

  當你的專案擁有一個主檔案,其他的子模組都在主檔案中被呼叫時,那麼你就可以在主檔案開頭執行下列程式碼,之後無需在子模組中匯入icecream也可以使用ic()

from icecream import install
install()

2.4 個性化設定

  除了使用icecream預設的資訊列印格式之外,我們還可以利用ic.configureOutput()來自定義一些顯示引數,譬如:


  更多自定義引數可以訪問https://github.com/gruns/icecream#configuration檢視更多。

  正如icecream的簡介中所說的那樣:別再使用print()進行debug,大家可以在日常使用過程中多多使用icecream,體會其便捷之處。


  以上就是本文的全部內容,歡迎在評論區與我進行討論~