如何在整个Python项目中通过顶层开关统一开启或关闭调试代码行？

核心原理 #

利用Python内置的__debug__常量特性：该常量在解释器启动时固定，普通启动模式下为True，使用python -O（优化模式）启动时自动设为False。优化模式下解释器会直接剔除所有if __debug__:代码块的内容，完全不会解析执行，没有任何运行时开销，完全适配高负载运算场景。

具体实现步骤 #

1. 顶层统一封装调试入口 #

在你项目的顶层包__init__.py中添加统一的调试配置，所有子模块统一从这里导入调试工具，方便全局管控：

# 顶层包__init__.py
import os

# 支持环境变量手动覆盖开关，不用改启动参数也能切换调试状态
DEBUG = __debug__ and os.getenv("YOUR_PROJECT_NAME_DEBUG", "0") == "1"

def debug_print(*args, **kwargs):
    if DEBUG:
        print(*args, **kwargs)

2. 全项目替换原有调试代码 #

• 简单的调试打印直接替换为debug_print调用即可
• 涉及计算、遍历等开销较大的调试逻辑，必须包裹在if DEBUG:代码块中，避免非调试状态下执行无意义的运算：

# 原有调试代码
# print("分批运算中间结果：", sum([x**3 for x in current_batch]))

# 替换后写法
from 顶层包名 import debug_print, DEBUG

if DEBUG:
    # 只有调试模式下才会执行这段计算逻辑
    mid_res = sum([x**3 for x in current_batch])
    debug_print("分批运算中间结果：", mid_res)

3. 一键启停调试 #

• 开启调试：设置环境变量YOUR_PROJECT_NAME_DEBUG=1后正常启动程序即可，所有调试逻辑正常运行
• 关闭调试（上线模式）：使用python -O 启动入口.py运行程序，此时所有调试代码会被解释器直接优化剔除，完全不会占用运行资源，性能和删除所有调试行的代码完全一致。

方案优势 #

• 完全满足零运行时开销的要求，比logging模块的等级过滤效率更高：logging即使关闭DEBUG等级，依然会执行日志函数调用逻辑，本方案在非调试模式下连函数调用都不会触发
• 全局统一管控，不用上线前手动删除调试代码，避免漏删、误删业务代码的问题
• 适配多包多模块的项目结构，所有模块统一导入顶层的调试工具即可，不用单独配置

内容的提问来源于stack exchange，提问作者Parth