Python logging模块使用示例详解

 更新时间:2025年05月17日 09:26:15   作者:漫谈网络  
Python 的 logging 模块是一个灵活且强大的日志记录工具,广泛应用于应用程序的调试、运行监控和问题排查,下面给大家介绍Python logging模块使用指南,感兴趣的朋友一起看看吧

Python 的 logging 模块是一个灵活且强大的日志记录工具,广泛应用于应用程序的调试、运行监控和问题排查。它提供了丰富的功能,包括多级日志记录、多种输出方式、灵活的格式配置等。以下是详细介绍:

一、为什么使用 logging 模块?

  • 替代 printprint 语句仅适合简单调试,而 logging 支持持久化、级别控制、异步写入等。
  • 分级日志:根据重要性区分日志(如 DEBUG、INFO、ERROR),便于过滤信息。
  • 灵活输出:可同时输出到控制台、文件、网络等。
  • 线程安全:适用于多线程/多进程环境。

二、核心组件

Logger(记录器)
应用程序直接调用的接口,负责产生日志。

  • 通过 logging.getLogger(name) 获取或创建 Logger 实例。
  • 支持层级结构(如 'parent.child' 继承父级配置)。

Handler(处理器)
决定日志的输出位置(如控制台、文件、邮件等)。

  • 常用 Handler:
    • StreamHandler:输出到流(如控制台)。
    • FileHandler:输出到文件。
    • RotatingFileHandler:按大小滚动日志文件。
    • TimedRotatingFileHandler:按时间滚动日志文件。
    • SMTPHandler:发送邮件。

Filter(过滤器)
提供更细粒度的日志过滤(如仅记录特定关键词的日志)。

Formatter(格式器)
定义日志的输出格式(时间、级别、消息等)。

常用格式字段:

'%(asctime)s - %(name)s - %(levelname)s - %(message)s'

三、日志级别

从低到高共 6 个级别(低于设定级别的日志将被忽略):

级别数值说明
DEBUG10详细调试信息
INFO20程序正常运行信息
WARNING30潜在问题,但程序仍运行
ERROR40严重错误,影响部分功能
CRITICAL50致命错误,可能导致程序终止

四、基本使用步骤

创建 Logger

import logging
logger = logging.getLogger(__name__)  # 推荐使用模块名作为Logger名称
logger.setLevel(logging.DEBUG)        # 设置记录的最低级别

配置 Handler 和 Formatter

# 创建控制台 Handler
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.WARNING)  # 控制台只输出 WARNING 及以上级别
# 创建文件 Handler
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.DEBUG)      # 文件记录所有 DEBUG 及以上级别
# 定义 Formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
# 将 Handler 添加到 Logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)

记录日志

logger.debug('Debug 信息')
logger.info('程序启动')
logger.warning('磁盘空间不足')
logger.error('请求超时')

五、快速配置(basicConfig)

适用于简单场景的快速配置:

import logging
logging.basicConfig(
    level=logging.INFO,
    format='%(asctime)s - %(levelname)s - %(message)s',
    handlers=[
        logging.FileHandler('app.log'),
        logging.StreamHandler()
    ]
)
logging.warning('警告信息')

六、高级用法

配置文件或字典
使用 logging.config 模块通过文件或字典配置:

import logging.config
config = {
    'version': 1,
    'formatters': {
        'default': {'format': '%(asctime)s - %(levelname)s - %(message)s'}
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'default',
            'level': 'DEBUG'
        }
    },
    'root': {
        'handlers': ['console'],
        'level': 'INFO'
    }
}
logging.config.dictConfig(config)

捕获异常信息
使用 logger.exception 记录异常堆栈:

try:
    1 / 0
except Exception:
    logger.exception('发生异常:')

日志传播
子 Logger 默认将日志传递给父 Logger。可通过 logger.propagate = False 关闭。

七、常见问题

重复日志
原因:多次添加 Handler 或 basicConfig 被多次调用。
解决:确保 Handler 只添加一次,或在 basicConfig 中设置 force=True

性能优化
避免在高频代码中记录低级别日志(如 DEBUG),可预先检查级别:

if logger.isEnabledFor(logging.DEBUG):
    logger.debug(f'耗时操作: {time_consuming()}')

八、总结

logging 模块通过灵活的配置和分级机制,满足了从简单到复杂的日志需求。掌握其核心组件(Logger、Handler、Formatter)和级别控制,能显著提升程序的可维护性。建议在项目中替代 print,合理利用日志进行调试和监控。

到此这篇关于Python logging模块使用示例详解的文章就介绍到这了,更多相关Python logging模块使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Python实现排序算法、查找算法和图遍历算法实例

    Python实现排序算法、查找算法和图遍历算法实例

    这篇文章主要介绍了Python实现排序算法、查找算法和图遍历算法实例,排序算法、查找算法和图遍历算法是计算机科学中常见且重要的算法。它们在数据处理、搜索和图结构等领域发挥着关键作用,需要的朋友可以参考下
    2023-08-08
  • pycharm 关掉syntax检查操作

    pycharm 关掉syntax检查操作

    这篇文章主要介绍了pycharm 关掉syntax检查操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-06-06
  • Python 字符串处理特殊空格\xc2\xa0\t\n Non-breaking space

    Python 字符串处理特殊空格\xc2\xa0\t\n Non-breaking space

    今天遇到一个问题,使用python的find函数寻找字符串中的第一个空格时没有找到正确的位置,下面是解决方法,需要的朋友可以参考下
    2020-02-02
  • 基于Pytorch实现分类器的示例详解

    基于Pytorch实现分类器的示例详解

    这篇文章主要为大家详细介绍了如何基于Pytorch实现两个分类器: softmax分类器和感知机分类器,文中的示例代码讲解详细,需要的可以参考一下
    2023-04-04
  • Python文件路径模式匹配glob模块使用详解

    Python文件路径模式匹配glob模块使用详解

    这篇文章主要介绍了Python文件路径模式匹配glob模块使用的相关资料,glob模块是Python中用于文件和目录查找的工具,支持使用通配符进行模糊匹配,它可以处理简单的文件名模式,并通过glob和iglob两个函数实现文件路径的模式匹配,需要的朋友可以参考下
    2025-04-04
  • python实现自动发送邮件发送多人、群发、多附件的示例

    python实现自动发送邮件发送多人、群发、多附件的示例

    下面小编就为大家分享一篇python实现自动发送邮件发送多人、群发、多附件的示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-01-01
  • Python删除windows垃圾文件的方法

    Python删除windows垃圾文件的方法

    这篇文章主要介绍了Python删除windows垃圾文件的方法,涉及Python针对系统垃圾文件的查找与清理技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • Python字典实现简单的三级菜单(实例讲解)

    Python字典实现简单的三级菜单(实例讲解)

    下面小编就为大家带来一篇Python字典实现简单的三级菜单(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • 利用Python进行数据清洗的操作指南

    利用Python进行数据清洗的操作指南

    数据清洗是指发现并纠正数据文件中可识别的错误的最后一道程序,包括检查数据一致性,处理无效值和缺失值等。本文为大家介绍了Python进行数据清洗的操作详解,需要的可以参考一下
    2022-03-03
  • Python docx库代码演示

    Python docx库代码演示

    这篇文章主要介绍了Python docx库用法,结合实例形式分析了docx库相关的docx文件读取、文本添加、格式操作,需要的朋友可以参考下
    2021-10-10

最新评论