logger.py

import logging
import subprocess
import platform
import os.path
from datetime import datetime

from settings import Settings
from config import ACTION_START_MESSAGE, ACTION_END_MESSAGE

if  platform.system().lower() == 'windows':
  import winutility
  winutility.enable_vt_mode()
  
class ColoredFormatter(logging.Formatter):

  BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)

  color_level_dict = {
            logging.DEBUG: (None, WHITE, False),
            logging.INFO: (None, GREEN, False),
            logging.WARNING: (None, YELLOW, False),
            logging.ERROR: (None, RED, False),
            logging.CRITICAL: (RED, WHITE, False),
        }

  RESET_SEQUECE = "\033[0m"
  CSI_SEQUENCE = "\033["

  def __init__(self, msg, dateFormat = "%Y-%m-%d %H:%M:%S", use_color = True):
    logging.Formatter.__init__(self, msg, dateFormat)
    self.use_color = use_color

  def colorize(self,message,params):
    bg, fg, bold = params
    parts = []
    if bg != None:
      parts.append(str(bg + 40))
    if fg != None:
      parts.append(str(fg + 30))
    if bold:
        parts.append('1')
    if parts:
        message = ''.join((self.CSI_SEQUENCE, ';'.join(parts),
                            'm', message, self.RESET_SEQUECE))
    return message

  def format(self, record):
    if (self.use_color):
      record.levelname = self.colorize(record.levelname,self.color_level_dict[record.levelno])
      record.msg = self.colorize(record.msg,self.color_level_dict[record.levelno])
    return logging.Formatter.format(self, record)

class Logger:

  formatter = None #ColoredFormatter(FORMAT)
  loggerHandle = None #logging.StreamHandler()

  @classmethod
  def setUp(cls, logFormat, noColoredOutput = False, logToFile = '', overwriteLogFile = True):

    if cls.loggerHandle == None:
      if logToFile == '':
        cls.loggerHandle = logging.StreamHandler()
      else:
        filename = logToFile
        if os.path.isfile(filename) and  not overwriteLogFile:
          filename = os.path.splitext(filename)[0] + '_' + datetime.now().strftime('%Y-%m-%d_%H-%M-%S' + os.path.splitext(filename)[1])
        cls.loggerHandle = logging.FileHandler(filename,'w')

    if cls.formatter == None and logFormat != "":
      if logToFile == "" and not noColoredOutput:
        cls.formatter = ColoredFormatter(logFormat)
      else:
        cls.formatter = logging.Formatter(logFormat)
      cls.loggerHandle.setFormatter(cls.formatter)

  @classmethod
  def getLogger(cls,name):
    logger=logging.getLogger(name)
    if logger.handlers == []:
      logger.setLevel(logging.getLevelName(Settings.logLevel))
      logger.addHandler(cls.loggerHandle)
    return logger

  @classmethod
  def printColorMessage(cls, message,textColor = ColoredFormatter.RED, background = None):
    
    coloredMessage = ''.join((ColoredFormatter.CSI_SEQUENCE, (str(textColor + 30)),
                            'm', message, ColoredFormatter.RESET_SEQUECE))
    
    print(coloredMessage)

  @classmethod
  def printStartActionMessage(cls, action, textColor = ColoredFormatter.GREEN):
    cls.printColorMessage(ACTION_START_MESSAGE.replace('[ACTION]',action),textColor)
  
  @classmethod
  def printEndActionMessage(cls, action, textColor = ColoredFormatter.GREEN):
    cls.printColorMessage(ACTION_END_MESSAGE.replace('[ACTION]',action),textColor)

  @classmethod
  def cleanThirdPartyLoggers(cls):
    """
      Removes all logger handles created in third party scripts.
    """
    for handler in logging.root.handlers:
      if handler != cls.loggerHandle:
        logging.root.removeHandler(handler)