IceCream in Python

你还在使用print 在Python 中 debug 吗？赶快使用Icecream吧。

提到 Icecream，你是不是会想到ta？

动机

如果你使用print去检查你的code错误时，在你的终端看到很多行的输出时，你可能会很困扰，还要找出哪一个输出对应哪一个code.

例如，运行下面的code:

>>>num1 = 30
>>>num2 = 40

>>>print(num1) #30
>>>print(num2) #40

哪一个输出是num1，哪一个输出是num2, 这两个结果不是很难去分辨，但是如果有超过五种不同的输出那？找出每个code对应的结果可能是很花费时间的？

你可能需要去添加一些文本，以致于打印出来的陈述更容易辨别。

>>>num1 = 30
>>>num2 = 40

>>>print('num1',num1)  #num1 30
>>>print('num2',num2)  #num2 40

这个结果是很容易发现，但是，它是很费时的去花时间写一些文本，是否有一些其他的方式，不用一些附加的文本反而可以找到code和结果之间的对应关系？

>>>num1 = 30
>>>num2 = 40

>>>ic(num1) # ic| num1
>>>ic(num2) # ic| num2

这就是“冰淇淋”排上用上的时候！

什么是 Icecream

Icecream是一个python的库，可以用最小的代码打印出更多debug的可读信息。

pip install icecream

让我们尝试用它输出一个Python函数

from icecream import ic

def plus_five(num):
    return num+5

ic(plus_five(4)) #ic| plus_five(4)=9
ic(plus_five(5)) #ic| plus_five(5)=10

通过使用ic，我们不仅看到了结果，也看到了函数形式和参数。这是多么简洁，在你终端的颜色可以显示出具体参数。

检测执行

为了找出哪一行的code 执行，你可以像下面展示的code这样去找到哪一行被执行。

def hello(user:bool):
    if user:
        print("I am user")
    else:
        print("I am not user")
    
hello(user = True)

【output】: I am user

Icecream使得上面这个过程更加简单，通过使用ic()，而不加任何文本就可以实现！

from icecream import ic
# 定义函数
def hello(user:bool):
    if user:
        ic()
    else:
        ic()
    
 hello(user = True)

现在你可以知道这个code被执行在第五行， 函数是hello 函数，然后第七行的code是不是时候会被执行。

自定义前缀

如果你想嵌入一个自定义前缀，例如时间，这个代码被执行输出成print陈述，icecream也可以让你这么做。

from datetime import datetime
from icecream import ic
import time

def time_format():
    return f'{datetime.now}|>'

ic.configureOutput(prefix = time_format)

for _ in range(3):
    time.sleep(1)
    ic('hello')

现在时间自动被code展现在输出中，这是多么Cool呀！

可以得到更多的信息吗？

除了知道code与输出之间的对应关系，你也可能想知道Code从哪一行，哪一个文件被执行。要是想知道关于code的信息，可以加入includeContext = True 到 ic.configureOutput

from icecream import ic 

def plus_five(num):
    return num+5

ic.configureOutput(includeContext = True)

ic(plus_five(4))
ic(plus_five(5))

现在你可以知道第一行输出是被第七行的函数plus_five所执行的

完成 Debug 后删除所有的 Icecream

你可以仅仅使用icecream去debug，而使用print去做其他的事情，例如，很漂亮的输出！

from icecream import ic

def plus_five(num):
    return num+5

ic(plus_five(4))
ic(puls_five(5))

for i in range(10):
    print("***Traning model{i}***")

由于你可以对debug print和pretty print进行区分。在你debug完成后，搜索并删除掉ic语句是更简单的。

删除ic debug后，你的代码看起来更加地简洁。