kiwi.logger_color_formatter

  1# Copyright (c) 2015 SUSE Linux GmbH.  All rights reserved.
  2#
  3# This file is part of kiwi.
  4#
  5# kiwi is free software: you can redistribute it and/or modify
  6# it under the terms of the GNU General Public License as published by
  7# the Free Software Foundation, either version 3 of the License, or
  8# (at your option) any later version.
  9#
 10# kiwi is distributed in the hope that it will be useful,
 11# but WITHOUT ANY WARRANTY; without even the implied warranty of
 12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 13# GNU General Public License for more details.
 14#
 15# You should have received a copy of the GNU General Public License
 16# along with kiwi.  If not, see <http://www.gnu.org/licenses/>
 17#
 18import logging
 19
 20
 21class ColorMessage:
 22    """
 23    **Implements color messages for Python logging facility**
 24
 25    Has to implement the format_message method to serve as
 26    message formatter
 27    """
 28    def __init__(self):
 29        BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = list(range(8))
 30        self.color = {
 31            'BLACK': BLACK,
 32            'WARNING': YELLOW,
 33            'INFO': WHITE,
 34            'DEBUG': WHITE,
 35            'CRITICAL': YELLOW,
 36            'ERROR': RED,
 37            'RED': RED,
 38            'GREEN': GREEN,
 39            'YELLOW': YELLOW,
 40            'BLUE': BLUE,
 41            'MAGENTA': MAGENTA,
 42            'CYAN': CYAN,
 43            'WHITE': WHITE
 44        }
 45        self.esc = {
 46            'reset': '\033[0m',
 47            'color': '\033[3;%dm',
 48            'color_light': '\033[2;%dm',
 49            'bold': '\033[1m'
 50        }
 51
 52    def format_message(self, level: str, message: str) -> str:
 53        """
 54        Message formatter with support for embedded color sequences
 55
 56        The Message is allowed to contain the following color metadata:
 57
 58        * $RESET, reset to no color mode
 59        * $BOLD, bold
 60        * $COLOR, color the following text
 61        * $LIGHTCOLOR, light color the following text
 62
 63        The color of the message depends on the level and is defined
 64        in the ColorMessage constructor
 65
 66        :param str level: color level name
 67        :param str message: text
 68
 69        :return: color message with escape sequences
 70
 71        :rtype: str
 72        """
 73        message = message.replace(
 74            '$RESET',
 75            self.esc['reset']
 76        ).replace(
 77            '$BOLD',
 78            self.esc['bold']
 79        ).replace(
 80            '$COLOR',
 81            self.esc['color'] % (30 + self.color[level])
 82        ).replace(
 83            '$LIGHTCOLOR',
 84            self.esc['color_light'] % (30 + self.color[level])
 85        )
 86        for color_name, color_id in list(self.color.items()):
 87            message = message.replace(
 88                '$' + color_name,
 89                self.esc['color'] % (color_id + 30)
 90            ).replace(
 91                '$BG' + color_name,
 92                self.esc['color'] % (color_id + 40)
 93            ).replace(
 94                '$BG-' + color_name,
 95                self.esc['color'] % (color_id + 40)
 96            )
 97        return message + self.esc['reset']
 98
 99
100class ColorFormatter(logging.Formatter):
101    """
102    **Extended standard logging Formatter**
103
104    Extended format supporting text with color metadata
105
106    Example:
107
108    .. code:: python
109
110        ColorFormatter(message_format, '%H:%M:%S')
111    """
112    def format(self, record: logging.LogRecord) -> str:
113        """
114        Creates a logging Formatter with support for color messages
115
116        :param tuple record: logging message record
117
118        :return: result from format_message
119        :rtype: str
120        """
121        color = ColorMessage()
122        levelname = record.levelname
123        message = logging.Formatter.format(self, record)
124        return color.format_message(levelname, message)