Как написать собственный обработчик журнала Python? - PullRequest
47 голосов
/ 25 июня 2010

Как написать пользовательскую функцию журнала консоли, чтобы выводить только сообщения журнала окна консоли в одну строку (не добавлять) до первой обычной записи журнала.

progress = ProgressConsoleHandler()
console  = logging.StreamHandler()  

logger = logging.getLogger('test')
logger.setLevel(logging.DEBUG) 
logger.addHandler(console)  
logger.addHandler(progress)

logger.info('test1')
for i in range(3):
    logger.progress('remaining %d seconds' % i)
    time.sleep(1)   
logger.info('test2')

Так что вывод на консоль всего три строки:

INFO: test1
remaining 0 seconds... 
INFO: test2

Любые предложения о том, как лучше всего это осуществить?

1 Ответ

53 голосов
/ 07 сентября 2011
import logging
class ProgressConsoleHandler(logging.StreamHandler):
    """
    A handler class which allows the cursor to stay on
    one line for selected messages
    """
    on_same_line = False
    def emit(self, record):
        try:
            msg = self.format(record)
            stream = self.stream
            same_line = hasattr(record, 'same_line')
            if self.on_same_line and not same_line:
                stream.write(self.terminator)
            stream.write(msg)
            if same_line:
                stream.write('... ')
                self.on_same_line = True
            else:
                stream.write(self.terminator)
                self.on_same_line = False
            self.flush()
        except (KeyboardInterrupt, SystemExit):
            raise
        except:
            self.handleError(record)
if __name__ == '__main__':
    import time
    progress = ProgressConsoleHandler()
    console  = logging.StreamHandler()  

    logger = logging.getLogger('test')
    logger.setLevel(logging.DEBUG) 
    logger.addHandler(progress)

    logger.info('test1')
    for i in range(3):
        logger.info('remaining %d seconds', i, extra={'same_line':True})
        time.sleep(1)   
    logger.info('test2')

Обратите внимание, что зарегистрирован только один обработчик, а аргумент ключевого слова extra, позволяющий обработчику знать, что он должен оставаться на одной строке.В методе emit() больше логики для обработки изменений между сообщениями, которые должны оставаться в одной строке, и сообщениями, которые должны иметь свою собственную строку.

...