时间戳

首页 > 技术文章 > Python Traceback详解

Python Traceback详解

taosiyu 2020-04-14 19:11 原文

刚接触Python的时候，简单的异常处理已经可以帮助我们解决大多数问题，但是随着逐渐地深入，我们会发现有很多情况下简单的异常处理已经无法解决问题了，如下代码，单纯的打印异常所能提供的信息会非常有限。

 1 def func1():
 2     raise Exception("--func1 exception--")
 3 
 4 
 5 def main():
 6     try:
 7         func1()
 8     except Exception as e:
 9         print e
10 
11 
12 if __name__ == '__main__':
13     main()
View Code

 

执行后输出如下:

1 --func1 exception--
View Code

 

通过示例，我们发现普通的打印异常只有很少量的信息（通常是异常的value值），这种情况下我们很难定位在哪块代码出的问题，以及如何出现这种异常。那么到底要如何打印更加详细的信息呢？下面我们就来一一介绍。

sys.exc_info和traceback object

Python程序的traceback信息均来源于一个叫做traceback object的对象，而这个traceback object通常是通过函数sys.exc_info()来获取的，先来看一个例子：

import sys


def func1():
    raise NameError("--func1 exception--")


def main():
    try:
        func1()
    except Exception as e:
        exc_type, exc_value, exc_traceback_obj = sys.exc_info()
        print "exc_type: %s" % exc_type
        print "exc_value: %s" % exc_value
        print "exc_traceback_obj: %s" % exc_traceback_obj


if __name__ == '__main__':
    main()
View Code

 

执行后输出如下：

exc_type: <type 'exceptions.NameError'>
exc_value: --func1 exception--
exc_traceback_obj: <traceback object at 0x7faddf5d93b0>
View Code

 

通过以上示例我们可以看出，sys.exc_info()获取了当前处理的exception的相关信息，并返回一个元组，元组的第一个数据是异常的类型(示例是NameError类型)，第二个返回值是异常的value值，第三个就是我们要的traceback object.

有了traceback object我们就可以通过traceback module来打印和格式化traceback的相关信息，下面我们就来看下traceback module的相关函数。

traceback module

Python的traceback module提供一整套接口用于提取，格式化和打印Python程序的stack traces信息，下面我们通过例子来详细了解下这些接口：

print_tb

 1 import sys
 2 import traceback
 3 
 4 
 5 def func1():
 6     raise NameError("--func1 exception--")
 7 
 8 
 9 def main():
10     try:
11         func1()
12     except Exception as e:
13         exc_type, exc_value, exc_traceback_obj = sys.exc_info()
14         traceback.print_tb(exc_traceback_obj)
15 
16 
17 if __name__ == '__main__':
18     main()
View Code

 

输出：

1 File "<ipython-input-23-52bdf2c9489c>", line 11, in main
2     func1()
3 File "<ipython-input-23-52bdf2c9489c>", line 6, in func1
4     raise NameError("--func1 exception--")
View Code

 

这里我们可以发现打印的异常信息更加详细了，下面我们了解下print_tb的详细信息：

traceback.print_tb(tb[, limit[, file]])
  • tb: 这个就是traceback object, 是我们通过sys.exc_info获取到的
  • limit: 这个是限制stack trace层级的，如果不设或者为None，就会打印所有层级的stack trace
  • file: 这个是设置打印的输出流的，可以为文件，也可以是stdout之类的file-like object。如果不设或为None，则输出到sys.stderr。

print_exception

import sys
import traceback


def func1():
    raise NameError("--func1 exception--")

def func2():
    func1()

def main():
    try:
        func2()
    except Exception as e:
        exc_type, exc_value, exc_traceback_obj = sys.exc_info()
        traceback.print_exception(exc_type, exc_value, exc_traceback_obj, limit=2, file=sys.stdout)


if __name__ == '__main__':
    main()

输出：

Traceback (most recent call last):
  File "<ipython-input-24-a68061acf52f>", line 13, in main
    func2()
  File "<ipython-input-24-a68061acf52f>", line 9, in func2
    func1()
NameError: --func1 exception--

看下定义：

traceback.print_exception(etype, value, tb[, limit[, file]])
  • 跟print_tb相比多了两个参数etype和value，分别是exception type和exception value，加上tb(traceback object)，正好是sys.exc_info()返回的三个值
  • 另外，与print_tb相比，打印信息多了开头的"Traceback (most...)"信息以及最后一行的异常类型和value信息
  • 还有一个不同是当异常为SyntaxError时，会有"^"来指示语法错误的位置

print_exc

print_exc是简化版的print_exception, 由于exception type, value和traceback object都可以通过sys.exc_info()获取，因此print_exc()就自动执行exc_info()来帮助获取这三个参数了，也因此这个函数是我们的程序中最常用的，因为它足够简单

 1 import sys
 2 import traceback
 3 
 4 
 5 def func1():
 6     raise NameError("--func1 exception--")
 7 
 8 def func2():
 9     func1()
10 
11 def main():
12     try:
13         func2()
14     except Exception as e:
15         traceback.print_exc(limit=1, file=sys.stdout)
16 
17 
18 if __name__ == '__main__':
19     main()
View Code

 

输出（由于limit=1，因此只有一个层级被打印出来）：

1 Traceback (most recent call last):
2   File "<ipython-input-25-a1f5c73b97c4>", line 13, in main
3     func2()
4 NameError: --func1 exception--
View Code

 

定义如下：

1 traceback.print_exc([limit[, file]])
View Code
  • 只有两个参数，够简单

format_exc

 1 import logging
 2 import sys
 3 import traceback
 4 logger = logging.getLogger("traceback_test")
 5 
 6 def func1():
 7     raise NameError("--func1 exception--")
 8 
 9 def func2():
10     func1()
11 
12 def main():
13     try:
14         func2()
15     except Exception as e:
16         logger.error(traceback.format_exc(limit=1, file=sys.stdout))
17 
18 
19 if __name__ == '__main__':
20     main()
View Code

 

 

从这个例子可以看出有时候我们想得到的是一个字符串，比如我们想通过logger将异常记录在log里，这个时候就需要format_exc了，这个也是最常用的一个函数，它跟print_exc用法相同，只是不直接打印而是返回了字符串。

traceback module中还有一些其它的函数，但因为并不常用，就不在展开来讲，感兴趣的同学可以看下参考链接中的文档。

获取线程中的异常信息

通常情况下我们无法将多线程中的异常带回主线程，所以也就无法打印线程中的异常，而通过上边学到这些知识，我们可以对线程做如下修改，从而实现捕获线程异常的目的。
以下示例来自weidong的博客文章，稍有修改（见参考链接）

 1 import threading
 2 import traceback
 3 
 4 def my_func():
 5     raise BaseException("thread exception")
 6 
 7 
 8 class ExceptionThread(threading.Thread):
 9 
10     def __init__(self, group=None, target=None, name=None, args=(), kwargs=None, verbose=None):
11         """
12         Redirect exceptions of thread to an exception handler.
13         """
14         threading.Thread.__init__(self, group, target, name, args, kwargs, verbose)
15         if kwargs is None:
16             kwargs = {}
17         self._target = target
18         self._args = args
19         self._kwargs = kwargs
20         self._exc = None
21 
22     def run(self):
23         try:
24             if self._target:
25                 self._target()
26         except BaseException as e:
27             import sys
28             self._exc = sys.exc_info()
29         finally:
30             #Avoid a refcycle if the thread is running a function with
31             #an argument that has a member that points to the thread.
32             del self._target, self._args, self._kwargs
33 
34     def join(self):
35         threading.Thread.join(self)
36         if self._exc:
37             msg = "Thread '%s' threw an exception: %s" % (self.getName(), self._exc[1])
38             new_exc = Exception(msg)
39             raise new_exc.__class__, new_exc, self._exc[2]
40 
41 
42 t = ExceptionThread(target=my_func, name='my_thread')
43 t.start()
44 try:
45     t.join()
46 except:
47     traceback.print_exc()
View Code

输出如下：

1 Traceback (most recent call last):
2   File "/data/code/testcode/thread_exc.py", line 43, in <module>
3     t.join()
4   File "/data/code/testcode/thread_exc.py", line 23, in run
5     self._target()
6   File "/data/code/testcode/thread_exc.py", line 5, in my_func
7     raise BaseException("thread exception")
8 Exception: Thread 'my_thread' threw an exception: thread exception
View Code

 

 

这样我们就得到了线程中的异常信息。

参考链接

traceback官方文档

weidong's blog

推荐阅读