log_handler.py

from collections import defaultdict
import logging
import sublime

from .lint import util


DEBUG_FALSE_LEVEL = logging.WARNING
DEBUG_TRUE_LEVEL = logging.INFO
ERROR_PANEL_LEVEL = logging.ERROR

logger = logging.getLogger('SublimeLinter')
logger.setLevel(logging.DEBUG)
handler = None
error_panel_handler = None


def plugin_unloaded():
    uninstall()


def install():
    install_std_handler()
    install_error_panel_handler()

    settings = sublime.load_settings("SublimeLinter.sublime-settings")
    settings.add_on_change('SublimeLinter._logging', install_std_handler)


def uninstall():
    if handler:
        logger.removeHandler(handler)
    if error_panel_handler:
        logger.removeHandler(error_panel_handler)

    settings = sublime.load_settings("SublimeLinter.sublime-settings")
    settings.clear_on_change('SublimeLinter._logging')


def install_std_handler():
    settings = sublime.load_settings("SublimeLinter.sublime-settings")
    level = settings.get('debug', False)
    _install_std_handler(level)


def _install_std_handler(level=False):
    global handler
    if handler:
        logger.removeHandler(handler)

    if level is False:
        level = DEBUG_FALSE_LEVEL
        formatter = TaskNumberFormatter(
            fmt="SublimeLinter: {LEVELNAME}{message}",
            style='{')
        handler = logging.StreamHandler()
        handler.setFormatter(formatter)
    else:
        if level is True:
            level = DEBUG_TRUE_LEVEL
        else:
            level = logging.getLevelName(level.upper())

        formatter = TaskNumberFormatter(
            fmt="SublimeLinter: {LOC:<22} {LEVELNAME}{message}",
            style='{')
        handler = logging.StreamHandler()
        handler.setFormatter(formatter)

    handler.setLevel(level)
    logger.addHandler(handler)
    logger.setLevel(min(ERROR_PANEL_LEVEL, level))
    logger.info(
        'Logging installed; log level {}'.format(logging.getLevelName(level))
    )


def install_error_panel_handler():
    global error_panel_handler
    if error_panel_handler:
        logger.removeHandler(error_panel_handler)

    formatter = TaskNumberFormatter(
        fmt="SublimeLinter: {TASK_NUMBER}{LINTER_NAME}{FILENAME}{levelname}:\n\n"
            "{message}",
        style='{')
    error_panel_handler = ErrorPanelHandler()
    error_panel_handler.setFormatter(formatter)
    error_panel_handler.setLevel(ERROR_PANEL_LEVEL)

    logger.addHandler(error_panel_handler)


class TaskNumberFormatter(logging.Formatter):
    def format(self, record):
        thread_name = record.threadName
        if thread_name.startswith('LintTask|'):
            _, task_number, linter_name, filename, vid = thread_name.split('|')
            record.TASK_NUMBER = '#{} '.format(task_number)
            record.LINTER_NAME = linter_name + ' '
            record.FILENAME = filename + ' '
            record.VIEW = sublime.View(int(vid))
        else:
            record.TASK_NUMBER = ''
            record.LINTER_NAME = ''
            record.FILENAME = ''
            record.VIEW = None

        levelno = record.levelno
        if levelno > logging.INFO:
            record.LEVELNAME = record.levelname + ': '
        else:
            record.LEVELNAME = ''

        record.LOC = '{}{}:{}'.format(record.TASK_NUMBER, record.filename, record.lineno)

        return super().format(record)


shown_error_messages = defaultdict(set)


class ErrorPanelHandler(logging.Handler):
    def emit(self, record):
        if getattr(record, 'demote', False):
            return

        try:
            msg = self.format(record)
            lines = msg.splitlines()
            header, rest = lines[0], '\n'.join(lines[1:])

            window = record.VIEW.window() if record.VIEW else sublime.active_window()
            if not window:
                return

            wid = window.id()
            if rest in shown_error_messages[wid]:
                return

            shown_error_messages[wid].add(rest)

            beaty_msg = '\n'.join([header, '=' * len(header), rest])
            util.show_message(beaty_msg, window)
        except Exception:
            self.handleError(record)


_install_std_handler()