调试python 程序的几种方法总结

小咪咪 2021-11-17 09:54 378阅读 0赞

程序能一次写完并正常运行的概率很小，基本不超过1%。总会有各种各样的bug需要修正。有的bug很简单，看看错误信息就知道，有的bug很复杂，我们需要知道出错时，哪些变量的值是正确的，哪些变量的值是错误的，因此，需要一整套调试程序的手段来修复bug。

第一种方法简单直接粗暴有效，就是用print把可能有问题的变量打印出来看看：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code># err.py</code> 
     </div> 
     <div> 
      <code>def</code> 
      <code>foo(s):</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>print</code> 
      <code>'&gt;&gt;&gt; n = %d'</code> 
      <code>%</code> 
      <code>n</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>def</code> 
      <code>main():</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>foo(</code> 
      <code>'0'</code> 
      <code>)</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>main()</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

执行后在输出中查找打印的变量值：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>$ python err.py</code> 
     </div> 
     <div> 
      <code>&gt;&gt;&gt; n </code> 
      <code>=</code> 
      <code>0</code> 
     </div> 
     <div> 
      <code>Traceback (most recent call last):</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>...</code> 
     </div> 
     <div> 
      <code>ZeroDivisionError: integer division </code> 
      <code>or</code> 
      <code>modulo by zero</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

用print最大的坏处是将来还得删掉它，想想程序里到处都是print，运行结果也会包含很多垃圾信息。所以，我们又有第二种方法。  
**断言**

凡是用print来辅助查看的地方，都可以用断言（assert）来替代：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code># err.py</code> 
     </div> 
     <div> 
      <code>def</code> 
      <code>foo(s):</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>assert</code> 
      <code>n !</code> 
      <code>=</code> 
      <code>0</code> 
      <code>, </code> 
      <code>'n is zero!'</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>def</code> 
      <code>main():</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>foo(</code> 
      <code>'0'</code> 
      <code>)</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

assert的意思是，表达式n != 0应该是True，否则，后面的代码就会出错。

如果断言失败，assert语句本身就会抛出AssertionError：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>$ python err.py</code> 
     </div> 
     <div> 
      <code>Traceback (most recent call last):</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>...</code> 
     </div> 
     <div> 
      <code>AssertionError: n </code> 
      <code>is</code> 
      <code>zero!</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

程序中如果到处充斥着assert，和print相比也好不到哪去。不过，启动Python解释器时可以用-O参数来关闭assert：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>$ python </code> 
      <code>-</code> 
      <code>O err.py</code> 
     </div> 
     <div> 
      <code>Traceback (most recent call last):</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>...</code> 
     </div> 
     <div> 
      <code>ZeroDivisionError: integer division </code> 
      <code>or</code> 
      <code>modulo by zero</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

关闭后，你可以把所有的assert语句当成pass来看。  
**logging**

把print替换为logging是第3种方式，和assert比，logging不会抛出错误，而且可以输出到文件：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code># err.py</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code>logging</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>s </code> 
      <code>=</code> 
      <code>'0'</code> 
     </div> 
     <div> 
      <code>n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>logging.info(</code> 
      <code>'n = %d'</code> 
      <code>%</code> 
      <code>n)</code> 
     </div> 
     <div> 
      <code>print</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

logging.info()就可以输出一段文本。运行，发现除了ZeroDivisionError，没有任何信息。怎么回事？

别急，在import logging之后添加一行配置再试试：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>import</code> 
      <code>logging</code> 
     </div> 
     <div> 
      <code>logging.basicConfig(level</code> 
      <code>=</code> 
      <code>logging.INFO)</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

看到输出了：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>$ python err.py</code> 
     </div> 
     <div> 
      <code>INFO:root:n = 0</code> 
     </div> 
     <div> 
      <code>Traceback (most recent call last):</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>File </code> 
      <code>"err.py"</code> 
      <code>, line 8, </code> 
      <code>in</code> 
      <code>&lt;module&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>print 10 / n</code> 
     </div> 
     <div> 
      <code>ZeroDivisionError: integer division or modulo by zero</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这就是logging的好处，它允许你指定记录信息的级别，有debug，info，warning，error等几个级别，当我们指定level=INFO时，logging.debug就不起作用了。同理，指定level=WARNING后，debug和info就不起作用了。这样一来，你可以放心地输出不同级别的信息，也不用删除，最后统一控制输出哪个级别的信息。

logging的另一个好处是通过简单的配置，一条语句可以同时输出到不同的地方，比如console和文件。  
**pdb**

第4种方式是启动Python的调试器pdb，让程序以单步方式运行，可以随时查看运行状态。我们先准备好程序：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code># err.py</code> 
     </div> 
     <div> 
      <code>s </code> 
      <code>=</code> 
      <code>'0'</code> 
     </div> 
     <div> 
      <code>n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>print</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

然后启动：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>$ python -m pdb err.py</code> 
     </div> 
     <div> 
      <code>&gt; </code> 
      <code>/Users/michael/Github/sicp/err</code> 
      <code>.py(2)&lt;module&gt;()</code> 
     </div> 
     <div> 
      <code>-&gt; s = </code> 
      <code>'0'</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

以参数-m pdb启动后，pdb定位到下一步要执行的代码-> s = '0'。输入命令l来查看代码：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>(Pdb) l</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>1</code>&nbsp;&nbsp; 
      <code># err.py</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>2</code> 
      <code>-</code> 
      <code>&gt; s </code> 
      <code>=</code> 
      <code>'0'</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>3</code>&nbsp;&nbsp; 
      <code>n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>4</code>&nbsp;&nbsp; 
      <code>print</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
     <div> 
      <code>[EOF]</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

输入命令n可以单步执行代码：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>(Pdb) n</code> 
     </div> 
     <div> 
      <code>&gt; </code> 
      <code>/</code> 
      <code>Users</code> 
      <code>/</code> 
      <code>michael</code> 
      <code>/</code> 
      <code>Github</code> 
      <code>/</code> 
      <code>sicp</code> 
      <code>/</code> 
      <code>err.py(</code> 
      <code>3</code> 
      <code>)&lt;module&gt;()</code> 
     </div> 
     <div> 
      <code>-</code> 
      <code>&gt; n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>(Pdb) n</code> 
     </div> 
     <div> 
      <code>&gt; </code> 
      <code>/</code> 
      <code>Users</code> 
      <code>/</code> 
      <code>michael</code> 
      <code>/</code> 
      <code>Github</code> 
      <code>/</code> 
      <code>sicp</code> 
      <code>/</code> 
      <code>err.py(</code> 
      <code>4</code> 
      <code>)&lt;module&gt;()</code> 
     </div> 
     <div> 
      <code>-</code> 
      <code>&gt; </code> 
      <code>print</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

任何时候都可以输入命令p 变量名来查看变量：

[?][Link 1]

输入命令q结束调试，退出程序：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>(Pdb) n</code> 
     </div> 
     <div> 
      <code>ZeroDivisionError: </code> 
      <code>'integer division or modulo by zero'</code> 
     </div> 
     <div> 
      <code>&gt; </code> 
      <code>/Users/michael/Github/sicp/err</code> 
      <code>.py(4)&lt;module&gt;()</code> 
     </div> 
     <div> 
      <code>-&gt; print 10 / n</code> 
     </div> 
     <div> 
      <code>(Pdb) q</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这种通过pdb在命令行调试的方法理论上是万能的，但实在是太麻烦了，如果有一千行代码，要运行到第999行得敲多少命令啊。还好，我们还有另一种调试方法。  
**pdb.set\_trace()**

这个方法也是用pdb，但是不需要单步执行，我们只需要import pdb，然后，在可能出错的地方放一个pdb.set\_trace()，就可以设置一个断点：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code># err.py</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code>pdb</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>s </code> 
      <code>=</code> 
      <code>'0'</code> 
     </div> 
     <div> 
      <code>n </code> 
      <code>=</code> 
      <code>int</code> 
      <code>(s)</code> 
     </div> 
     <div> 
      <code>pdb.set_trace() </code> 
      <code># 运行到这里会自动暂停</code> 
     </div> 
     <div> 
      <code>print</code> 
      <code>10</code> 
      <code>/</code> 
      <code>n</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

运行代码，程序会自动在pdb.set\_trace()暂停并进入pdb调试环境，可以用命令p查看变量，或者用命令c继续运行：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>$ python err.py </code> 
     </div> 
     <div> 
      <code>&gt; </code> 
      <code>/Users/michael/Github/sicp/err</code> 
      <code>.py(7)&lt;module&gt;()</code> 
     </div> 
     <div> 
      <code>-&gt; print 10 / n</code> 
     </div> 
     <div> 
      <code>(Pdb) p n</code> 
     </div> 
     <div> 
      <code>0</code> 
     </div> 
     <div> 
      <code>(Pdb) c</code> 
     </div> 
     <div> 
      <code>Traceback (most recent call last):</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>File </code> 
      <code>"err.py"</code> 
      <code>, line 7, </code> 
      <code>in</code> 
      <code>&lt;module&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>print 10 / n</code> 
     </div> 
     <div> 
      <code>ZeroDivisionError: integer division or modulo by zero</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这个方式比直接启动pdb单步调试效率要高很多，但也高不到哪去。  
**IDE**

如果要比较爽地设置断点、单步执行，就需要一个支持调试功能的IDE。目前比较好的Python IDE有PyCharm：

http://www.jetbrains.com/pycharm/

另外，Eclipse加上pydev插件也可以调试Python程序。  
**小结**

写程序最痛苦的事情莫过于调试，程序往往会以你意想不到的流程来运行，你期待执行的语句其实根本没有执行，这时候，就需要调试了。

虽然用IDE调试起来比较方便，但是最后你会发现，logging才是终极武器。

转载于:https://www.cnblogs.com/piwefei/p/11175680.html

[Link 1]: https://www.jb51.net/article/65072.htm#