Python里logging模块配置 Python标准日志模块logging最佳实践

pythonLogging模块的正确使用方法包括:1.基础配置,设置日志级别和格式;2.使用logger对象区分模块来源并单独控制日志级别;3.添加filehandler将日志写入文件并保留控制台输出;4.上线前关闭debug日志、用模块名命名logger、避免在库代码中配置logging、使用dictconfig做复杂配置。logging.basicconfig设置级别和格式,logger = logging.getlogger(__name__)创建模块logger,同时添加streamhandler和filehandler实现多输出,并通过setlevel控制不同模块或全局的日志级别,确保日志结构清晰且便于维护。

python项目中,logging模块是记录日志的首选工具。它灵活、功能强大,但很多人用不好,导致日志信息混乱、缺失或难以维护。配置好logging,不仅能帮助排查问题,还能提升系统的可观测性。

基本配置:别再用print

刚开始用logging时,很多人直接logging.info(“something”),这样虽然比print强点,但远远不够。建议一开始就做基础配置:

import logging logging.basicConfig(level=logging.INFO)

这一步设定了最低日志级别为INFO,意味着DEBUG级别的日志不会显示。如果你希望看到更详细的日志,可以改成DEBUG;如果只关心错误,可以设成WARNING。

另外,建议设置格式和时间戳,比如:

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

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

这样每条日志都有时间、级别和内容,看起来清晰多了。

使用logger而不是直接调用logging

很多人习惯直接使用logging.info()这样的写法,但在实际项目中,尤其是多个模块协同工作时,应该使用logger对象。例如:

logger = logging.getLogger(__name__) logger.info("This is an info log")

好处有几个:

  • 每个模块有自己的logger,便于区分来源
  • 可以单独控制不同模块的日志级别
  • 更容易添加handler、formatter等高级配置

举个例子,你有两个模块main.py和utils.py,分别获取各自的logger:

# main.py logger = logging.getLogger(__name__)  # __name__ 是 'main'  # utils.py logger = logging.getLogger(__name__)  # __name__ 是 'utils'

之后你可以单独设置某个模块的日志级别,比如让utils输出DEBUG级别的日志,而main只输出INFO以上:

logging.getLogger('utils').setLevel(logging.DEBUG)

把日志写入文件,同时保留控制台输出

开发时看控制台没问题,但上线后通常需要把日志保存下来。这时候就需要添加FileHandler。

一个典型的配置方式如下:

import logging  logger = logging.getLogger(__name__) logger.setLevel(logging.INFO)  # 控制台输出 console_handler = logging.StreamHandler() console_handler.setLevel(logging.INFO)  # 文件输出 file_handler = logging.FileHandler('app.log') file_handler.setLevel(logging.INFO)  # 设置格式 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') console_handler.setFormatter(formatter) file_handler.setFormatter(formatter)  # 添加到logger logger.addHandler(console_handler) logger.addHandler(file_handler)

这样你的日志就会同时出现在终端和文件里,结构清晰、方便查看。

注意:如果你用了多个handler,记得不要重复添加,否则可能出现日志重复打印的问题。可以通过logger.handlers检查当前绑定的handler。

此外,还可以考虑使用RotatingFileHandler或TimedRotatingFileHandler来实现日志滚动,避免单个日志文件过大或过久。

最后几点小建议

  • 别忘了关闭DEBUG日志:上线前确保日志级别不是DEBUG,避免产生大量无用信息。
  • 命名logger时尽量用模块名:像logging.getLogger(__name__)这种做法能保证层级清晰。
  • 避免在库代码中配置logging:作为第三方库开发者,不应该主动配置root logger,而是让使用者去统一管理。
  • 可以用dictConfig做更复杂的配置:对于大型项目,用字典形式配置logging会更清晰、易维护。

基本上就这些。logging不算难,但细节不少,稍不注意就踩坑。掌握这几个关键点,基本就能应付大多数场景了。

© 版权声明
THE END
喜欢就支持一下吧
点赞14 分享