简介

在编程过程中，几乎难以避免的会出现错误。事实上，程序员为了消除错误，要花费大量的时间在代码调试上。在调试过程中，使用 print() 语句来理解程序流程和发现意外行为无疑是最常用的方法。

然而，使用 print() 语句存在许多问题，比如

• print 语句通常用于向用户显示输出。如果程序员使用 print() 进行调试，调试结束后，程序员必须小心地删除仅用于调试的特定 print() 语句。
• 在调试过程中，可能会连续打印多个变量。在这种情况下，程序员必须手动格式化输出以提高可读性。
• 当变量数量增加时，可能需要来回查看代码和输出，以确定每个输出对应哪个变量。

幸运的是，python 为我们提供了一个出色的替代方案，icecream。通过使用最少的代码，icecream 使调试变得轻松和可读。

安装

使用 pip 命令安装 icecream 库

pip install icecream

基本使用

在代码中引入 ic 模块

from icecream import ic

使用 IceCream 库和 print 语句类似，只需将 print 替换为 ic 即可。

from icecream import ic

var1 = 0
var2 = 1.0

ic(var1)
ic(var2)

代码输出

ic| var1: 0
ic| var2: 1.0

注意到了吗？ic() 不仅打印变量的值，还打印变量的名称。

更多应用

icecream 不仅局限于变量，还可以用于函数、类等。

from icecream import ic

def func(num):
    return num * 2

ic(func(3))

代码输出

ic| func(3): 6

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

python icecream

icecream 的调试功能也适用于常见的 Python 数据结构，比如字典，看下面的例子

from icecream import ic

sample_dict = {1:"A", 2:"B", 3:"C"}

ic(sample_dict[1])

代码输出

ic| sample_dict[1]: 'A'

很多时候，程序员会使用 print() 语句打印一些有意义的语句来确定程序的执行阶段，比如

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

    else:
        print("Else Executed!")
        ...

使用 icecream 可以更优雅的实现目的。

from icecream import ic

def func(input_num):
    if input_num == 1:
        ic()
        ...

    else:
        ic()
        ...

func(2)

只需调用 ic()，它就会打印文件名、行号和其他详细信息（如函数名和时间），非常简单明了，有没有?

接下来，你可能会想，难道每个 Python 文件都需要导入该库吗？答案，当然不必如此！

方法是，在入口文件中导入 icecream 的 install 模块，让所有项目文件都可用，比如

from icecream import install
install()

from help_file import func
func(2)

如果你注意到了，ic() 语句的输出以 "ic|" 开头，这是 icecream 提供的默认前缀。如果有特殊需求，你可以使用 ic.configureOutput() 方法中的 prefix 参数替换默认前缀，看下面示例

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

ic("A custom prefix")

代码输出

ic debug| -> 'A custom prefix'

项目一旦调试完成，一般我们希望删除所有不必要的调试语句。可以使用 ic.disable() 停止打印 ic()，如果想再次使用，使用 ic.enable() 即可。

结论

icecream 是 Python 中一款强大的调试工具，可以更轻松地进行代码调试和错误定位，提高开发效率和代码质量。icecream 是值得每个 Python 程序员掌握和使用的工具之一。

参考资料

• https://github.com/gruns/icecream