引言
Python logging 模块是一种强大的工具,可用于记录应用程序中发生的事件。它提供了一个灵活且易于使用的框架,用于管理和记录各种日志消息,包括信息、警告、错误等。本文将深入探讨 Python logging 模块,从基础概念到高级用法,并提供清晰的示例代码来展示其强大功能。
基础概念
- 日志记录器: 代表应用程序特定部分的日志记录器对象。
- 日志级别: 日志消息的严重性级别,例如 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。
- 处理程序: 用于将日志消息发送到控制台、文件或其他目标。
- 格式器: 用于自定义日志消息的格式。
配置 Logging 模块
要开始使用 logging 模块,必须先对日志记录器进行配置。这可以通过以下方式实现:
import logging
# 创建一个新的日志记录器
logger = logging.getLogger("my_logger")
# 设置日志级别
logger.setLevel(logging.INFO)
# 添加处理程序
handler = logging.StreamHandler()
logger.addHandler(handler)
# 设置格式器
formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)
使用 Logging 模块
配置日志记录器后,可以使用 logger.log()
方法记录消息:
logger.info("Application started")
logger.warning("Something went wrong")
这些消息将根据配置的日志级别和格式发送到指定的处理程序。
自定义日志级别
除了内置日志级别外,还可以自定义日志级别:
import logging
# 定义新日志级别
CUSTOM_LEVEL = 15
# 将自定义级别添加到日志记录器
logging.addLevelName(CUSTOM_LEVEL, "CUSTOM")
# 设置日志记录器使用自定义级别
logger.setLevel(CUSTOM_LEVEL)
现在可以使用自定义日志级别来记录消息:
logger.log(CUSTOM_LEVEL, "Custom message")
高级用法
- 分级日志: 允许创建继承自父日志记录器的子日志记录器,从而实现分层日志。
- 多线程日志: 使用
logging.handlers.QueueHandler
可以实现多线程日志,以防止日志消息丢失。 - 自定义过滤器: 使用
logging.Filter
类可以过滤日志消息,只发送符合特定条件的消息。 - 日志旋转: 使用
logging.handlers.RotatingFileHandler
可以自动旋转日志文件,以避免文件过大。
示例代码
以下示例展示了高级日志用法:
import logging
# 创建一个父日志记录器
logger = logging.getLogger("my_app")
# 创建一个子日志记录器
sub_logger = logging.getLogger("my_app.sub_module")
# 设置父日志记录器级别
logger.setLevel(logging.INFO)
# 为子日志记录器添加处理程序
sub_logger_handler = logging.StreamHandler()
sub_logger_handler.setFormatter(logging.Formatter("%(asctime)s - %(name)s - %(message)s"))
sub_logger.addHandler(sub_logger_handler)
# 添加过滤器,只发送子日志记录器消息
sub_logger_filter = logging.Filter()
sub_logger_filter.filter = lambda record: record.name == "my_app.sub_module"
sub_logger.addFilter(sub_logger_filter)
# 记录消息
logger.info("Application started")
sub_logger.info("Sub-module started")
结论
Python logging 模块是一个强大而灵活的工具,用于记录应用程序中的事件。通过理解其基础概念和高级用法,可以有效地管理和记录日志消息,从而提高应用程序的可维护性和可调试性。本文概述了 logging 模块的主要功能,并提供了清晰的示例代码,帮助读者充分利用其功能。