如何使用 Python 中的调试信息记录错误

Python 2周前 18

在开发过程中，出现错误是不可避免的。为了高效地定位和解决问题，我们需要在程序中添加调试信息来记录错误。Python 提供了多种方法来实现这个目标，本文将重点介绍如何使用 Python 中的调试信息来记录错误。

一、使用 print 语句输出调试信息

最简单直接的方法就是使用 print 语句来输出调试信息。通过在关键的代码位置插入 print 语句，我们可以在程序执行过程中输出变量的值、函数的调用信息等。

例如，我们有一个计算两个数之和的函数：

def add_numbers(a, b):
    print("调试信息：正在计算 {} 和 {} 的和".format(a, b))
    return a + b

在正常执行代码时，我们可以看到以下输出信息：

调试信息：正在计算 2 和 3 的和

这样，我们就可以确认函数是否按照预期调用，并且可以检查传递给函数的参数是否正确。

二、使用 assert 断言

除了使用 print 语句，还可以使用 assert 断言来定义预期的条件，如果条件不符合，则会抛出 AssertionError 异常。

例如，我们有一个函数用于计算两个数之差：

def subtract_numbers(a, b):
    assert isinstance(a, int), "参数 a 必须是整数"
    assert isinstance(b, int), "参数 b 必须是整数"
    return a - b

当传递给函数的参数不符合条件时，会抛出 AssertionError 异常，并输出错误信息：

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in subtract_numbers
AssertionError: 参数 a 必须是整数

通过使用 assert 断言，我们可以在程序执行过程中快速检查代码的正确性，并定位错误的位置。

三、使用 logging 模块记录调试信息

在开发大型项目时，使用 print 语句可能会导致大量的输出信息，而且难以控制。为了更好地管理调试信息，我们可以使用 Python 内置的 logging 模块。

首先，我们需要导入 logging 模块，并配置日志记录器：

import logging

logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')

然后，在需要记录调试信息的位置使用 logger 对象来输出日志：

def divide_numbers(a, b):
    try:
        result = a / b
    except ZeroDivisionError as e:
        logging.exception("除数 b 不能为 0")
    else:
        logging.info("计算结果为: {}".format(result))

通过调用 logging.exception() 可以记录异常信息，而调用 logging.info() 可以输出其他的调试信息。

以下是示例输出：

2022-01-01 10:00:00,000 - ERROR - 除数 b 不能为 0
Traceback (most recent call last):
  File "<stdin>", line 3, in divide_numbers
ZeroDivisionError: division by zero

2022-01-01 10:00:00,001 - INFO - 计算结果为: 0.5

通过使用 logging 模块，我们可以在不同级别记录不同类型的信息，方便日后排查问题。