Python异常处理进阶：利用traceback模块获取完整堆栈信息

在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对象

Python程序产生的所有回溯（traceback）信息均源自一个名为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()函数返回了一个包含当前异常相关信息的元组。该元组的第一个元素是异常的类型（如示例中的NameError），第二个元素是异常的value值，而第三个元素则是我们后续处理所需的关键对象——traceback object。

一旦获得了traceback object，我们就可以利用traceback模块来提取、格式化并打印详细的回溯信息。接下来，我们将详细介绍traceback模块中常用的几个函数。

traceback模块

Python的traceback模块提供了一套完整的接口，用于提取、格式化和打印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打印的异常信息更加详细，包含了具体的文件路径、行号以及调用函数。接下来我们详细解析print_tb函数的定义：

traceback.print_tb(tb[, limit[, file]])

• tb：即traceback object，通常通过sys.exc_info()获取。
• limit：用于限制打印的堆栈跟踪层级数。如果未设置或设置为None，则打印所有层级的堆栈信息。
• file：指定打印输出的目标流，可以是文件对象或类似文件的对象（如stdout）。如果未设置或为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]])

1. 与print_tb相比，print_exception增加了etype和value两个参数，分别代表异常类型和异常值。加上tb（traceback object），这三个参数正好对应sys.exc_info()返回的元组内容。
2. 此外，与print_tb相比，print_exception的输出信息更为完整：开头包含“Traceback (most...)”提示，末尾则显示了异常类型和具体的value值。
3. 另一个显著区别是，当异常类型为SyntaxError时，print_exception会在输出中使用“^”符号来精确指示语法错误发生的位置。

print_exc

print_exc是print_exception的简化版本。由于异常类型、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将异常记录到日志文件中。此时，format_exc函数便派上用场。它也是最常用的函数之一，用法与print_exc相同，区别在于它不直接打印结果，而是返回一个包含格式化后异常信息的字符串。

traceback模块中还有其他一些函数，但由于使用频率较低，此处不再展开。感兴趣的读者可以参考链接中的官方文档。

获取线程中的异常信息

在多线程编程中，子线程抛出的异常通常无法直接传递回主线程，导致主线程无法捕获并打印这些异常。利用上述知识，我们可以对线程类进行适当修改，从而实现捕获并抛出子线程异常的功能。

以下示例源自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

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。