регистрация в python гарантирует, что обработчик будет добавлен только один раз - PullRequest
46 голосов
/ 13 июня 2011

У меня есть кусок кода, который инициализирует регистратор, как показано ниже.

logger = logging.getLogger()
hdlr = logging.FileHandler('logfile.log')
formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
hdlr.setFormatter(formatter)
logger.addHandler(hdlr) 
logger.setLevel(logging.DEBUG)

К сожалению, этот код вызывается несколько раз, есть ли способ проверить, существует ли обработчик, - я бы предпочел реализовать это без использования Singleton.

РЕДАКТИРОВАТЬ: Извините, забыл упомянуть, что это на Python 2.5 - ура, Ричард

Ответы [ 4 ]

29 голосов
/ 04 августа 2015

Как комментарии @offbyone, можно добавить избыточные обработчики к одному и тому же экземпляру регистратора. Документы python для регистрации say-

"Несколько вызовов getLogger () с одинаковым именем вернут ссылка на тот же объект регистратора. "

Так что нам не нужно беспокоиться о том, чтобы сделать реализацию единой, как это уже есть.

К сожалению, то же самое не соответствует действительности для обработчиков, связанных с одним и тем же экземпляром регистратора. Там может быть прикрепленным дубликатом обработчиков.

1017 * ПРИМЕР- *

  1. Скопируйте этот код и сохраните его в main.py

    import logging
    print 'inside main.py',
    print '-'*50
    def logger():
    
          print 'initializing logger....'
          logPath = '.'
          fileName = 'temp'
    
          # configure log formatter
          logFormatter = logging.Formatter("%(asctime)s [%(filename)s] [%(funcName)s] [%(levelname)s] [%(lineno)d] %(message)s")
    
          # configure file handler
          fileHandler = logging.FileHandler("{0}/{1}.log".format(logPath, fileName))
          fileHandler.setFormatter(logFormatter)
    
          # configure stream handler
          consoleHandler = logging.StreamHandler()
          consoleHandler.setFormatter(logFormatter)
    
          # get the logger instance
          logger = logging.getLogger(__name__)
    
          # set the logging level
          logger.setLevel(logging.DEBUG)
    
          print 'adding handlers- '
    
          #if not len(logger.handlers):
          logger.addHandler(fileHandler)
          logger.addHandler(consoleHandler)
    
          print 'logger initialized....\n'
          print 'associated handlers - ', len(logger.handlers)
          for handler in logger.handlers:
                print handler
          print
          return logger
    
    main_logger = logger()
    main_logger.info('utilizing main.py logger.')
    print 'exiting main.py',
    print '-'*50
    
  2. и следующий код в sub.py

    print 'inside sub.py',
    print '-'*50
    print 'importing main.py'
    import main
    print 'imported main.py'
    import logging
    print 'getting logger instance in sub'
    sub_logger = main.logger()
    print 'got logger instance in sub'
    sub_logger.info("utilizing sub_logger")
    print 'exiting sub.py',
    print '-'*50
    
  3. Выполнить sub.py

    narayan@y510p:~/code/so$ python sub.py
    inside sub.py --------------------------------------------------
    importing main.py
    inside main.py --------------------------------------------------
    initializing logger....
    adding handlers- 
    logger initialized....
    
    associated handlers -  2
    <logging.FileHandler object at 0x7f7158740c90>
    <logging.StreamHandler object at 0x7f7158710b10>
    
    2015-08-04 07:41:01,824 [main.py] [<module>] [INFO] [41] utilizing main.py logger.
    exiting main.py --------------------------------------------------
    imported main.py
    getting logger instance in sub
    initializing logger....
    adding handlers- 
    logger initialized....
    
    associated handlers -  4 # <===== 4 handlers (duplicates added)
    <logging.FileHandler object at 0x7f7158740c90>
    <logging.StreamHandler object at 0x7f7158710b10>
    <logging.FileHandler object at 0x7f7158710bd0>
    <logging.StreamHandler object at 0x7f7158710c10>
    
    got logger instance in sub
    2015-08-04 07:41:01,824 [sub.py] [<module>] [INFO] [10] utilizing sub_logger
    2015-08-04 07:41:01,824 [sub.py] [<module>] [INFO] [10] utilizing sub_logger
    exiting sub.py --------------------------------------------------
    

Следовательно, множественные вызовы метода, возвращающего один и тот же регистратор, добавили дублирующиеся обработчики.

Теперь, на ваш вопрос-

есть ли способ проверить, существует ли обработчик

Да, есть -

logger.handlers возвращает список всех обработчиков, связанных с данным logger.

Перед добавлением обработчиков в экземпляр регистратора, убедитесь, что не добавляете дублирующиеся обработчики В main.py просто снимите комментарий со строки, которая говорит if not len(logger.handlers):, и сделайте отступ в следующих двух строках правильно -

if not len(logger.handlers):
    logger.addHandler(fileHandler)
    logger.addHandler(consoleHandler)

Теперь снова запустите sub.py

narayan@y510p:~/code/so$ python sub.py
inside sub.py --------------------------------------------------
importing main.py
inside main.py --------------------------------------------------
initializing logger....
adding handlers- 
logger initialized....

associated handlers -  2
<logging.FileHandler object at 0x7fd67a891c90>
<logging.StreamHandler object at 0x7fd67a862b10>

2015-08-04 08:14:45,620 [main.py] [<module>] [INFO] [41] utilizing main.py logger.
exiting main.py --------------------------------------------------
imported main.py
getting logger instance in sub
initializing logger....
adding handlers- 
logger initialized....

associated handlers -  2 # <===== Still 2 handlers (no duplicates)
<logging.FileHandler object at 0x7fd67a891c90>
<logging.StreamHandler object at 0x7fd67a862b10>

got logger instance in sub
2015-08-04 08:14:45,620 [sub.py] [<module>] [INFO] [10] utilizing sub_logger
exiting sub.py --------------------------------------------------

Далее, если вы хотите ограничить тип обработчиков, которые будут добавлены к экземпляру регистратора, вы можете сделать что-то вроде этого -

    print 'adding handlers- '
    # allows to add only one instance of file handler and stream handler
    if len(logger.handlers) > 0:
        print 'making sure we do not add duplicate handlers'
        for handler in logger.handlers:
              # add the handlers to the logger
              # makes sure no duplicate handlers are added

              if not isinstance(handler, logging.FileHandler) and not isinstance(handler, logging.StreamHandler):
                    logger.addHandler(fileHandler)
                    print 'added file handler'
                    logger.addHandler(consoleHandler)
                    print 'added stream handler'
    else:
        logger.addHandler(fileHandler)
        logger.addHandler(consoleHandler)
        print 'added handlers for the first time'

Надеюсь, это поможет!

Edit:

К сожалению, то же самое не соответствует действительности для связанных обработчиков с тем же экземпляром регистратора. Там может быть дубликатом обработчики прилагаются.

Оказывается, что вышеприведенное утверждение не совсем верно.

Предположим, мы создали и настроили регистратор с именем 'main_logger' в главном модуле (который просто настраивает регистратор, ничего не возвращает).

# get the logger instance
logger = logging.getLogger("main_logger")
# configuration follows
...

Теперь в подмодуле, если мы создадим дочерний регистратор, следуя иерархии имен 'main_logger.sub_module_logger' , нам не нужно настраивать его в подмодуле. Достаточно просто создать регистратор, следуя иерархии имен.

# get the logger instance
logger = logging.getLogger("main_logger.sub_module_logger")
# no configuration needed
# it inherits the configuration from the parent logger
...

И это не добавит дубликат обработчика.

Reference- Использование регистрации в нескольких модулях

15 голосов
/ 13 июня 2011

Ну и logger.addHandler () не добавит обработчик, если обработчик уже существует.Чтобы проверить, есть ли уже обработчик, вы можете проверить список logger.handlers:

logger = logging.getLogger()
hdlr = logging.FileHandler('logfile.log')
formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
hdlr.setFormatter(formatter)
logger.addHandler(hdlr) 
logger.setLevel(logging.DEBUG)
print logger.handlers
# [<logging.FileHandler object at 0x14542d0>]
logger.addHandler(hdlr)
print logger.handlers
# [<logging.FileHandler object at 0x14542d0>]

Кроме того, я предложу добавить этот код в вашу функцию main (), если она есть, или в __init__.pyфайл вашего пакета, чтобы не приходилось вызывать его каждый раз.Я также предлагаю вам использовать именованный регистратор и не использовать корневой регистратор.Примерно так:

logger = logging.getLogger(__name__)
...

Надеюсь, это было полезно:)

4 голосов
/ 23 октября 2013

Вы также можете просто проверить, пуст ли список обработчиков. Вот решение, с которым я столкнулся:

def setup_logging(self, logfile):
    self._logger = logging.getLogger('TestSuite')
    self._logger.setLevel(logging.INFO)
    host = socket.gethostname().split('.')[0]
    if self._logger.handlers == []:
        fh = logging.handlers.RotatingFileHandler(logfile,
                                                  maxBytes=10*1024*1024,
                                                  backupCount=5)
        strfmt = "%" + "(asctime)s [%s] " % host + "%" + "(message)s"
        fmt = logging.Formatter(strfmt, datefmt="%Y.%m%d %H:%M:%S")
        fh.setFormatter(fmt)

        self._logger.addHandler(fh)
    self._logger.info('-' * (55 - len(host)))

Я видел, как обработчик добавлялся несколько раз, поэтому каждое сообщение журнала записывалось в файл журнала несколько раз, и это исправляло его.

1 голос
/ 13 июня 2011

Попробуйте проверить, установлен ли logger.Например, если этот код находится внутри функции:

logger = None
def init_logger():
    global logger
    if logger is not None:
        #logger has already been initialized
        return
    logger = logging.getLogger()
    hdlr = logging.FileHandler('logfile.log')
    formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
    hdlr.setFormatter(formatter)
    logger.addHandler(hdlr) 
    logger.setLevel(logging.DEBUG)
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...