Python中traceback错误堆栈信息处理

2023-12-29 03:32

本文主要是介绍Python中traceback错误堆栈信息处理,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、Python中的异常栈跟踪

之前在做Java的时候,异常对象默认就包含stacktrace相关的信息,通过异常对象的相关方法printStackTrace()和getStackTrace()等方法就可以取到异常栈信息,能打印到log辅助调试或者做一些别的事情。但是到了Python,在2.x中,异常对象可以是任何对象,经常看到很多代码是直接raise一个字符串出来,因此就不能像Java那样方便的获取异常栈了,因为异常对象和异常栈是分开的。而多数Python语言的书籍上重点在于描述Python中如何构造异常对象和raise try except finally这些的使用,对调试程序起关键作用的stacktrace往往基本上不怎么涉及。

python中用于处理异常栈的模块是traceback模块,它提供了print_exception、format_exception等输出异常栈等常用的工具函数。

'''
遇到问题没人解答?小编创建一个Python学习交流qq群:857662006 
寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书!
'''
`def` `func(a, b):``    ``return` `a ``/` `b``if` `__name__ ``=``=` `'__main__'``:``    ``import` `sys``    ``import` `traceback``    ``try``:``        ``func(``1``, ``0``)``    ``except` `Exception as e:``        ``print` `"print exc"``        ``traceback.print_exc(``file``=``sys.stdout)`

输出结果:

print exc
Traceback (most recent call last):File "./teststacktrace.py", line 7, in <module>func(1, 0)File "./teststacktrace.py", line 2, in funcreturn a / b

其实traceback.print_exc()函数只是traceback.print_exception()函数的一个简写形式,而它们获取异常相关的数据都是通过sys.exc_info()函数得到的。

'''
遇到问题没人解答?小编创建一个Python学习交流qq群:857662006 
寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书!
'''
`def` `func(a, b):``    ``return` `a ``/` `b``if` `__name__ ``=``=` `'__main__'``:``    ``import` `sys``    ``import` `traceback``    ``try``:``        ``func(``1``, ``0``)``    ``except` `Exception as e:``        ``print` `"print_exception()"``        ``exc_type, exc_value, exc_tb ``=` `sys.exc_info()``        ``print` `'the exc type is:'``, exc_type``        ``print` `'the exc value is:'``, exc_value``        ``print` `'the exc tb is:'``, exc_tb``        ``traceback.print_exception(exc_type, exc_value, exc_tb)`

输出结果:

print_exception()
the exc type is: <type 'exceptions.ZeroDivisionError'>
the exc value is: integer division or modulo by zero
the exc tb is: <traceback object at 0x104e7d4d0>
Traceback (most recent call last):File "./teststacktrace.py", line 7, in <module>func(1, 0)File "./teststacktrace.py", line 2, in funcreturn a / b
ZeroDivisionError: integer division or modulo by zero

sys.exc_info()返回的值是一个元组,其中第一个元素,exc_type是异常的对象类型,exc_value是异常的值,exc_tb是一个traceback对象,对象中包含出错的行数、位置等数据。然后通过print_exception函数对这些异常数据进行整理输出。

traceback模块提供了extract_tb函数来更加详细的解释traceback对象所包含的数据:

'''
遇到问题没人解答?小编创建一个Python学习交流qq群:857662006 
寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书!
'''
def func(a, b):return a / b
if __name__ == '__main__':import sysimport tracebacktry:func(1, 0)except:_, _, exc_tb = sys.exc_info()for filename, linenum, funcname, source in traceback.extract_tb(exc_tb):print "%-23s:%s '%s' in %s()" % (filename, linenum, source, funcname)

输出结果:

`samchimac:tracebacktest samchi$ python .``/``teststacktrace.py``.``/``teststacktrace.py    :``7` `'func(1, 0)'` `in` `<module>()``.``/``teststacktrace.py    :``2` `'return a / b'` `in` `func()`

二、使用cgitb来简化异常调试

如果平时开发喜欢基于log的方式来调试,那么可能经常去做这样的事情,在log里面发现异常之后,因为信息不足,那么会再去额外加一些debug log来把相关变量的值输出。调试完毕之后再把这些debug log去掉。其实没必要这么麻烦,Python库中提供了cgitb模块来帮助做这些事情,它能够输出异常上下文所有相关变量的信息,不必每次自己再去手动加debug log。

cgitb的使用简单的不能想象:

'''
遇到问题没人解答?小编创建一个Python学习交流qq群:857662006 
寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书!
'''
`def` `func(a, b):``        ``return` `a ``/` `b``if` `__name__ ``=``=` `'__main__'``:``        ``import` `cgitb``        ``cgitb.enable(``format``=``'text'``)``        ``import` `sys``        ``import` `traceback``        ``func(``1``, ``0``)`

运行之后就会得到详细的数据:

`A problem occurred ``in` `a Python script.  Here ``is` `the sequence of``function calls leading up to the error, ``in` `the order they occurred.` ` ``/``Users``/``samchi``/``Documents``/``workspace``/``tracebacktest``/``teststacktrace.py ``in` `<module>()``    ``4`   `import` `cgitb``    ``5`   `cgitb.enable(``format``=``'text'``)``    ``6`   `import` `sys``    ``7`   `import` `traceback``    ``8`   `func(``1``, ``0``)``func ``=` `<function func>` ` ``/``Users``/``samchi``/``Documents``/``workspace``/``tracebacktest``/``teststacktrace.py ``in` `func(a``=``1``, b``=``0``)``    ``2`   `return` `a ``/` `b``    ``3` `if` `__name__ ``=``=` `'__main__'``:``    ``4`   `import` `cgitb``    ``5`   `cgitb.enable(``format``=``'text'``)``    ``6`   `import` `sys``a ``=` `1``b ``=` `0`

完全不必再去log.debug(“a=%d” % a)了,个人感觉cgitb在线上环境不适合使用,适合在开发的过程中进行调试,非常的方便。

也许你会问,cgitb为什么会这么屌?能获取这么详细的出错信息?其实它的工作原理同它的使用方式一样的简单,它只是覆盖了默认的sys.excepthook函数,sys.excepthook是一个默认的全局异常拦截器,可以尝试去自行对它修改:

'''
遇到问题没人解答?小编创建一个Python学习交流qq群:857662006 
寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书!
'''
`def` `func(a, b):``        ``return` `a ``/` `b``def` `my_exception_handler(exc_type, exc_value, exc_tb):``        ``print` `"i caught the exception:"``, exc_type``        ``while` `exc_tb:``                ``print` `"the line no:"``, exc_tb.tb_lineno``                ``print` `"the frame locals:"``, exc_tb.tb_frame.f_locals``                ``exc_tb ``=` `exc_tb.tb_next`` ` `if` `__name__ ``=``=` `'__main__'``:``        ``import` `sys``        ``sys.excepthook ``=` `my_exception_handler``        ``import` `traceback``        ``func(``1``, ``0``)`

输出结果:

`i caught the exception: <``type` `'exceptions.ZeroDivisionError'``>``the line no: ``14``the frame ``locals``: {``'my_exception_handler'``: <function my_exception_handler at ``0x100e04aa0``>, ``'__builtins__'``: <module ``'__builtin__'` `(built``-``in``)>, ``'__file__'``: ``'./teststacktrace.py'``, ``'traceback'``: <module ``'traceback'` `from` `'/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/traceback.pyc'``>, ``'__package__'``: ``None``, ``'sys'``: <module ``'sys'` `(built``-``in``)>, ``'func'``: <function func at ``0x100e04320``>, ``'__name__'``: ``'__main__'``, ``'__doc__'``: ``None``}``the line no: ``2``the frame ``locals``: {``'a'``: ``1``, ``'b'``: ``0``}`

看到没有?没有什么神奇的东西,只是从stack frame对象中获取的相关变量的值。frame对象中还有很多神奇的属性,就不一一探索了。

三、使用logging模块来记录异常

在使用Java的时候,用log4j记录异常很简单,只要把Exception对象传递给log.error方法就可以了,但是在Python中就不行了,如果直接传递异常对象给log.error,那么只会在log里面出现一行异常对象的值。

在Python中正确的记录Log方式应该是这样的:

`logging.exception(ex)``logging.error(ex, exc_info``=``1``) ``# 指名输出栈踪迹, logging.exception的内部也是包了一层此做法``logging.critical(ex, exc_info``=``1``) ``# 更加严重的错误级别`

这篇关于Python中traceback错误堆栈信息处理的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/548206

相关文章

python常见环境管理工具超全解析

《python常见环境管理工具超全解析》在Python开发中,管理多个项目及其依赖项通常是一个挑战,下面:本文主要介绍python常见环境管理工具的相关资料,文中通过代码介绍的非常详细,需要的朋友... 目录1. conda2. pip3. uvuv 工具自动创建和管理环境的特点4. setup.py5.

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

Python UV安装、升级、卸载详细步骤记录

《PythonUV安装、升级、卸载详细步骤记录》:本文主要介绍PythonUV安装、升级、卸载的详细步骤,uv是Astral推出的下一代Python包与项目管理器,主打单一可执行文件、极致性能... 目录安装检查升级设置自动补全卸载UV 命令总结 官方文档详见:https://docs.astral.sh/

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象(如模块、类、函数等)的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(

Python虚拟环境与Conda使用指南分享

《Python虚拟环境与Conda使用指南分享》:本文主要介绍Python虚拟环境与Conda使用指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、python 虚拟环境概述1.1 什么是虚拟环境1.2 为什么需要虚拟环境二、Python 内置的虚拟环境工具

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部

Python pip下载包及所有依赖到指定文件夹的步骤说明

《Pythonpip下载包及所有依赖到指定文件夹的步骤说明》为了方便开发和部署,我们常常需要将Python项目所依赖的第三方包导出到本地文件夹中,:本文主要介绍Pythonpip下载包及所有依... 目录步骤说明命令格式示例参数说明离线安装方法注意事项总结要使用pip下载包及其所有依赖到指定文件夹,请按照以

Python实现精准提取 PDF中的文本,表格与图片

《Python实现精准提取PDF中的文本,表格与图片》在实际的系统开发中,处理PDF文件不仅限于读取整页文本,还有提取文档中的表格数据,图片或特定区域的内容,下面我们来看看如何使用Python实... 目录安装 python 库提取 PDF 文本内容:获取整页文本与指定区域内容获取页面上的所有文本内容获取

基于Python实现一个Windows Tree命令工具

《基于Python实现一个WindowsTree命令工具》今天想要在Windows平台的CMD命令终端窗口中使用像Linux下的tree命令,打印一下目录结构层级树,然而还真有tree命令,但是发现... 目录引言实现代码使用说明可用选项示例用法功能特点添加到环境变量方法一:创建批处理文件并添加到PATH1