浅谈Python traceback的优雅处理
作者:sunsky303 时间:2023-08-06 06:57:42
刚接触Python的时候,简单的异常处理已经可以帮助我们解决大多数问题,但是随着逐渐地深入,我们会发现有很多情况下简单的异常处理已经无法解决问题了,如下代码,单纯的打印异常所能提供的信息会非常有限。
def func1():
raise Exception("--func1 exception--")
def main():
try:
func1()
except Exception as e:
print e
if __name__ == '__main__':
main()
执行后输出如下:
--func1 exception--
通过示例,我们发现普通的打印异常只有很少量的信息(通常是异常的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()
执行后输出如下:
exc_type: <type 'exceptions.NameError'>
exc_value: --func1 exception--
exc_traceback_obj: <traceback object at 0x7faddf5d93b0>
通过以上示例我们可以看出,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
import sys
import traceback
def func1():
raise NameError("--func1 exception--")
def main():
try:
func1()
except Exception as e:
exc_type, exc_value, exc_traceback_obj = sys.exc_info()
traceback.print_tb(exc_traceback_obj)
if __name__ == '__main__':
main()
输出:
File "<ipython-input-23-52bdf2c9489c>", line 11, in main
func1()
File "<ipython-input-23-52bdf2c9489c>", line 6, in func1
raise NameError("--func1 exception--")
这里我们可以发现打印的异常信息更加详细了,下面我们了解下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()来帮助获取这三个参数了,也因此这个函数是我们的程序中最常用的,因为它足够简单
import sys
import traceback
def func1():
raise NameError("--func1 exception--")
def func2():
func1()
def main():
try:
func2()
except Exception as e:
traceback.print_exc(limit=1, file=sys.stdout)
if __name__ == '__main__':
main()
输出(由于limit=1,因此只有一个层级被打印出来):
Traceback (most recent call last):
File "<ipython-input-25-a1f5c73b97c4>", line 13, in main
func2()
NameError: --func1 exception--
定义如下:traceback.print_exc([limit[, file]])
只有两个参数,够简单
format_exc
import logging
import sys
import traceback
logger = logging.getLogger("traceback_test")
def func1():
raise NameError("--func1 exception--")
def func2():
func1()
def main():
try:
func2()
except Exception as e:
logger.error(traceback.format_exc(limit=1, file=sys.stdout))
if __name__ == '__main__':
main()
从这个例子可以看出有时候我们想得到的是一个字符串,比如我们想通过logger将异常记录在log里,这个时候就需要format_exc了,这个也是最常用的一个函数,它跟print_exc用法相同,只是不直接打印而是返回了字符串。
traceback module中还有一些其它的函数,但因为并不常用,就不在展开来讲,感兴趣的同学可以看下参考链接中的文档。
获取线程中的异常信息
通常情况下我们无法将多线程中的异常带回主线程,所以也就无法打印线程中的异常,而通过上边学到这些知识,我们可以对线程做如下修改,从而实现捕获线程异常的目的。
以下示例来自weidong的博客文章,稍有修改(见参考链接)
import threading
import traceback
def my_func():
raise BaseException("thread exception")
class ExceptionThread(threading.Thread):
def __init__(self, group=None, target=None, name=None, args=(), kwargs=None, verbose=None):
"""
Redirect exceptions of thread to an exception handler.
"""
threading.Thread.__init__(self, group, target, name, args, kwargs, verbose)
if kwargs is None:
kwargs = {}
self._target = target
self._args = args
self._kwargs = kwargs
self._exc = None
def run(self):
try:
if self._target:
self._target()
except BaseException as e:
import sys
self._exc = sys.exc_info()
finally:
#Avoid a refcycle if the thread is running a function with
#an argument that has a member that points to the thread.
del self._target, self._args, self._kwargs
def join(self):
threading.Thread.join(self)
if self._exc:
msg = "Thread '%s' threw an exception: %s" % (self.getName(), self._exc[1])
new_exc = Exception(msg)
raise new_exc.__class__, new_exc, self._exc[2]
t = ExceptionThread(target=my_func, name='my_thread')
t.start()
try:
t.join()
except:
traceback.print_exc()
输出如下:
Traceback (most recent call last):
File "/data/code/testcode/thread_exc.py", line 43, in <module>
t.join()
File "/data/code/testcode/thread_exc.py", line 23, in run
self._target()
File "/data/code/testcode/thread_exc.py", line 5, in my_func
raise BaseException("thread exception")
Exception: Thread 'my_thread' threw an exception: thread exception
这样我们就得到了线程中的异常信息。
参考链接
traceback官方文档 https://docs.python.org/2/library/traceback.html
来源:http://www.cnblogs.com/sunsky303/p/9562269.html
![](/images/zang.png)
![](/images/jiucuo.png)
猜你喜欢
PHP生成sitemap.xml地图函数
Go语言kylin任务自动化实例详解
![](https://img.aspxhome.com/file/2023/6/127436_0s.jpg)
详解python内置常用高阶函数(列出了5个常用的)
使用PyInstaller将Pygame库编写的小游戏程序打包为exe文件及出现问题解决方法
![](https://img.aspxhome.com/file/2023/3/108013_0s.png)
使用 Django Highcharts 实现数据可视化过程解析
![](https://img.aspxhome.com/file/2023/8/99238_0s.png)
分享3个非常实用的 Python 模块
python误差棒图errorbar()函数实例解析
![](https://img.aspxhome.com/file/2023/3/127873_0s.png)
Python编程实现双链表,栈,队列及二叉树的方法示例
Python约瑟夫生者死者小游戏实例讲解
mysql Access denied for user ‘root’@’localhost’ (using password: YES)解决方法
Tensorflow tf.dynamic_partition矩阵拆分示例(Python3)
利用Opencv中Houghline方法实现直线检测
![](https://img.aspxhome.com/file/2023/0/84000_0s.png)
python之用Numpy和matplotlib画一个魔方
![](https://img.aspxhome.com/file/2023/0/125030_0s.jpg)
Laravel框架实现发送短信验证功能代码
![](https://img.aspxhome.com/file/2023/4/129844_0s.png)
python实现对任意大小图片均匀切割的示例
OverFlow:一个秘密武器
Python程序设计入门(2)变量类型简介
python 3.6 +pyMysql 操作mysql数据库(实例讲解)
![](https://img.aspxhome.com/file/2023/8/79548_0s.png)
python实现邮件循环自动发件功能
![](https://img.aspxhome.com/file/2023/5/104835_0s.png)
Go语言基础if条件语句用法及示例详解
![](https://img.aspxhome.com/file/2023/0/134410_0s.png)