告别低效的print调试！这3个Debug技巧让你效率翻倍

告别低效的print调试！这3个Debug技巧让你效率翻倍

引用

CSDN

1.

https://blog.csdn.net/w646645452/article/details/145886214

在Python开发中，调试是不可避免的环节。传统的print调试虽然简单直接，但效率低下且难以维护。本文将介绍三种更高效的调试方法：断点调试、日志系统和PySnooper，帮助开发者提升调试效率，让程序问题无处遁形。

1. 断点调试：让代码进入子弹时间

断点调试是开发者最常用的调试工具，它让程序在指定位置暂停，逐行观察变量状态和执行路径，是定位问题的利器。

1.1 为何断点调试碾压print？

使用断点调试时，请使用IDE工具，本文以Pycharm为例，其他IDE工具与此类似。

1.2 断点调试三步法

1. 设置断点：在代码行号左侧点击出现红点。
2. 启动调试：鼠标右击，调试或者点击右上角小昆虫的图标即可DEBUG
   
3. 逐行探查：

• 调试时代码会在断点（红点）处暂停，并显示执行过程中变量具体的值；
• 点击下方控制栏中的小箭头可以逐行查看代码执行效果，或者撤销执行，也可以快速执行到下一个断点处；
• 控制栏处也会记录每次循环中的变量类型和变量值，方便查看！

2. 日志系统：程序运行的黑匣子

Logging是Python标准库中的日志记录工具，用于替代print调试，提供更专业、灵活的日志管理功能。

2.1 日志 vs print：

# print调试（业余版）
print(f"当前用户ID: {user_id}，操作状态: {status}")
# 日志系统（专业版）
import logging
logger.info("用户操作审计", extra={"user_id": 123, "status": "SUCCESS"})

核心优势：

1. 分级管控：从DEBUG开发细节到CRITICAL系统崩溃，按需过滤信息
2. 持久化存储：自动写入文件，避免终端输出被冲刷丢失
3. 结构化输出：支持JSON格式，方便接入ELK等日志分析平台
4. 线程/进程安全：多任务环境下精准记录操作时序

2.2 日志配置模板

import logging
logging.basicConfig(
    level=logging.DEBUG,  # 设置日志级别
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',  # 日志格式
    handlers=[
        logging.FileHandler("app.log"),  # 输出到文件
        logging.StreamHandler()          # 输出到终端
    ]
)
# 记录日志
logging.debug("这是一条调试信息")
logging.info("这是一条普通信息")
logging.warning("这是一条警告信息")
logging.error("这是一条错误信息")
logging.critical("这是一条严重错误信息")

核心参数：

• 参数名：类型、默认值、作用
• level：int或str、logging.WARNING、设置日志级别，低于该级别的日志将被忽略。
• format：str、%(message)s、定义日志输出格式
• handlers：list、[]、日志处理器列表，常用处理器
• datefmt：str、None、定义时间格式，如"%Y-%m-%d %H:%M:%S"
• encoding：str、None、日志文件编码，如"utf-8"

日志级别：从低到高分为以下5级，我们可以对错误进行分级调试，仅展示错误类型。

• 级别：数值、使用场景
• DEBUG：10、调试信息，记录程序运行的详细细节
• INFO：20、普通信息，记录程序关键操作（如用户登录、数据更新）
• WARNING：30、警告信息，记录潜在问题（如参数缺失、配置异常）
• ERROR：40、错误信息，记录功能异常（如数据库连接失败、文件读取错误）
• CRITICAL：50、严重错误，记录系统崩溃或不可恢复的故障

我们用一个除0计算作为示例

import logging
#基础日志配置
logging.basicConfig(
    level=logging.DEBUG,
    format='%(levelname)s - %(message)s',
    handlers=[
        logging.FileHandler("error.log"),
        logging.StreamHandler()
    ]
)
#关键函数，用日志记录错误
def divide(x, y):
    try:
        logging.debug(f"尝试计算 {x}/{y}")
        result = x / y
        logging.info(f"计算结果: {result}")
        return result
    except ZeroDivisionError as e:
        logging.error("除零错误！", exc_info=True)  # 记录完整异常堆栈
        raise
#触发错误
divide(10, 0)  # 此调用会抛出错误并被日志捕获

由于进行了除0计算，代码肯定会报错，日志系统能够完整的记录对应的错误类型、内容、时间，长期保存。

3. PySnooper：让代码自动调试

PySnooper是一个通过装饰器自动记录代码执行过程的Python调试工具，让你不用写print也能看透代码的每一步操作。

特点：

• 自动追踪变量变化
• 可视化代码执行路径
• 捕获异常堆栈信息

3.1 PySnooper vs print调试对比

3.2 具体使用方法

安装：

pip install pysnooper

使用方法：
在代码前面加一段装饰器，然后将你需要关注的变量加入监控列表，就能自动记录。

import pysnooper
@pysnooper.snoop(
    output="debug.log",  # 输出到文件
    watch=("number", "sum")  # 监控关键变量
)

我们用一个经典的猜数字游戏来举例：

"""
@file: PySnooper测试.py.py
@author: lingxiaotian
@date: 2025/2/26 18:08
"""
# Copyright (c) 2025, 凌小添
# All rights reserved.
import pysnooper
import random
@pysnooper.snoop(
    color=False,
    output="game_debug.log",  # 输出到文件
    watch=("target_number", "guess_count")  # 监控关键变量
)
def guess_number_game():
    target_number = random.randint(1, 5)
    guess_count = 0
    print("欢迎来到猜数字游戏！数字在1~5之间")
    while True:
        user_input = input("请输入你的猜测：")
        guess_count += 1
        if not user_input.isdigit():
            raise ValueError("必须输入数字！")
        guess = int(user_input)
        if guess == target_number:
            print(f"恭喜！你用了 {guess_count} 次猜中答案 {target_number}")
            break
        elif guess < target_number:
            print("猜小了，再试试！")
        else:
            print("猜大了，再试试！")
# 启动游戏
guess_number_game()

代码运行后，pysnooper模块会自动记录时间点和监控变量值的变化情况。

4. 小结

本文三大调试方法对比

⚠️ 注意事项：

1. 断点调试：

• 避免设置过多断点，影响执行效率

2. 日志系统：

• 生产环境使用WARNING及以上级别，避免日志爆炸
• 启用日志轮转（RotatingFileHandler）防止磁盘占满

3. PySnooper：

• 调试完成后及时移除装饰器，避免性能损耗
• 复杂场景推荐结合日志系统使用