Python 异常处理与日志记录实战：traceback 与 logging 模块详解

Python 异常处理机制基础

Python 提供了完善的内置异常处理机制，核心语法结构为 try...except...finally。理解这一机制是进行有效错误处理的前提：

• 继承关系：所有错误类均继承自 BaseException。
• 捕获规则：except 会捕获指定类型及其子类错误。
• 未捕获行为：若异常未被捕获，会向上抛出至解释器，解释器打印错误堆栈信息后退出程序。
• 调试技巧：查找错误时，应先看错误类型，再从下往上分析调用栈。

值得注意的是，仅使用异常捕获（try...except）不会自动打印错误堆栈信息；而不使用异常捕获则会导致程序直接结束。通过异常记录，开发者可以同时打印错误类型和堆栈信息，并使程序在处理后继续执行。

错误类的定义与使用

在 Python 中，错误本质上是一个 class，捕获即获取该 class 的实例。错误需有意创建并抛出，内置函数会抛出多种类型的错误，自定义函数也可通过 raise 抛出错误实例。抛出错误前需定义错误的 class，且定义时需选择好继承关系。

常见内置错误类型

• AttributeError：访问对象没有的属性。
• IoError：输入输出异常或无法打开文件。
• IndentationError：代码没有对齐的语法错误。
• KeyError：访问的 key 在字典中不存在。
• NameError：使用未赋值的对象变量。
• TypeError：传入对象类型不合法。
• ValueError：传入了调用者不期望的值。

建议优先使用 Python 已有的内置错误类型，仅在必要时才定义自己的错误类型。

将异常堆栈写入日志文件的方案

当程序发生异常时，我们通常希望记录详细的错误堆栈信息以便后续排查。以下是两种常用方案：

方案一：手动写入文件

利用 traceback 模块获取堆栈信息，并手动将其写入文件。这种方式灵活但需要处理文件的打开、写入和关闭操作。

import traceback
import logging
 
logging.basicConfig(filename='log.txt', level=logging.DEBUG,
     format='%(asctime)s - %(levelname)s - %(message)s')
 
try:
 raise Exception('发生异常错误信息')
except:
 #方案一，自己定义一个文件，自己把错误堆栈信息写入文件。
 #errorFile = open('log.txt', 'a')
 #errorFile.write(traceback.format_exc())
 #errorFile.close()
 
 #方案二，使用Python标准日志管理维护工具。
 logging.debug(traceback.format_exc())

方案二：使用 logging 模块（推荐）

Python 标准日志管理工具 logging 提供了更简洁的方式。通过 logging.exception()，可以在记录异常的同时自动附加堆栈跟踪信息。

import logging

def foo(s):
    return 10/int(s)

def bar(s):
    return foo(s)*2

def main():
    try:
        bar('0')
    except Exception as e:
        logging.exception(e)

main()
print("END")

此方案的优势在于：logging.exception() 会自动记录当前异常的详细信息，包括调用栈，无需手动调用 traceback.format_exc()。同时，程序在记录异常后仍可继续执行（如打印 "END"）。

自定义异常类的实战示例

在特定业务场景下，可能需要定义自定义异常类。以下示例展示了如何定义 FooError 并在 foo 函数中抛出：

class FooError(ValueError):
    pass

def foo(s):
    n = int(s)
    if n == 0:
        raise FooError("invalid value :%s" % s)
    return 10/n

foo('0')

在此示例中，FooError 继承自 ValueError。当传入值为 '0' 时，函数抛出 FooError 异常，并附带错误信息。这体现了自定义异常类在明确错误语义方面的作用。

总结

通过本文的讲解，我们了解了 Python 异常处理的基本机制，并掌握了两种将异常堆栈信息写入日志文件的方法。推荐使用 logging.exception() 方案，因为它更简洁、标准，且能自动处理堆栈信息的记录。在实际开发中，合理运用异常处理和日志记录，能够显著提升程序的健壮性和可维护性。

以上就是使用Python将Exception异常错误堆栈信息写入日志文件的详细内容，更多关于Python异常处理与日志记录的资料请关注本站其它相关文章！