Python Logging装饰器输出重复日志

Python Logging装饰器输出重复日志

问题描述

在Password Management项目中，为保存查询、增加、修改、删除的操作记录，使用logging模块编写日志装饰器将日志输出到指定日志文件，但是运行后，第一次查询，日志文件中一条日志，第二次查询，日志文件中同时增加两条，第三次查询，日志文件中同时增加三条日志，依次类推。。。

问题排解过程

1、首先怀疑是因为main()函数中的while循环没有闭环，导致内存中的日志数据没有释放，但是每次循环后contiue还是有相同的问题，所以排除。

2、后在网上看到了相同的问题，是因为以下情况：
  – logger = logging.getLogger()在执行时，没有每次生成一个新的logger，而是先检查内存中是否存在一个logger对象，存在即取出，不存在则新建；
  – 实例化的logger对象具有‘handlers’这样一个属性来存储 Handler;
  – logging.handlers最初是一个空的列表，执行logger.addHandler(fh)添加一条日志；
  – 第二次调用时因为logging.handlers中已经存在一条日志，所以会同时输出两条日志。

def LogNice(text):
    def cnlog(func):
        def wrapper(*args, **kwargs):
            logger = logging.getLogger()
            fh = logging.FileHandler('.\\log.log', encoding='utf-8', mode='a')
            formatter = logging.Formatter(
                '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

            fh.setFormatter(formatter)
            logger.addHandler(fh)
            logger.setLevel(logging.DEBUG)
            try:
                uwe = func(*args, **kwargs)
                # logging.info('This is a normal program.')
                logging.info(text + ' Success')
                return uwe
            # except (TypeError, ValueError, ZeroDivisionError, NameError) as e:
            except Exception as e:
                logging.error(e)
                print("Error Program.")
                return uwe
        return wrapper
    return cnlog

解决方法

1、清除hander

# 使用logger.handlers.clear()
...
    ...
            logger = logging.getLogger()
            logger.handlers.clear()
            fh = logging.FileHandler('.\\log.log', encoding='utf-8', mode='a')
    ...
...

# 使用logger.removeHandler(xxxHandler)
...
    ...
            try:
                uwe = func(*args, **kwargs)
                # logging.info('This is a normal program.')
                logging.info(text + ' Success')
                logger.removeHandler(fh)
                return uwe
            # except (TypeError, ValueError, ZeroDivisionError, NameError) as e:
            except Exception as e:
                logging.error(e)
                print("Error Program.")
                logger.removeHandler(fh)
                return uwe
    ...
...  

2、用前判断

import logging

def my_log():
    logger = logging.getLogger('mysql.log')
    # 判断logger是否已经添加过handler，是则直接返回logger对象，否则执行handler设定以及addHandler(ch)
    if not logger.handlers:
        ch = logging.StreamHandler()
        ch.setLevel(logging.ERROR)
        fmt = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
        ch.setFormatter(fmt)
        logger.addHandler(ch)
    return logger

my_log().error('run one')
my_log().error('run two')