log.py

"""
Logging class for jd2chm
"""

import logging
import console

# CRITICAL = 5, ERROR = 4, WARNING = 3, INFO = 2, DEBUG = 1, NOTSET = 0.
DEFAULT_LOG_LEVEL = 2


class WinHandler(logging.Handler):
    """EditCtrl Handler (for jd2chm UI, if available)"""

    def __init__(self, win):
        logging.Handler.__init__(self)
        self.win = win

    def emit(self, record):
        if self.win:
            line = self.format(record)
            self.win.addLogText(line)


class ColorHandler(logging.StreamHandler):
    """Color handler for the console"""

    def __init__(self):
        logging.StreamHandler.__init__(self)

    def emit(self, record):
        if record.levelno == logging.DEBUG:
            console.set_color(console.FOREGROUND_MAGENTA)
        if record.levelno == logging.WARNING:
            console.set_color(console.FOREGROUND_YELLOW)
        if record.levelno == logging.ERROR:
            console.set_color(console.FOREGROUND_RED)
        if record.levelno == logging.CRITICAL:
            console.set_bright_color(console.FOREGROUND_RED)
        line = self.format(record)
        print(line)
        console.set_color()


class Jd2chmLogging:
    DEBUG = 1
    INFO = 2

    def __init__(self, level=INFO):
        self.logger = logging.getLogger('jd2chm')
        self.formatter = logging.Formatter('[%(asctime)s] %(message)s', '%Y-%m-%d %H:%M:%S')
        self.set_level(level)
        # self.stream_handler = logging.StreamHandler()
        self.stream_handler = ColorHandler()
        self.stream_handler.setFormatter(self.formatter)
        self.logger.addHandler(self.stream_handler)
        self.win_handler = None

    def add_win_handler(self, win):
        """Add a windows handler to allow logging in the jd2chm UI (if available)."""
        self.win_handler = WinHandler(win)
        self.win_handler.setFormatter(self.formatter)
        self.logger.addHandler(self.win_handler)

    def set_log_file(self, log_file):
        file_handler = logging.FileHandler(log_file)
        file_handler.setFormatter(self.formatter)
        self.logger.addHandler(file_handler)

    def set_level(self, level=2):
        """level is between 0 and 5: CRITICAL = 5, ERROR = 4, WARNING = 3, INFO = 2, DEBUG = 1, NOTSET = 0."""
        if level not in range(6):
            level = self.INFO
        self.logger.setLevel(level * 10)

    @staticmethod
    def shutdown():
        logging.shutdown()

_logging = None


def get_logging(level=2):
    """Return the singleton logging."""
    global _logging
    if not _logging:
        _logging = Jd2chmLogging(level)
    return _logging


def get_logger(level=2):
    """Facilitate sharing the logger across the different modules."""
    return get_logging(level=2).logger