还在用print()语句来调试Python代码?快停止吧

时间:2022-04-24 07:03:03

print()的缺点

我就是使用print()语句调试代码的人之一。有些时候,如果代码很长,那么就会有更多的打印,需要使用多个符号来相互区分。

看看下面的代码片段。(本博客中的代码片段,遵循Python 3.7的语法)

  1. print(style_dict,"{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{}}}}}}}}}}}}}}}}}}}}}}}}}}]]]]]]]]]]]]]]]]]]]") 
  2. # Adding into a dictionary 
  3. res_dct = {style_dict[i]: style_dict[i + 1] for i in range(0, len(style_dict), 2)} 
  4. res_dist={res_dct['Email Address']:{style_dict[i]: style_dict[i + 1] for i in range(0, len(style_dict), 2)}} 
  5. print(res_dist,"+++++++++++++++++++++++++++++++++++++++++++++++++++++") 
  6. recon_dict = res_dct 
  7. print(recon_dict,"---------------------------------------------------") 
  8. # Removing space so that data can be transferred to HTML fields 
  9. recon_dict = {x.translate({32: None}): y 
  10.               for x, y in list(recon_dict.items())} 
  11. print("##################################################") 
  12. print(recon_dict) 
  13. print("################################################") 
  14.  
  15. # Converting to JSON 
  16. r = json.dumps(recon_dict) 
  17. print("$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$") 
  18. print(r) 
  19. loaded_json = json.loads(r) 
  20. print("WWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWwwwwww") 
  21. print("******************************************************") 
  22. print(loaded_json) 

在这里,我试图将一个字典添加到一个JSON文件。由于一些错误,我不得不使用那么多带有不同符号的打印语句进行调试。

但是随着代码变得越来越大,不同的模块和不同的类调用其他模块或类中的不同定义,这不是一个好的选择。

让我们看看这种方法的一些缺点:

  • 随着代码的增加,很难在代码遍历的每个模块、类或定义中使用print语句。
  • 甚至在我们注意到错误之前,代码就已经执行并进入下一步。
  • 等到一个漫长的执行完成后再查找并修复。
  • 回到大量的日志中去搜索我们在print语句中给出的正确符号并匹配它们是很乏味的。

还在用print()语句来调试Python代码?快停止吧

一个简单的转变

除了使用Python提供给我们的强大武器“pdb模块”,我们不需要做任何事情。这个模块帮助我们有效地调试。

什么是pdb(python调试器)?

pdb是一个交互式shell,有助于调试python代码。它帮助我们一步一步地进入代码、暂停、检查状态并继续下一行代码或继续执行。

调用pdb的一些方法:

在这里,我们将介绍三种调用pdb的方法。

  • Postmortem:如果您想在程序级别进行调试,请使用此功能。
  • Inline pdb:适用比3.7版本更早的版本
  • breakpoint():对于版本3.7或更高的版本

还在用print()语句来调试Python代码?快停止吧

postmortem

让我们用一个简单的程序来理解。

  1. def add_num(listA,num): 
  2.     sum=[] 
  3.     for i in listA: 
  4.         sum.append(i*num) 
  5.     return sum 
  6.  
  7. listA = [2, 4, 6, 8] 
  8. num=10 
  9. result=add_num(listA,num) 
  10. print(result) 

在这里,def add_num应该将num变量的值添加到名为listA的列表中的每个元素中,在列表sum中存储新值,并返回列表sum。

通过执行下面所示的python文件,将调用pdb,

  1. python -m pdb debug_add.py 

这将进入pdb模式,并在第一行代码处停止。

  1. (venv) C:\Users\PycharmProjects\>python -m pdb debug_add.py 
  2. > c:\users\pycharmprojects\debug_add.py(2)<module>() 
  3. -> def add_num(listA,num): 
  4. (Pdb) 

任何时候,如果您需要调试器的帮助,请使用' h '(帮助),它列出了所有的选项。

  1. (Pdb) hDocumented commands (type help <topic>): 
  2. ======================================== 
  3. EOF    c          d        h         list      q        rv       undisplay 
  4. a      cl         debug    help      ll        quit     s        unt 
  5. alias  clear      disable  ignore    longlist  r        source   until 
  6. args   commands   display  interact  n         restart  step     up 
  7. b      condition  down     j         next      return   tbreak   w 
  8. break  cont       enable   jump      p         retval   u        whatis 
  9. bt     continue   exit     l         pp        run      unalias  whereMiscellaneous help topics: 
  10. ========================== 
  11. exec  pdb 

对特定选项的帮助,

  1. (Pdb) h debug 
  2. debug code 
  3.         Enter a recursive debugger that steps through the code 
  4.         argument (which is an arbitrary expression or statement to                     
  5.         be executed in the current environment). 

返回程序,使用选项' n ' (next)进入执行的下一个步骤。

  1. > c:\users\pycharmprojects\debug_add.py(2)<module>() 
  2. -> def add_num(listA,num): 
  3. (Pdb) n 
  4. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(8)<module>() 
  5. -> listA = [2, 4, 6, 8] 

在这里,我们可以通过给出如下变量名称来检查变量的值,

  1. (Pdb) listA 
  2. *** NameError: name 'listA' is not defined 
  3. (Pdb) 
  4. *** NameError: name 'listA' is not defined 

我们到达listA =[2,4,6,8]这一行,但我们仍然没有执行,所以它说listA未定义。如果您观察到我们在任何时候按enter键,前面的选项就会像上面那样执行。

现在按' n '向前移动并检查listA变量。

  1. (Pdb) n 
  2. > c:\users\pycharmprojects\debug_add.py(9)<module>() 
  3. -> num=10 
  4. (Pdb) listA 
  5. [2, 4, 6, 8] 
  6. (Pdb) 

要检查我们所在的代码行,请使用选项' l ' (line)。箭头标记指向我们所在的行,EOF表示文件结束。

  1. (Pdb) l 
  2.   4         for i in listA: 
  3.   5             sum.append(i*num) 
  4.   6         return sum 
  5.   7 
  6.   8     listA = [2, 4, 6, 8] 
  7.   9  -> num=10 
  8.  10     result=add_num(listA,num) 
  9.  11     print(result) 
  10. [EOF] 
  11. (Pdb) 

要退出调试器,我们使用选项' q ' (quit)。

  1. (Pdb) q 
  2. (venv) C:\Users\PycharmProjects\> 

使用postmortem方法的另一种方法是仅在遇到异常时停止执行,因为使用-c继续使用-m pdb

  1. python -m pdb -c continue debug_add.py 

 

Breakpoint()

从Python 3.7开始,引入了breakpoint(),这有助于调试Python代码,而不必显式地导入模块pdb并调用pdb.set_trace()。breakpoint()为我们完成所有这些工作,并在控制台中打开PDB调试器。

现在,让我们在没有任何断点的情况下执行上述代码,并在遇到任何错误时进行调试。

  1. def add_num(listA,num): 
  2.     sum=[] 
  3.     for i in listA: 
  4.         sum.append(i*num) 
  5.     return sum 
  6.  
  7. listA = [2, 4, 6, 8] 
  8. num=10 
  9. result=add_num(listA,num) 
  10. print(result) 

输出:

  1. C:\Users\PycharmProjects\venv\Scripts\python.exe C:/Users/PycharmProjects/debug_add.py 
  2. [20, 40, 60, 80]Process finished with exit code 0 

代码块的任务是将num(10)添加到列表中的每个元素中,并返回新的列表。

  • 预期结果为[12,14,16,18]
  • 实际结果为[20,40,60,80]

现在让我们使用breakpoint()武器来调试和修复代码。

放置断点()的位置取决于怀疑错误的位置。在本例中,我们在它进入add_num()定义之前放置它。

  1. def add_num(listA,num): 
  2.     sum=[] 
  3.     for i in listA: 
  4.         sum.append(i*num) 
  5.     return sum 
  6.  
  7. listA = [2, 4, 6, 8] 
  8. num=10 
  9. breakpoint() 
  10. result=add_num(listA,num) 
  11. print(result) 

输出:

  1. > c:\users\pycharmprojects\debug_add.py(11)<module>() 
  2. -> result=add_num(listA,num) 
  3. (Pdb) n 
  4. > c:\users\pycharmprojects\debug_add.py(12)<module>() 
  5. -> print(result) 
  6. (Pdb) n 
  7. [20, 40, 60, 80] 
  8.  — Return —  
  9. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(12)<module>()->None 
  10. -> print(result) 
  11. (Pdb) 

选项' n ' (next)用于在任何定义上移动到下一行或步骤。但在本例中,我们需要进入定义,为此我们将使用选项' s ' (step)。

在粗体文本下面是用来突出显示所使用的选项及其解释。

  1. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(11)<module>() 
  2. -> result=add_num(listA,num) 
  3. (Pdb) s  <----- Step into def add_num 
  4. --Call-- 
  5. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(2)add_num() 
  6. -> def add_num(listA,num): 
  7. (Pdb) s  <---- stepped inside def add_num 
  8. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(3)add_num() 
  9. -> sum=[] 
  10. (Pdb) n  <--- inside a def feel free to use 'n' 
  11. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(4)add_num() 
  12. -> for i in listA: 
  13. (Pdb) n  
  14. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(5)add_num() 
  15. -> sum.append(i*num) 
  16. (Pdb) n 
  17. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(4)add_num() 
  18. -> for i in listA: 
  19. (Pdb) sum  <-- examine sum value 
  20. [20] <--- 2+10 =12 not 20,oops we used '*'instead of '+' in       
  21.                           appending to list sum,CAUGHT IT! 
  22. (Pdb) i  <-- so, examine i 
  23. (Pdb) sum.append(i+num) <-- try adding + in the expression 
  24. (Pdb) sum 
  25. [20, 12] <-- PERFECT, FIXED IT! 
  26. (Pdb) u <-- used to skip other iterations of for loop. 
  27. > c:\users\prade\pycharmprojects\jobportal\debug_add.py(11)<module>() 
  28. -> result=add_num(listA,num) 
  29. (Pdb) c <-- used to continue with execution 
  30. [20, 12, 40, 60, 80] <--not a right answer but found a fix.Process finished with exit code 0 

上面,在for循环的第一次迭代之后,我们检查了sum值,结果显示为20,而不是12。我们差点在这里发现我们用*(乘法)代替了+(加法)因此,我们向前迈出一步,检查' i '在那一点上是2,并尝试了sum.append(i+num)。然后检验和,得到12是最近添加的元素。因此我们得到了修复,因此我们使用选项' u ' (until)跳过了for循环的剩余迭代。然后它移动到循环后的下一步。这里我们使用' c ' (continue)来继续执行,结果就结束了。

现在修复,

  1. def add_num(listA,num): 
  2.     sum=[] 
  3.     for i in listA: 
  4.         sum.append(i+num) 
  5.     return sum 
  6.  
  7. listA = [2, 4, 6, 8] 
  8. num=10 
  9. result=add_num(listA,num) 
  10. print(result) 

输出:

  1. C:\Users\PycharmProjects\venv\Scripts\python.exe C:/Users/PycharmProjects/debug_add.py 
  2. [12, 14, 16, 18]Process finished with exit code 0 

没有乱七八糟的print()语句,这看起来很简单。