Source code for plainbox.impl.color

# This file is part of Checkbox.
# Copyright 2013 Canonical Ltd.
# Written by:
#   Zygmunt Krynicki <>
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.

# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with Checkbox.  If not, see <>.

:mod:`plainbox.impl.color` -- ANSI color codes
import sys

[docs]class ansi_on: """ ANSI control codes for various useful stuff. Reference source: wikipedia """
[docs] class f: """ Foreground color attributes """ BLACK = 30 RED = 31 GREEN = 32 YELLOW = 33 BLUE = 34 MAGENTA = 35 CYAN = 36 WHITE = 37 # what was 38? RESET = 39
[docs] class b: """ Background color attributes """ BLACK = 40 RED = 41 GREEN = 42 YELLOW = 44 BLUE = 44 MAGENTA = 45 CYAN = 46 WHITE = 47 # what was 48? RESET = 49
[docs] class s: """ Style attributes """ BRIGHT = 1 DIM = 2 NORMAL = 22 RESET_ALL = 0
[docs]class ansi_off:
[docs] class f: pass
[docs] class b: pass
[docs] class s: pass
# Convert from numbers to full escape sequences for obj_on, obj_off in zip( (ansi_on.f, ansi_on.b, ansi_on.s), (ansi_off.f, ansi_off.b, ansi_off.s)): for name in [name for name in dir(obj_on) if name.isupper()]: setattr(obj_on, name, "\033[%sm" % getattr(obj_on, name)) setattr(obj_off, name, "") # XXX: Temporary hack that disables colors on win32 until # all of the codebase has been ported over to use colorama if sys.platform == 'win32': try: import colorama except ImportError: ansi_on = ansi_off else: colorama.init()
[docs]def get_color_for_tty(stream=None): """ Get ``ansi_on`` if stdout is a tty, ``ansi_off`` otherwise. :param stream: Alternate stream to use (sys.stdout by default) :returns: ``ansi_on`` or ``ansi_off``, depending on if the stream being a tty or not. """ if stream is None: stream = sys.stdout return ansi_on if stream.isatty() else ansi_off
[docs]class Colorizer: """ Colorizing helper for various kinds of content we need to handle """ # NOTE: Ideally result and all would be handled by multi-dispatch __call__ def __init__(self, color=None): if color is True: self.c = ansi_on elif color is False: self.c = ansi_off elif color is None: self.c = get_color_for_tty() else: self.c = color @property def is_enabled(self): """ if true, this colorizer is actually using colors This property is useful to let applications customize their behavior if they know color support is desired and enabled. """ return self.c is ansi_on
[docs] def result(self, result): return self.custom( result.tr_outcome(), result.outcome_color_ansi())
[docs] def header(self, text, color_name='WHITE', bright=True, fill='='): return self("[ {} ]".format(text).center(80, fill), color_name, bright)
[docs] def f(self, color_name): return getattr(self.c.f, color_name.upper())
[docs] def b(self, color_name): return getattr(self.c.b, color_name.upper())
[docs] def s(self, style_name): return getattr(self.c.s, style_name.upper())
def __call__(self, text, color_name="WHITE", bright=True): return ''.join([ self.f(color_name), self.c.s.BRIGHT if bright else '', str(text), self.c.s.RESET_ALL])
[docs] def custom(self, text, ansi_code): """ Render a piece of text with custom ANSI styling sequence :param text: The text to stylize :param ansi_code: A string containing ANSI escape sequence to use. :returns: A combination of ``ansi_code``, ``text`` and a fixed reset sequence that resets text styles. .. note:: When the colorizer is not really doing anything (see :meth:`is_enabled`) then custom text is not used at all. This is done to ensure that any custom styling is not permantently enabled if colors are to be disabled. """ return ''.join([ ansi_code if self.is_enabled else "", text, self.c.s.RESET_ALL])
[docs] def BLACK(self, text, bright=True): return self(text, "BLACK", bright)
[docs] def RED(self, text, bright=True): return self(text, "RED", bright)
[docs] def GREEN(self, text, bright=True): return self(text, "GREEN", bright)
[docs] def YELLOW(self, text, bright=True): return self(text, "YELLOW", bright)
[docs] def BLUE(self, text, bright=True): return self(text, "BLUE", bright)
[docs] def MAGENTA(self, text, bright=True): return self(text, "MAGENTA", bright)
[docs] def CYAN(self, text, bright=True): return self(text, "CYAN", bright)
[docs] def WHITE(self, text, bright=True): return self(text, "WHITE", bright)
[docs]class CanonicalColors: """ Canonical Color Palette. Colour is an effective, powerful and instantly recognisable medium for visual communications. To convey the brand personality and brand values, there is a sophisticated colour palette. We have introduced a palette which includes both a fresh, lively orange, and a rich, mature aubergine. The use of aubergine indicates commercial involvement, while orange is a signal of community engagement. These colours are used widely in the brand communications, to convey the precise, reliable and free personality. Ubuntu core colours. The Ubuntu colour palette has been created to reflect the spirit of our brand. :attr:`ubuntu_orange` for a community feel. :attr:`white` for a clean, fresh and light feel. :attr:`black` is used in some versions of the brandmark for flexibility of application and where print restrictions apply. It can also be used for body copy. Supporting colours In addition, there is a supporting colour palette for when communications have a consumer or enterprise focus. - :attr:`light_aubergine` for a consumer focus - :attr:`dark_aubergine` for an enterprise focus - :attr:`mid_aubergine` for a balance of both Neutral colours. :attr:`warm_grey` For balance. The addition of warm grey softens the combination of orange and aubergine and provides a bridge between the two. Warm grey can be used for; backgrounds, graphics, pictograms, dot patterns, charts and diagrams. It can also be used for large size text. :attr:`cool_grey` For typography, particularly body copy. Black can be quite harsh in combination with aubergine, but grey delivers more balance while still being legible. Cool grey can also be used within charts and diagrams. :attr:`text_grey` Text grey is used for small size headings, sub-headings and body copy text only. Canonical core colours. The Canonical colour palette has been created to reflect the spirit of our brand. Aubergine for a smart, focussed feel. White for a clean, fresh and light feel. .. see:: """ #: Ubuntu orange color ubuntu_orange = (0xdd, 0x48, 0x14) #: White color white = (0xff, 0xff, 0xff) #: Black color black = (0x00, 0x00, 0x00) #: Light aubergine color light_aubergine = (0x77, 0x21, 0x6f) #: Mid aubergine color mid_aubergine = (0x5e, 0x27, 0x50) #: Dark aubergine color dark_aubergine = (0x2c, 0x00, 0x1e) #: Warm grey color warm_grey = (0xae, 0xa7, 0x9f) #: Cool grey color cool_grey = (0x33, 0x33, 0x33) #: Color for small grey dots small_dot_grey = (0xae, 0xa7, 0x9f) #: Canonical aubergine color canonical_aubergine = (0x77, 0x29, 0x53) #: Text gray color text_grey = (0x33, 0x33, 0x33)
comments powered by Disqus