深圳幻海软件技术有限公司 欢迎您!

简单实用的Python代码调试利器

2023-02-27

1.简介尽管有那么多花里胡哨的debug工具和方式供我们选择,但不得不承认,在大多数情况下,print()才是最方便的代码调试方式😂,通过手动在程序中的关键位置书写合适的打印语句,可以很快速地帮助我们了解到程序运行的过程,发现问题所在。而icecream就是一个将print大法发挥到极致的Pyth

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) 
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.

而基于icecream,事情就变得简单了一些: 

for i in range(3): 
     
    j = i + 1 
    k = i ** 2 
 
    ic(i, j, k) 
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

比较一下差异,效果一目了然: 

 

这就是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); 
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.

  

2.2 检查代码执行位置

很多时候我们在调试代码打印一些关键位置结果时,希望可以快速找到对应结果在代码中的位置,利用ic(),不传递任何参数时,会自动打印出所在位置、所属父级函数等信息: 

from icecream import ic 
 
def demo(): 
    ic() 
    a = 1 
 
    if 1 > 0: 
        ic() 
        a += 1 
    else
        ic() 
        a -= 1 
 
demo() 
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.

  

2.3 一处导入处处使用

当你的项目拥有一个主文件,其他的子模块都在主文件中被调用时,那么你就可以在主文件开头执行下列代码,之后无需在子模块中导入icecream也可以使用ic(): 

from icecream import install 
install() 
  • 1.
  • 2.

  

2.4 个性化设置

除了使用icecream默认的信息打印格式之外,我们还可以利用ic.configureOutput()来自定义一些显示参数,譬如: 

 

 

更多自定义参数可以访问https://github.com/gruns/icecream#configuration查看更多。

正如icecream的简介中所说的那样:别再使用print()进行debug,大家可以在日常使用过程中多多使用icecream,体会其便捷之处。