本文旨在帮助开发者掌握如何使用 python 的 `Logging` 模块,实现每日自动生成不同日志文件的功能。我们将探讨如何修改现有 `FileHandler` 的文件名,以及如何使用 `TimedRotatingFileHandler` 实现更便捷的日志文件按时间滚动。通过本文,你将能够灵活地管理你的应用程序日志,并根据日期进行归档。
在实际应用中,我们经常需要按日期对日志进行分割,方便管理和维护。Python 的 logging 模块提供了多种方式来实现这个需求。本文将介绍两种常用的方法:手动修改 FileHandler 的文件名和使用 TimedRotatingFileHandler。
方法一:手动修改 FileHandler 的文件名
这种方法的核心在于,当需要切换到新的日志文件时,手动修改 FileHandler 对象的 baseFilename 属性,并关闭当前的 FileHandler。这样,当下次写入日志时,logging 模块会自动打开新的文件。
以下是一个示例:
立即学习“Python免费学习笔记(深入)”;
import logging as log import sys import os from datetime import datetime # 初始日志文件配置 log_file = f'{datetime.now().strftime("%m.%d.%Y")}.log' log_fh = log.FileHandler(log_file) log_sh = log.streamHandler(sys.stdout) log_format = f'[{datetime.now()}] %(levelname)s: %(message)s' log_level = 'INFO' log.basicConfig(format=log_format, level=log_level, handlers=[log_sh, log_fh]) log.info('Initial log entry') # 切换到新的日志文件 new_filename = 'new_log.log' log_fh.baseFilename = os.path.abspath(new_filename) log_fh.close() log.info('Log entry after filename change') # 查找并修改所有 FileHandler filename = 'another.log' for handler in log.getLogger().handlers: if isinstance(handler, log.FileHandler): handler.baseFilename = os.path.abspath(filename) handler.close() log.info('Log entry after changing all FileHandlers')
代码解释:
- 首先,我们配置了基本的 logging,包括文件处理器 log_fh 和控制台处理器 log_sh。
- 然后,我们通过修改 log_fh.baseFilename 和 log_fh.close() 来切换到新的日志文件。
- 为了更灵活地应用,我们展示了如何遍历所有的 handler,找到 FileHandler 并进行修改。
注意事项:
- 每次修改 baseFilename 后,必须调用 close() 方法关闭当前的文件处理器,否则日志仍然会写入旧的文件。
- 如果你的代码中使用了多个 FileHandler,需要遍历 log.getLogger().handlers 列表,找到所有的 FileHandler 并进行修改。
方法二:使用 TimedRotatingFileHandler
TimedRotatingFileHandler 是 logging.handlers 模块提供的一个强大的工具,它可以根据时间自动切换日志文件。
以下是一个示例:
立即学习“Python免费学习笔记(深入)”;
import logging as log import sys from logging.handlers import TimedRotatingFileHandler from datetime import datetime # 使用 TimedRotatingFileHandler log_trfh = TimedRotatingFileHandler('time_rotating', when='D', interval=1) log_sh = log.StreamHandler(sys.stdout) log_format = f'[{datetime.now()}] %(levelname)s: %(message)s' log_level = 'INFO' log.basicConfig(format=log_format, level=log_level, handlers=[log_sh, log_trfh]) log.info('Log entry using TimedRotatingFileHandler') # 模拟多次日志写入 for i in range(5): log.info(f'Log entry {i+1}')
代码解释:
- 我们创建了一个 TimedRotatingFileHandler 对象,指定了文件名 time_rotating,以及切换的时间间隔 when=’D’(每天)。
- interval=1 表示每隔一个 when 指定的时间间隔就切换一次日志文件。
- TimedRotatingFileHandler 会自动在旧的文件名后添加 %Y-%m-%d_%H-%M-%S 格式的时间戳,以区分不同的日志文件。
TimedRotatingFileHandler 的参数说明:
- filename: 日志文件的基本名称。
- when: 指定时间间隔的字符串,例如:
- ‘S’: Seconds
- ‘M’: Minutes
- ‘H’: Hours
- ‘D’: Days
- ‘W’: Week day (0=Monday)
- ‘midnight’: Roll over at midnight
- interval: 时间间隔的倍数。
- backupCount: 保留的旧日志文件数量,超过这个数量的旧日志文件会被删除。
- encoding: 日志文件的编码。
- delay: 如果为 True,则文件直到第一次 emit() 调用时才打开。
- utc: 如果为 True,则使用 UTC 时间。
注意事项:
- 如果 filename 没有 .log 扩展名,TimedRotatingFileHandler 会自动在旧的文件名后添加日期。
- 可以使用 when=”M” 来测试,以便每分钟生成一个新文件。
总结
本文介绍了两种在 Python 中实现每日生成不同日志文件的方法。手动修改 FileHandler 的文件名比较灵活,但需要手动管理文件的切换。TimedRotatingFileHandler 则更加方便,它可以自动根据时间切换日志文件,并管理旧的日志文件。选择哪种方法取决于你的具体需求。在实际应用中,可以根据项目的复杂度和日志管理的需求选择合适的方法。