python logging 重復寫日志問題

用Python的logging模塊記錄日志時，遇到了重復記錄日志的問題，第一條記錄寫一次，第二條記錄寫兩次，第三條記錄寫三次。。。很頭疼，這樣記日志可不行。網上搜索到了原因與解決方案：

原因：沒有移除handler
解決：在日志記錄完之后removeHandler

修改前示例代碼：

import logging


def log(message):
    logger = logging.getLogger('testlog')

    streamhandler = logging.StreamHandler()
    streamhandler.setLevel(logging.ERROR)
    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(name)s - %(message)s')
    streamhandler.setFormatter(formatter)

    logger.addHandler(streamhandler)
    logger.error(message)

if __name__ == '__main__':
    log('hi')
    log('hi too')
    log('hi three')

 

修改前輸出結果：

2016-07-08 09:17:29,740 - ERROR - testlog - hi
2016-07-08 09:17:29,740 - ERROR - testlog - hi too
2016-07-08 09:17:29,740 - ERROR - testlog - hi too
2016-07-08 09:17:29,740 - ERROR - testlog - hi three
2016-07-08 09:17:29,740 - ERROR - testlog - hi three
2016-07-08 09:17:29,740 - ERROR - testlog - hi three

修改后示例代碼：

import logging


def log(message):
    logger = logging.getLogger('testlog')

    streamhandler = logging.StreamHandler()
    streamhandler.setLevel(logging.ERROR)
    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(name)s - %(message)s')
    streamhandler.setFormatter(formatter)

    logger.addHandler(streamhandler)
    logger.error(message)

    #  添加下面一句，在記錄日志之后移除句柄
    logger.removeHandler(streamhandler)

if __name__ == '__main__':
    log('hi')
    log('hi too')
    log('hi three')

 

修改后輸出結果：

2016-07-08 09:32:28,206 - ERROR - testlog - hi
2016-07-08 09:32:28,206 - ERROR - testlog - hi too
2016-07-08 09:32:28,206 - ERROR - testlog - hi three

深度解析：

Google之后，大概搞明白了，就是你第二次調用log的時候，根據getLogger(name)里的name獲取同一個logger，而這個logger里已經有了第一次你添加的handler，第二次調用又添加了一個handler，所以，這個logger里有了兩個同樣的handler，以此類推，調用幾次就會有幾個handler。。

所以這里有以下幾個解決辦法：

1. 每次創建不同name的logger，每次都是新logger，不會有添加多個handler的問題。（ps:這個辦法太笨，不過我之前就是這么干的。。）
2. 像上面一樣每次記錄完日志之后，調用removeHandler()把這個logger里的handler移除掉。
3. 在log方法里做判斷，如果這個logger已有handler，則不再添加handler。
4. 與方法2一樣，不過把用pop把logger的handler列表中的handler移除。

下面是方法3與方法4的代碼示例：

方法3：

import logging


def log(message):
    logger = logging.getLogger('testlog')

    #  這里進行判斷，如果logger.handlers列表為空，則添加，否則，直接去寫日志
    if not logger.handlers:
        streamhandler = logging.StreamHandler()
        streamhandler.setLevel(logging.ERROR)
        formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(name)s - %(message)s')
        streamhandler.setFormatter(formatter)
        logger.addHandler(streamhandler)

    logger.error(message)


if __name__ == '__main__':
    log('hi')
    log('hi too')
    log('hi three')

 

方法4：

import logging


def log(message):
    logger = logging.getLogger('testlog')

    streamhandler = logging.StreamHandler()
    streamhandler.setLevel(logging.ERROR)
    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(name)s - %(message)s')
    streamhandler.setFormatter(formatter)

    logger.addHandler(streamhandler)

    logger.error(message)

    #  用pop方法把logger.handlers列表中的handler移除，注意如果你add了多個handler，這里需多次pop，或者可以直接為handlers列表賦空值
    logger.handlers.pop()
    # logger.handler = []


if __name__ == '__main__':
    log('hi')
    log('hi too')
    log('hi three')