commit 4b3b1f945e5036900dbd5d7fa75ce10dc3d2998f Author: Radek Pazdera <rpazdera(a)redhat.com&gt; Date: Fri Jun 28 18:51:40 2013 +0200 Common: Adding Colours module This patch adds a new module with helper functions for colouring terminal output of LNST to the lnst.Common package. Signed-off-by: Radek Pazdera <rpazdera(a)redhat.com&gt; Signed-off-by: Jiri Pirko <jiri(a)resnulli.us&gt; lnst/Common/Colours.py | 187 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 187 insertions(+), 0 deletions(-) --- diff --git a/lnst/Common/Colours.py b/lnst/Common/Colours.py new file mode 100644 index 0000000..5a5d385 --- /dev/null +++ b/lnst/Common/Colours.py @@ -0,0 +1,187 @@ +""" +Terminal colouring functions + +Copyright 2013 Red Hat, Inc. +Licensed under the GNU General Public License, version 2 as +published by the Free Software Foundation; see COPYING for details. +""" + +__author__ = """ +rpazdera(a)redhat.com (Radek Pazdera) +""" + +import logging +import os +import re +from lnst.Common.Utils import bool_it + +COLOURS = { + "black": 30, + "red": 31, + "green": 32, + "yellow": 33, + "blue": 34, + "magenta": 25, + "cyan": 36, + "light-gray": 37, + "dark-gray": 90, + "light-red": 91, + "light-green": 92, + "light-yellow": 93, + "light-blue": 94, + "light-magenta": 95, + "light-cyan": 96, + "white": 97, +} + +PRESETS = { + "faded": ["yellow", None, False], + "alert": ["red", None, True], + "highlight": ["blue", None, True], + + "pass": ["green", None, True], + "fail": ["red", None, True], + + "info": ["green", None, True], + "debug": ["blue", None, True], + "warning": ["yellow", None, True], + "error": ["red", None, True], + + "log_header": ["light-gray", None, False] +} + +def name_to_fg_colour(name): + """ Convert name to foreground colour code. + Returns None if the colour name isn't supported. """ + + if not COLOURS.has_key(name): + return None + + return COLOURS[name] + +def name_to_bg_colour(name): + """ Convert name to background color code. + Returns None if the colour name isn't supported. """ + + if not COLOURS.has_key(name): + return None + + return COLOURS[name] + 10 + +def colourize16(string, fg_num=None, bg_num=None, bold=False): + """ Paint the text with foreground/background colours using the + old 16 colour model. """ + + if fg_num != None: + string = "\033[%dm%s\033[0m" % (fg_num, string) + + if bg_num != None: + string = "\033[%dm%s\033[0m" % (bg_num, string) + + if bold: + string = "\033[1m%s\033[0m" % string + + return string + +def colourize256(string, fg_num=None, bg_num=None, bold=False): + """ Paint the text with foreground/background colours using the + newer 256 colour model. """ + + if fg_num != None: + string = "\033[38;5;%dm%s\033[0m" % (fg_num, string) + + if bg_num != None: + string = "\033[48;5;%dm%s\033[0m" % (bg_num, string) + + if bold: + string = "\033[1m%s\033[0m" % string + + return string + +def decorate_string(string, fg_colour=None, bg_colour=None, bold=False): + """ Decorate a string using colours specified as strings. You can + pick one from the set of 16 predefined colours from the COLOURS + dictionary or alternatively, you can use an extended colour + from the 256-colour palette using the "extended(colour_number)" + syntax. To retain the default colour, use the keyword "default". + + A few examples: + + decorate_string(s, "light-blue", "extended(242)") + decorate_string(s, "red", None, True) + decorate_string(s, "red", None, False) + decorate_string(s, "red", "light-gray") + """ + + extended_re = "^extended\(([0-9]+)\)$" + + # parameters for the colouring functions (fg_num, bg_num) + # the bold flag is handled separately + params16 = [] + params256 = [] + + # This part of the code would have to be done for both fg and bg + # We use a for loop here to avoid code duplication + fg = True + for colour_def in [fg_colour, bg_colour]: + if colour_def != None: + # Extended definition + match = re.match(extended_re, colour_def) + if match: + colour_num = int(match.group(1)) + if colour_num >= 1 and colour_num <= 255: + params16.append(None) + params256.append(colour_num) + else: + msg = "Extended colour '%d' out of range (0~255)"\ + % colour_num + raise Exception(msg) + else: + # Standard definition + if colour_def in COLOURS.keys(): + if fg: + colour = name_to_fg_colour(colour_def) + else: + colour = name_to_bg_colour(colour_def) + params16.append(colour) + params256.append(None) + else: + raise Exception("Colour '%s' not supported" % fg_colour) + else: + params16.append(None) + params256.append(None) + fg = False + + string = colourize16(string, params16[0], params16[1], bold) + string = colourize256(string, params256[0], params256[1]) + return string + +def decorate_with_preset(string, preset): + """ Decorate a string using a specified colour preset. """ + + p = PRESETS[preset] + return decorate_string(string, p[0], p[1], p[2]) + +def strip_colours(text): + return re.sub("\033\[[0-9]+(;[0-9]+){0,2}m", "", text) + +def load_presets_from_config(config): + for preset_name in PRESETS: + preset = config.get_option("colours", preset_name) + if preset == None: + continue + fg, bg, bf = preset + + extended_re = "^extended\([0-9]+\)$" + + if fg == "default": + fg = None + elif not re.match(extended_re, fg) and fg not in COLOURS.keys(): + raise Exception("Colour '%s' not supported" % fg) + + if bg == "default": + bg = None + elif not re.match(extended_re, bg) and bg not in COLOURS.keys(): + raise Exception("Colour '%s' not supported" % bg) + + PRESETS[preset_name] = [fg, bg, bool_it(bf)]