Python traceback模块详解：获取异常传播轨迹与日志记录

Python traceback模块概述

除了利用sys.exc_info()方法获取更详细的异常数据外，Python还提供了traceback模块。该模块专门用于查看异常的传播路径，帮助开发者追踪异常触发的具体源头。

异常传播轨迹示例

以下示例展示了如何显示异常的传播轨迹：

class SelfException(Exception):
  pass
def main():
  firstMethod()
def firstMethod():
  secondMethod()
def secondMethod():
  thirdMethod()
def thirdMethod():
  raise SelfException("自定义异常信息")
main()

在上述程序中，main()函数调用firstMethod()，firstMethod()接着调用secondMethod()，而secondMethod()又调用thirdMethod()。最终，thirdMethod()直接抛出了一个SelfException异常。运行该程序后，将看到如下输出结果：

Traceback (most recent call last):
 File "C:\Users\mengma\Desktop\1.py", line 11, in <module>
  main()
 File "C:\Users\mengma\Desktop\1.py", line 4, in main          <--mian函数
  firstMethod()
 File "C:\Users\mengma\Desktop\1.py", line 6, in firstMethod    <--第三个
  secondMethod()
 File "C:\Users\mengma\Desktop\1.py", line 8, in secondMethod  <--第二个
  thirdMethod()
 File "C:\Users\mengma\Desktop\1.py", line 10, in thirdMethod   <--异常源头
  raise SelfException("自定义异常信息")
SelfException: 自定义异常信息

从输出结果可以清晰地看出，异常始于thirdMethod()函数，随后依次传递至secondMethod()、firstMethod()，最终到达main()函数并在此终止。这一完整的传递过程即为异常的传播轨迹。

异常传播机制解析

在实际的应用程序开发中，复杂的业务逻辑通常被分解为一系列函数或方法调用。为了提高代码的可重用性，开发者会将可复用的代码单元封装为函数或方法，并将复杂任务拆解为更易管理的小型子任务。因此，大型业务功能往往由多个函数协同实现，对象间通过一系列函数或方法调用进行通信以完成任务。

因此，在应用程序运行时，经常会出现一系列函数或方法调用，形成所谓的“函数调用栈”。异常的传播方向则与此相反：只要异常未被完全捕获（包括未被捕获或捕获后重新引发新异常），它就会从发生异常的函数或方法逐渐向外扩散，先传递给该函数的调用者，再由调用者传递给其上层调用者，直至最终到达Python解释器。此时，Python解释器会中止程序运行，并打印出异常的传播轨迹信息。

许多初学者在看到输出结果中的异常提示信息时容易感到惊慌，误以为程序存在多处严重错误。实际上，这通常只对应一个错误，系统输出的多行信息仅仅是展示了异常依次触发的完整轨迹。

实际上，上述程序运算结果所显示的异常传播轨迹信息非常清晰，它记录了应用程序执行停止的各个关键点。最后一行信息详细列出了异常的类型及具体消息。从该行向上追溯，逐行记录了异常发生的源头、传播经过的路径，并明确标明了异常发生的文件、行号及函数名称。

traceback模块常用方法

使用traceback模块查看异常传播轨迹，首先需要导入该模块。该模块提供了两个常用方法：

• traceback.print_exc()：将异常传播轨迹信息输出到控制台或指定的文件中。
• format_exc()：将异常传播轨迹信息转换为字符串格式。

可能有读者会好奇，从上述方法签名中看不出它们具体处理哪个异常的传播轨迹。实际上，我们常用的print_exc()是print_exc([limit[, file]])省略了limit和file两个参数的简化形式。而print_exc([limit[, file]])的完整形式为print_exception(etype, value, tb[, limit[, file]])。在完整形式中，前三个参数分别用于指定异常的以下信息：

• etype：指定异常的类型；
• value：指定异常的值；
• tb：指定异常的traceback信息；

当程序处于except代码块中时，该块所捕获的异常信息可通过sys对象获取。其中，sys.exc_type、sys.exc_value、sys.exc_traceback分别代表当前except块内的异常类型、异常值和异常传播轨迹。

简而言之，print_exc([limit[, file]])相当于以下形式：

print_exception(sys.exc_etype, sys.exc_value, sys.exc_tb[, limit[, file]])

也就是说，使用print_exc([limit[, file]])会自动处理当前except块所捕获的异常。该方法还涉及两个可选参数：

limit：用于限制显示异常传播的层数。例如，若函数A调用函数B，且函数B发生异常，如果指定limit=1，则只显示函数A中发生的异常。若不设置limit参数，则默认显示全部信息。 file：指定将异常传播轨迹信息输出到指定的文件中。若不指定该参数，则默认输出到控制台。

异常信息输出至文件示例

借助traceback模块的帮助，我们可以使用except块捕获异常，并在其中打印异常传播信息，包括将其输出到文件中。例如以下程序：

# 导入trackback模块
import traceback
class SelfException(Exception): pass
def main():
  firstMethod()
def firstMethod():
  secondMethod()
def secondMethod():
  thirdMethod()
def thirdMethod():
  raise SelfException("自定义异常信息")
try:
  main()
except:
  # 捕捉异常，并将异常传播信息输出控制台
  traceback.print_exc()
  # 捕捉异常，并将异常传播信息输出指定文件中
  traceback.print_exc(file=open('log.txt', 'a'))

上述程序第一行首先导入了traceback模块。接下来，程序使用except捕获程序的异常，并使用traceback的print_exc()方法输出异常传播信息，分别将其输出到控制台和指定的文件中。

运行上述程序，同样可以在控制台看到异常传播信息的输出。此外，在程序目录下会生成一个log.txt文件，该文件中同样记录了异常传播的详细信息。

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