Python程序员必知必会的开发者工具

jieforest

如果你的程序崩溃时报了一个异常错误，那么你可以用python3 -i someprogram.py这个命令来运行你的程序，这能够很好地发现问题所在。-i选项表明只要程序终结就立即启动一个交互式shell。在这个交互式shell中，你就可以很好地探查到底发生了什么导致程序的错误。例如，如果你有以下代码：

1. def function(n):
   
2.     return n + 10
   
3. 
   
4. function("Hello")
   

复制代码

jieforest

如果使用python3 -i 命令运行程序就会产生如下输出：

1. python3 -i sample.py
   
2. Traceback (most recent call last):
   
3.   File "sample.py", line 4, in <module>
   
4.     function("Hello")
   
5.   File "sample.py", line 2, in function
   
6.     return n + 10
   
7. TypeError: Can't convert 'int' object to str implicitly
   
8. >>> function(20)
   
9. 30
   
10. >>>
    

复制代码

jieforest

如果你没有发现什么明显的错误，那么你可以进一步地启动Python调试器。例如：

1. >>> import pdb
   
2. >>> pdb.pm()
   
3. > sample.py(4)func()
   
4. -> return n + 10
   
5. (Pdb) w
   
6. sample.py(6)<module>()
   
7. -> func('Hello')
   
8. > sample.py(4)func()
   
9. -> return n + 10
   
10. (Pdb) print n
    
11. 'Hello'
    
12. (Pdb) q
    
13. >>>
    

复制代码

jieforest

如果你的代码身处的环境很难启动一个交互式shell的话（比如在服务器环境下），你可以增加错误处理的代码，并自己输出跟踪信息。例如：

1. import traceback
   
2. import sys
   
3. try:
   
4.     func(arg)
   
5. except:
   
6.     print('**** AN ERROR OCCURRED ****')
   
7.     traceback.print_exc(file=sys.stderr)
   

复制代码

jieforest

如果你的程序并没有崩溃，而是说程序的行为与你的预期表现的不一致，那么你可以尝试在一些可能出错的地方加入print()函数。如果你打算采用这种方案的话，那么还有些相关的技巧值得探究。首先，函数traceback.print_stack()能够在被执行时立即打印出程序中栈的跟踪信息。例如：

1. >>> def sample(n):
   
2. ...     if n > 0:
   
3. ...         sample(n-1)
   
4. ...     else:
   
5. ...         traceback.print_stack(file=sys.stderr)
   
6. ...
   
7. >>> sample(5)
   
8. File "<stdin>", line 1, in <module>
   
9. File "<stdin>", line 3, in sample
   
10. File "<stdin>", line 3, in sample
    
11. File "<stdin>", line 3, in sample
    
12. File "<stdin>", line 3, in sample
    
13. File "<stdin>", line 3, in sample
    
14. File "<stdin>", line 5, in sample
    
15. >>>
    

复制代码

jieforest

另外，你可以在程序中任意一处使用pdb.set_trace()手动地启动调试器，就像这样：

1. import pdb
   
2. def func(arg):
   
3.     ...
   
4.     pdb.set_trace()
   
5.     ...
   

复制代码

jieforest

在深入解析大型程序的时候，这是一个非常实用的技巧，这样操作能够清楚地了解程序的控制流或是函数的参数。比如，一旦调试器启动了之后，你就可以使用print或者w命令来查看变量，来了解栈的跟踪信息。

在进行软件调试时，千万不要让事情变得很复杂。有时候仅仅需要知道程序的跟踪信息就能够解决大部分的简单错误（比如，实际的错误总是显示在跟踪信息的最后一行）。

在实际的开发过程中，将print()函数插入到代码中也能够很方便地显示调试信息（只需要记得在调试完以后将print语句删除掉就行了）。调试器的通用用法是在崩溃的函数中探查变量的值，知道如何在程序崩溃以后再进入到调试器中就显得非常实用。

在程序的控制流不是那么清楚的情况下，你可以插入pdb.set_trace()语句来理清复杂程序的思路。本质上，程序会一直执行直到遇到set_trace()调用，之后程序就会立刻跳转进入到调试器中。在调试器里，你就可以进行更多的尝试。如果你正在使用Python的IDE，那么IDE通常会提供基于pdb的调试接口，你可以查阅IDE的相关文档来获取更多的信息。

jieforest

下面是一些Python调试器入门的资源列表：

1）阅读Steve Ferb的文章 “Debugging in Python”

2）观看Eric Holscher的截图 “Using pdb, the Python Debugger”

3）阅读Ayman Hourieh的文章 “Python Debugging Techniques”

4）阅读 Python documentation for pdb – The Python Debugger

5）阅读Karen Tracey的D jango 1.1 Testing and Debugging一书中的第九章——When You Don’t Even Know What to Log: Using Debuggers