Python实现日志文件名动态变更与配置详解
本文详解Python中logging模块动态变更日志文件名的方法。通过对比basicConfig的局限性，演示利用Handler对象动态增删FileHandler实现文件名切换，并介绍TimedRotatingFileHandler及logging.config.fileConfig配置文件的高级用法，帮助开发者灵活管理日志输出。
Python作为一门易于上手的脚本语言，其日志输出功能十分便捷。借助logging模块，仅需简单的配置与属性设置，即可将日志输出至控制台。若通过basicConfig()指定文件名，则可将日志信息直接写入文件，操作极为简便。
近期在项目开发中遇到一个日志管理问题：使用Python编写的服务程序需持续运行并处理多项任务，每个任务的关键信息均需记录在文件中以便维护人员查阅。虽然使用logging写入文件看似简单，但由于服务程序长期运行，持续向单一文件追加日志并不合理。众所周知，长时间输出会导致日志文件体积膨胀。因此，如何在服务运行期间动态修改日志输出文件，并以当天日期作为日志文件名，成为亟待解决的问题。
代码编写环境：python3.4.3
1.logging.basicConfig()
首先想到的方法是修改logging.basicConfig(filename=logfilename)参数，以此实现变更日志文件名的目的。编写代码如下：
log_fmt = '%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s'
for i in range(1,4):
filename = str.format('mylog%d.txt' % i)
logging.basicConfig(format=log_fmt, level=logging.DEBUG, filename=filename)
logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')
运行结果未达预期，仅创建了日志文件mylog1.txt，而mylog2.txt和mylog3.txt并未生成，连续三次输出的内容均被写入mylog1.txt中。这表明logging.basicConfig()设置的属性具有全局性，首次设置后，后续再次设置将不再生效。查阅官方文档，证实了这一点。
logging.basicConfig(**kwargs)
Does basic configuration for the logging system by creating a StreamHandler with a default Formatter and adding it to the root logger. The functions debug(), info(), warning(), error() and critical() will call basicConfig() automatically if no handlers are defined for the root logger.
This function does nothing if the root logger already has handlers configured for it.
此路不通，只好用其他方法。
2.Handler对象
logging支持添加多个不同类型的handler对象，从而实现对控制台（logging.StreamHandler）、文件（logging.FileHandler）等不同目标输出日志。
logging支持的日志详情见文档logging.handlers
通过增加多个handler对象，可以实现同时在控制台、文件同时输出不同级别的日志信息。
# 默认配置logging写入本地文件
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
datefmt='%a, %d %b %Y %H:%M:%S',
filename='myapp2.log',
filemode='w')
#定义一个StreamHandler，将INFO级别或更高的日志信息打印到标准错误，并将其添加到当前的日志处理对象。
console = logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
console.setFormatter(formatter)
logging.getLogger('').addHandler(console)
logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')
考虑实现简单又能说明效果，写入文件使用logging.basicConfig()设置，并添加输出指向控制台的流处理(StreamHandler)对象console，实现同时输出日志。当然也可以反过来，默认设置控制台输出日志，之后创建文件对象（logging.FileHandler），并加入处理集合，实现同样的效果。
logging.getLogger('')获取的是名为'root'的默认根节点
同时，logging提供addHandler()的方法，自然也会有管理handler的方法。
延伸之前Handler的思路，我们可以实现对handler的动态管理，变更日志文件。每次需要变更输出文件路径前，使用handler管理清空原先的logging.FileHandler对象，重新创建一个新文件名的logging.FileHandler对象即可。
# 默认配置logging写入本地文件
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
datefmt='%a, %d %b %Y %H:%M:%S',
filename='myapp2.log',
filemode='w')
#定义一个StreamHandler，将INFO级别或更高的日志信息打印到标准错误，并将其添加到当前的日志处理对象。
console = logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
console.setFormatter(formatter)
logging.getLogger('').addHandler(console)
logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')
使用for循环执行3次处理，分别创建日志文件名称为mylog1.txt, mylog2.tx, mylog3.txt，并写入相同的内容。执行结果确实产生不同名称的文件，日志内容也正确写入。
至此，已经实现动态变更输出文件日志名称的功能。至于按照日志输出文件名，只需要按照上述代码的思路，将创建logging.FileHandler()的文件名参数变更就能达成目的。
简单实现方案
浏览官方文档logging.handlers一节内容，python考虑到日志的常规使用场景，已经封装更为简单的实现方案，TimedRotatingFileHandler，只需简单的配置，即可实现对输出日志文件的基本管理，灵活易用，代码如下：
import logging, logging.handlers
import time
'''
TimedRotatingFileHandler构造函数声明
class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None)
filename 日志文件名前缀
when 日志名变更时间单位
'S' Seconds
'M' Minutes
'H' Hours
'D' Days
'W0'-'W6' Weekday (0=Monday)
'midnight' Roll over at midnight
interval 间隔时间，是指等待N个when单位的时间后，自动重建文件
backupCount 保留日志最大文件数，超过限制，删除最先创建的文件；默认值0，表示不限制。
delay 延迟文件创建，直到第一次调用emit()方法创建日志文件
atTime 在指定的时间（datetime.time格式）创建日志文件。
'''
def test_TimedRotatingFileHandler():
# 定义日志输出格式
fmt_str = '%(asctime)s[level-%(levelname)s][%(name)s]:%(message)s'
# 初始化
logging.basicConfig()
# 创建TimedRotatingFileHandler处理对象
# 间隔5(S)创建新的名称为myLog%Y%m%d_%H%M%S.log的文件，并一直占用myLog文件。
fileshandle = logging.handlers.TimedRotatingFileHandler('myLog', when='S', interval=5, backupCount=3)
# 设置日志文件后缀，以当前时间作为日志文件后缀名。
fileshandle.suffix = "%Y%m%d_%H%M%S.log"
# 设置日志输出级别和格式
fileshandle.setLevel(logging.DEBUG)
formatter = logging.Formatter(fmt_str)
fileshandle.setFormatter(formatter)
# 添加到日志处理对象集合
logging.getLogger('').addHandler(fileshandle)
if __name__ == '__main__':
test_TimedRotatingFileHandler()
# 测试在200s内创建文件多个日志文件
for i in range(0, 100):
logging.debug("logging.debug")
logging.info("logging.info")
logging.warning("logging.warning")
logging.error("logging.error")
time.sleep(2)
补充：使用Python的logging.config.fileConfig配置日志
Python的logging.config.fileConfig方式配置日志，通过解析conf配置文件实现。文件 logglogging.conf 配置如下：
[loggers]
keys=root,fileLogger,rotatingFileLogger
[handlers]
keys=consoleHandler,fileHandler,rotatingFileHandler
[formatters]
keys=simpleFormatter
[logger_root]
level=DEBUG
handlers=consoleHandler
[logger_fileLogger]
level=DEBUG
# 该logger中配置的handler
handlers=fileHandler
# logger 的名称
qualname=fileLogger
propagate=0
[logger_rotatingFileLogger]
level=DEBUG
# 这样配置，rotatingFileLogger中就同时配置了consoleHandler,rotatingFileHandler
# consoleHandler 负责将日志输出到控制台
# rotatingFileHandler 负责将日志输出保存到文件中
handlers=consoleHandler,rotatingFileHandler
qualname=rotatingFileLogger
propagate=0
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=simpleFormatter
args=('logs/logging.log', 'a')
[handler_rotatingFileHandler]
class=handlers.RotatingFileHandler
level=WARNING
formatter=simpleFormatter
args=("logs/rotating_logging.log", "a", 1*1024*1024, 5)
[formatter_simpleFormatter]
#format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
format=%(asctime)s - %(module)s - %(thread)d - %(levelname)s : %(message)s
datefmt=%Y-%m-%d %H:%M:%S以上配置文件主要包含以下几部分：
loggers : 配置logger信息。必须包含一个名字叫做root的logger，当使用无参函数logging.getLogger()时，默认返回root这个logger，其他自定义logger可以通过 logging.getLogger("fileLogger") 方式进行调用
handlers:定义声明handlers信息。常用的handlers包括 StreamHandler（仅将日志输出到kong控制台）、FileHandler（将日志信息输出保存到文件）、RotaRotatingFileHandler（将日志输出保存到文件中，并设置单个日志wenj文件的大小和日志文件个数）
formatter : 设置日志格式
logger_xxx : 对loggers中声明的logger进行逐个配置，且要一一对应
handler_xxx : 对handlers中声明的handler进行逐个配置，且要一一对应
formatter_xxx : 对声明的formatterjinx进行配置
代码示例
logging.config.fileConfig(“logging.conf”)
# 输出日志到控制台,获取的是root对应的logger
console_logger = logging.getLogger()
# 输出日志到单个文件
file_logger = logging.getLogger(name="fileLogger")
# rotatingFileLogger中额consoleHandler输出到控制台，rotatingHandler输出日志到文件
rotating_logger = logging.getLogger(name="rotatingFileLogger")友情提示
进行以上配置后，在项目中需要进行日志输出的地方通过logging.getLogger()方式就可以获取到du应的logger，然后就可以使用logger.info("xxx")jinx进行日志输出了。
使用这种方式配置日志，一定要在项目的入口函数中就调用 logging.config.fileConfig(“logging.conf”)函数，因为 logging.conf 文件中，在handler中配置的是日志文件的相对地址，如果在其他代码文件中进行调用，由于相对地址的原因，将导致日志文件会出现在yixi意想不到的位置。
以上为个人经验，希望能给大家一个参考，也希望大家多多支持本站。如有错误或未考虑完全的地方，望不吝赐教。
免责声明：本文内容仅供参考，不代表本站观点。转载或引用请注明出处。
