Python 的 logging 模块是一个用于记录应用程序日志消息的标准模块。它非常强大且灵活,允许你记录各种级别的日志消息,并配置输出格式、日志的存储位置以及处理日志的不同方式。
以下是 logging 模块的基本介绍和用法。
def create_logger(log_file):
log_format = '%(asctime)s %(levelname)5s %(message)s'
logging.basicConfig(level=logging.INFO, format=log_format, filename=log_file)
console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(logging.Formatter(log_format))
logging.getLogger(__name__).addHandler(console)
return logging.getLogger(__name__)
日志级别
logging 模块定义了以下标准日志级别(按严重性顺序):
DEBUG - 详细的信息,通常用于诊断问题。
INFO - 确认系统按预期运行的信息。
WARNING - 表示意外情况或问题的警告(例如资源不足),但程序仍继续运行。
ERROR - 由于更严重的问题,程序的某个功能无法运行。
CRITICAL - 严重错误,表示程序可能无法继续运行。
基本用法
以下是 logging 模块的基本用法示例:
import logging
# 配置基本配置
logging.basicConfig(level=logging.DEBUG, # 设置最低的日志级别
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s') # 配置日志输出格式
# 创建日志器
logger = logging.getLogger(__name__)
# 记录各种级别的日志
logger.debug("这是一条调试信息")
logger.info("这是一条信息")
logger.warning("这是一条警告")
logger.error("这是一条错误")
logger.critical("这是一条严重错误")
``
配置日志
你可以通过 basicConfig 函数轻松配置日志输出的各种属性。以下是一些常用参数:
filename:日志文件的名称。如果指定此参数,日志将写入到文件中。
filemode:日志文件的打开模式。
level:设置日志级别。
format:指定日志的输出格式。
logging.basicConfig(filename='app.log', # 日志文件名
filemode='w', # 文件模式, 'w' 表示写入模式,'a' 表示追加模式
level=logging.INFO, # 设置最低日志级别
format='%(name)s - %(levelname)s - %(message)s') # 日志格式
logger = logging.getLogger(name)
logger.info('这是写入到文件中的一条信息日志')
日志格式
日志信息的格式可以通过 format 参数自定义。常用的格式说明符有:
%(asctime)s:日志记录的时间
%(levelname)s:日志级别
%(message)s:日志消息
%(filename)s:日志记录所在的文件名
%(lineno)d:日志记录所在的文件行号
处理器和格式器
logging 模块还支持将日志消息发送到不同的目标,如控制台、文件,甚至远程服务器。
处理器(Hander)
StreamHandler:将日志输出到控制台
FileHandler:将日志输出到文件
RotatingFileHandler:将日志输出到文件,并在文件达到一定大小时进行轮转
TimedRotatingFileHandler:将日志输出到文件,并在特定时间间隔进行轮转
以下是一个使用 FileHandler 和自定义格式器的示例:
``
import logging
# 创建日志器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)
# 创建一个处理器,将日志写入文件
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.DEBUG)
# 创建一个格式器并将其添加到处理器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
# 将处理器添加到日志器
logger.addHandler(file_handler)
# 记录日志
logger.debug('这是一个调试信息')
logger.info('这是一个信息')
logger.warning('这是一个警告')
logger.error('这是一个错误')
logger.critical('这是一个紧急问题')
记录日志到多个目标
你可以将不同的处理器添加到一个日志器中,以便将日志消息发送到多个目标:
import logging
# 创建日志器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)
# 创建一个控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
# 创建一个文件处理器
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.DEBUG)
# 创建并设置格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
# 将处理器添加到日志器
logger.addHandler(console_handler)
logger.addHandler(file_handler)
# 记录日志
logger.debug('调试信息')
logger.info('信息')
logger.warning('警告')
logger.error('错误')
logger.critical('紧急问题')
总结
Python 的 logging 模块是一个非常灵活且功能强大的日志记录系统,它允许你:
记录不同级别的日志消息
定制日志的输出格式
将日志发送到不同的目标(控制台、文件、远程服务器等)
根据需要添加多个处理器和格式器以进行复杂的日志配置
通过对 logging 模块的使用,你可以更加有效地记录和管理应用程序的日志信息。