使用icecream优雅调试Python代码

简介

在大型项目中，使用print()调试代码可能导致终端输出过多，难以分辨输出结果与代码的对应关系。为了更清晰地调试，可以采用Icecream库。

安装Icecream

使用pip安装：

pip install icecream

使用Icecream

Icecream可以显示函数输出及其参数，使调试更清晰。

示例代码

from icecream import ic
def plus_five(num):
    return num + 5
ic(plus_five(4))
ic(plus_five(5))

检查执行情况

Icecream可以显示代码执行的位置，无需添加额外文本信息。

示例代码

from icecream import ic
def hello(user: bool):
    if user:
        ic()
    else:
        ic()
hello(user=True)

自定义前缀

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')

获取更多信息

通过设置includeContext参数为True，可以显示文件名、代码行、函数信息。

示例代码

from icecream import ic

def plus_five(num):
    return num + 5

ic.configureOutput(includeContext=True)
ic(plus_five(4))
ic(plus_five(5))

删除Icecream代码

Icecream仅用于调试，可以轻松搜索和删除所有ic调试语句，使代码整洁。

示例代码

from icecream import ic

def plus_five(num):
    return num + 5

ic.configureOutput(includeContext=True)
ic(plus_five(4))
ic(plus_five(5))

for i in range(10):
    print(f'****** Training model {i} ******')

总结

通过使用Icecream，可以更有效地进行Python代码调试，同时保持代码的整洁性。

作者：写bug写bug
链接：https://juejin.cn/post/7407489781440233535