不再使用 print 来Debug了, IceCream 来了!

写在前面

• 打印语句通常是为了向用户显示一个输出。如果程序员使用 print() 进行调试，在调试结束后，程序员应该谨慎地只删除那些特定的 print() 语句，这些语句是用来调试的。
• 通常，在调试期间，你可能会一个接一个地打印多个变量。在这种情况下，程序员必须手动格式化输出以增强其可读性。

var_1 = 1
var_2 = 2
print(var_1)
print(var_2)

1
2

上面，我们打印了两个变量。虽然在这里我们知道第一个变量是 var_1 ，第二个是 var_2 ，但随着变量数量的增加，可能需要你在代码和输出之间来回寻找，以找出哪个输出对应于哪个变量。

当然，我们可以打印更多的细节，像下面这样，但这只是增加了你的工作，如果我们一直在做像这样的工作，不就需要996了。

var_1 = 1
var_2 = 2
print("var_1 =", var_1)
print("var_2 =", var_2)

var_1 = 1
var_2 = 2

• 有时，程序员可能还需要对打印行号、函数名称及其输入等，这增加了编写又长、又多的 print() 语句的复杂性。
• 在大多数情况下，代码库不只限于一个文件。相反，有多个文件组成管道。在这种情况下，人们可能有兴趣在调试时也显示文件的名称，而用 print() 会很麻烦。

值得庆幸的是，在Python中有一个很好的替代方案 —— IceCream ^[1] 🍦!

IceCream

安装 IceCream

你可以使用 pip 来安装 icecream 库。

pip install icecream

导入IceCream

from icecream import ic

开始使用IceCream

使用 IceCream 库就像 print 语句一样简单。你需要把 print() 替换为 ic() 。就是这样。

ic(var_1)
ic(var_2)

ic| var_1: 1
ic| var_2: 2

注意区别！ ic() 不仅打印 值 ，而且还打印所传递的 变量的名称 。

def func(num):
    return num * 2

ic(func(3))
ic| func(3): 6

超酷！它打印了方法的名称（ func ），传递的参数（ 3 ）和输出（ 6 ）。

每一个进入 ic() 方法的 表达式 都会被打印出来，同时还有 表达式 的 数值 ，如下图所示。

sample_dict = {1:"A", 2:"B", 3:"C"}
ic(sample_dict[1])

ic| sample_dict[1]: 'A'

检查执行情况

def func(input_num):
    if input_num == 1:
        print("If Executed!")
        ...
    else:
        print("Else Executed!")
        ...

## icecream_demo.py
from icecream import ic
def func(input_num):
    if input_num == 1:
        ic()
        ...
    else:
        ic()
        ...
func(2)

使用IceCream项目范围

接下来，你可能会想，print() 函数是Python 的内置库，使用方便，不需每次都import。而我们的 IceCream 是否需要在每个Python文件中都导入这个库？ 当然不是!

为了使方法在所有项目文件中可用，在根文件中导入 icecream 的 install 模块，如下所示。

## main_file.py
from icecream import install
install()
from help_file import func
func(2)

## help_file.py
def func(num):
    ic(num)
    return 2*num

通过 install ， ic() 可以在整个项目中使用。

添加一个自定义前缀

如果你注意到上面， ic() 语句的输出以" ic| "开始。那是 IceCream 提供的默认前缀。

然而，如果由于某种原因，你希望用一个自定义的前缀来代替它，我们可以通过在 ic.configureOutput() 方法中指定 prefix 参数来实现的，如下所示。

from icecream import ic
ic.configureOutput(prefix='ic debug| -> ')
ic("A custom prefix")

调试后删除IceCream语句

一旦你的代码调试结束，你可能想删除所有不必要的调试语句。

由于 ic() 语句在语法上与 print() 不同，你可以在编辑器中搜索" ic( "模式并删除这些语句，如下所示。

另外，你可以使用 ic.disable() 来停止 ic() 的打印。如果你想再次使用它们，请使用 ic.enable() 。

写在最后

如上所述， Python 中的 IceCream 库是一个很好的替代品。它使调试不费吹灰之力，可读性强，代码最少。如果你觉得本文对你有所帮助，可以点个赞和在看！

参考资料