
本文旨在解决Python `logging` 模块中如何实现每天生成一个独立的日志文件的问题。通过修改 `FileHandler` 的 `baseFilename` 属性并关闭旧文件,以及使用 `TimedRotatingFileHandler`,可以轻松实现日志文件的按天轮转。
在Python开发中,日志记录是至关重要的环节,它可以帮助我们追踪程序运行状态、排查错误和进行性能分析。在实际应用中,我们通常需要将日志信息写入文件,并且希望日志文件能够按照一定的时间间隔进行轮转,例如每天生成一个新的日志文件。本文将介绍如何使用Python的 logging 模块实现这一需求。
使用 FileHandler 手动轮转日志文件
默认情况下,logging.FileHandler 会将日志信息追加到指定的文件中。如果我们需要每天生成一个新的日志文件,一种方法是手动修改 FileHandler 的 baseFilename 属性并关闭旧的文件。
import logging
import os
import sys
from datetime import datetime
# 初始化日志配置
log_file = f'{datetime.now().strftime("%Y-%m-%d")}.log'
log_fh = logging.FileHandler(log_file)
log_sh = logging.StreamHandler(sys.stdout)
log_format = f'[{datetime.now()}] %(levelname)s: %(message)s'
log_level = logging.INFO
logging.basicConfig(format=log_format, level=log_level, handlers=[log_sh, log_fh])
logging.info('Initial log message.')
# 模拟第二天
new_filename = f'{datetime.now().strftime("%Y-%m-%d")}_new.log'
log_fh.baseFilename = os.path.abspath(new_filename)
log_fh.close()
logging.info('Log message after filename change.')
# 查找并修改FileHandler
for handler in logging.getLogger().handlers:
if isinstance(handler, logging.FileHandler):
handler.baseFilename = os.path.abspath(new_filename)
handler.close()
logging.info('Log message after handler change.')代码解释:
立即学习“Python免费学习笔记(深入)”;
- 首先,我们初始化 logging 模块,创建一个 FileHandler 实例 log_fh,并设置日志格式和级别。
- 然后,我们模拟第二天,创建一个新的文件名 new_filename。
- 关键步骤:我们修改 log_fh 的 baseFilename 属性为新的文件名,并调用 close() 方法关闭旧的文件。这将导致下一次写入日志时,FileHandler 会自动打开新的文件。
- 如果无法直接访问 log_fh,可以通过遍历 logging.getLogger().handlers 列表,找到 FileHandler 实例并进行修改。
注意事项:
- 在修改 baseFilename 之前,必须先调用 close() 方法关闭旧的文件,否则日志信息仍然会写入旧的文件。
- 修改 baseFilename 之后,FileHandler 会自动打开新的文件。
使用 TimedRotatingFileHandler 自动轮转日志文件
logging.handlers 模块提供了一个 TimedRotatingFileHandler 类,它可以按照指定的时间间隔自动轮转日志文件。
import logging
import sys
from logging.handlers import TimedRotatingFileHandler
from datetime import datetime
# 初始化 TimedRotatingFileHandler
log_file = 'application.log'
log_trfh = TimedRotatingFileHandler(log_file, when='D', interval=1, backupCount=7) # 每天轮转,保留7天的日志
log_sh = logging.StreamHandler(sys.stdout)
log_format = f'[{datetime.now()}] %(levelname)s: %(message)s'
log_level = logging.INFO
logging.basicConfig(format=log_format, level=log_level, handlers=[log_sh, log_trfh])
logging.info('This is a test message.')代码解释:
立即学习“Python免费学习笔记(深入)”;
- 我们创建一个 TimedRotatingFileHandler 实例 log_trfh,并指定以下参数:
- filename: 日志文件的基本名称。
- when: 轮转的时间间隔。'D' 表示每天轮转。
- interval: 轮转的间隔。1 表示每天轮转一次。
- backupCount: 保留的旧日志文件的数量。超过这个数量的旧日志文件会被删除。
- TimedRotatingFileHandler 会自动在旧的日志文件名后添加日期和时间戳,例如 application.log.2023-10-27_00-00-00。
参数 when 的可选值:
- 'S': Seconds
- 'M': Minutes
- 'H': Hours
- 'D': Days
- 'W': Week day (0=Monday)
- 'midnight': Roll over at midnight
总结:
使用 TimedRotatingFileHandler 是实现日志文件按天轮转的最佳方式。它简单易用,并且提供了丰富的功能,例如自动添加时间戳、保留旧日志文件等。在实际应用中,建议使用 TimedRotatingFileHandler 来管理日志文件。










