从python的日志记录器中删除处理程序

Question

我正在玩Python的日志记录系统.我在循环中从Logger对象中删除处理程序时发现了一个奇怪的行为.也就是说,我的for循环删除了除一个处理程序以外 额外调用以.removeHandler顺利删除最后一个处理程序.呼叫期间不会发出任何错误消息.

这是测试代码:

import logging
import sys
logging.basicConfig()
dbg = logging.getLogger('dbg')
dbg.setLevel(logging.DEBUG)

testLogger = logging.getLogger('mylogger')
sh = logging.StreamHandler(sys.stdout)
fh = logging.FileHandler('mylogfile.log')
dbg.debug('before adding handlers: %d handlers'%len(testLogger.handlers))
testLogger.addHandler(fh)
testLogger.addHandler(sh)

dbg.debug('before removing. %d handlers: %s'%(len(testLogger.handlers), 
                                              str(testLogger.handlers)))
for h in testLogger.handlers:
    dbg.debug('removing handler %s'%str(h))
    testLogger.removeHandler(h)
    dbg.debug('%d more to go'%len(testLogger.handlers))

#HERE I EXPECT THAT NO HANDLER WILL REMAIN    
dbg.debug('after removing: %d handlers: %s'%(len(testLogger.handlers), 
                                              str(testLogger.handlers)))
if len(testLogger.handlers) > 0:
    #Why is this happening?
    testLogger.removeHandler(testLogger.handlers[0])
dbg.debug('after manually removing the last handler: %d handlers'%len(testLogger.handlers))    

我希望在循环结束时没有处理程序将保留在testLogger对象中,但是最后一次调用.removeHandler显然会失败,从下面的输出中可以看出.然而,对此函数的额外调用会按预期删除处理程序.这是输出:

DEBUG:dbg:before adding handlers: 0 handlers
DEBUG:dbg:before removing. 2 handlers: [<logging.FileHandler instance at 0x021263F0>, <logging.StreamHandler instance at 0x021262B0>]
DEBUG:dbg:removing handler <logging.FileHandler instance at 0x021263F0>
DEBUG:dbg:1 more to go
DEBUG:dbg:after removing: 1 handlers: [<logging.StreamHandler instance at 0x021262B0>]
DEBUG:dbg:after manually removing the last handler: 0 handlers

更有趣的是,如果我用下面的循环替换原始循环,循环按预期工作,并且循环testLogger结束时没有处理程序保留在对象中.这是修改后的循环:

while len(testLogger.handlers) > 0:
    h = testLogger.handlers[0]
    dbg.debug('removing handler %s'%str(h))
    testLogger.removeHandler(h)
    dbg.debug('%d more to go'%len(testLogger.handlers))

什么解释了这种行为？这是一个错误还是我错过了什么？

Answer 1

这不是特定于记录器的行为.永远不要改变(插入/删除元素)您当前正在迭代的列表.如果需要,请复制.在这种情况下testLogger.handlers = []应该做的伎俩.

Answer 2

我想说，如果删除日志记录处理程序的目的是为了防止将日志发送到其他处理程序（大多数情况下都是这种情况），那么我遵循的另一种方法是为当前记录器设置propagate为。False

logger = logging.getLogger(__name__)
logger.propagate = False

这样，您的日志消息只会发送到您显式添加的处理程序，而不会传播到父记录器。

Answer 3

如果您不想全部删除它们(感谢提示 @CatPlusPlus):

testLogger.handlers = [
    h for h in testLogger.handlers if not isinstance(h, logging.StreamHandler)]

Answer 4

而不是变异 undocumented .handler：

选项1

logging.getLogger().removeHandler(logging.getLogger().handlers[0])

通过这种方式，您可以通过官方 api 完全删除预先存在的处理程序对象。或者删除所有处理程序：

logger = logging.getLogger()
while logger.hasHandlers():
    logger.removeHandler(logger.handlers[0])

选项 2

logging.config.dictConfig(config={'level': logging.DEBUG, 'handlers': []}

不仅删除而且阻止它的创建。列表根将有[]处理程序