Python logging 日志模块正确使用方式

3次阅读

python Logging模块需统一配置而非在模块中调用basicconfig();各模块应使用logging.getlogger(__name__)获取命名logger,通过propagate和setlevel精细控制日志流向与级别,并用exception()记录带traceback的异常。

Python logging 日志模块正确使用方式

Python 的 logging 模块不是“print 的高级替代品”,而是需要合理配置才能真正发挥作用的系统级工具。核心原则是:不要在模块顶层直接调用 logging.basicConfig(),避免日志被重复初始化或覆盖;每个模块应使用 logging.getLogger(__name__) 获取命名 logger;日志级别、输出目标和格式应在程序入口(如 main() 或启动脚本)统一配置。

避免在模块中调用 basicConfig()

basicConfig() 只有在 root logger 尚未配置时才生效,且只能生效一次。如果多个模块各自调用,只有第一个生效,后续会被静默忽略——这会导致日志不输出、级别不生效、格式错乱等隐蔽问题。

  • ❌ 错误示例(在 utils.py 中):

import logging<br>logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')  # 不要这样写

  • ✅ 正确做法:所有配置集中在应用启动处,比如 app.py__main__.py

import logging<br><br>if __name__ == '__main__':<br>    logging.basicConfig(<br>        level=logging.DEBUG,<br>        format='%(asctime)s [%(name)s] %(levelname)-8s %(message)s',<br>        handlers=[<br>            logging.StreamHandler(),<br>            logging.FileHandler('app.log', encoding='utf-8')<br>        ]<br>    )<br>    # 启动主逻辑<br>    main()

按模块命名获取 logger,不共用 root

使用 logging.getLogger(__name__) 能自动继承 root logger 的配置,同时支持独立设置级别、添加专属 handler,便于后期按模块开关日志或分流输出。

import logging<br><br>logger = logging.getLogger(__name__)  # 名为 'database'<br><br>def connect():<br>    logger.debug('Connecting to DB...')<br>    logger.info('Connected successfully')

  • api/handler.py 中:

logger = logging.getLogger(__name__)  # 名为 'api.handler'<br>logger.warning('Rate limit exceeded for user: %s', user_id)

这样终端里就能看到带模块前缀的日志:2024-05-20 10:30:12 [api.handler] WARNING Rate limit exceeded...

立即学习Python免费学习笔记(深入)”;

谨慎使用 logger.setLevel() 和 propagate

子 logger 默认 propagate=True,即日志会逐级向上传递到父 logger(最终到 root)。若某个模块想屏蔽日志,不要设 logger.setLevel(logging.CRITICAL),而应设 logger.propagate = False 或调整 root 级别。

  • 常见需求与写法:
  • 仅关闭某模块日志: logging.getLogger('third_party_lib').setLevel(logging.WARNING)
  • 让某模块日志不打印到控制台(但保留文件输出):给它单独加 FileHandler,并设 propagate=False
  • 临时提高调试粒度:运行时执行 logging.getLogger('database').setLevel(logging.DEBUG)

记录异常要带完整上下文

logger.exception()logger.Error('msg', exc_info=True),而不是手动拼接 str(e) ——前者会自动附加 traceback,包含行号、函数名、变量状态,对排障至关重要。

try:<br>    risky_operation()<br>except ValueError as e:<br>    logger.exception('Failed to process input')  # ✅ 自动记录 traceback<br>    # 不要写成:logger.error('Failed: %s', str(e))  ❌

text=ZqhQzanResources