103 lines
2.7 KiB
Python
103 lines
2.7 KiB
Python
"""
|
|
Support for ANSI colours in command-line client.
|
|
|
|
.. data:: ESC
|
|
ansi escape character
|
|
|
|
.. data:: RESET
|
|
ansi reset colour (ansi value)
|
|
|
|
.. data:: COLOURS_NAMED
|
|
dict of colour names mapped to their ansi value
|
|
|
|
.. data:: COLOURS_MIDS
|
|
A list of ansi values for Mid Spectrum Colours
|
|
"""
|
|
|
|
import itertools
|
|
import sys
|
|
|
|
ESC = chr(0x1B)
|
|
RESET = "0"
|
|
|
|
COLOURS_NAMED = dict(list(zip(
|
|
['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'],
|
|
[str(x) for x in range(30, 38)]
|
|
)))
|
|
COLOURS_MIDS = [
|
|
colour for name, colour in list(COLOURS_NAMED.items())
|
|
if name not in ('black', 'white')
|
|
]
|
|
|
|
class AnsiColourException(Exception):
|
|
''' Exception while processing ansi colours '''
|
|
pass
|
|
|
|
class ColourMap(object):
|
|
'''
|
|
Object that allows for mapping strings to ansi colour values.
|
|
'''
|
|
def __init__(self, colors=COLOURS_MIDS):
|
|
''' uses the list of ansi `colors` values to initialize the map '''
|
|
self._cmap = {}
|
|
self._colourIter = itertools.cycle(colors)
|
|
|
|
def colourFor(self, string):
|
|
'''
|
|
Returns an ansi colour value given a `string`.
|
|
The same ansi colour value is always returned for the same string
|
|
'''
|
|
if string not in self._cmap:
|
|
self._cmap[string] = next(self._colourIter)
|
|
return self._cmap[string]
|
|
|
|
class AnsiCmd(object):
|
|
def __init__(self, forceAnsi):
|
|
self.forceAnsi = forceAnsi
|
|
|
|
def cmdReset(self):
|
|
''' Returns the ansi cmd colour for a RESET '''
|
|
if sys.stdout.isatty() or self.forceAnsi:
|
|
return ESC + "[0m"
|
|
else:
|
|
return ""
|
|
|
|
def cmdColour(self, colour):
|
|
'''
|
|
Return the ansi cmd colour (i.e. escape sequence)
|
|
for the ansi `colour` value
|
|
'''
|
|
if sys.stdout.isatty() or self.forceAnsi:
|
|
return ESC + "[" + colour + "m"
|
|
else:
|
|
return ""
|
|
|
|
def cmdColourNamed(self, colour):
|
|
''' Return the ansi cmdColour for a given named `colour` '''
|
|
try:
|
|
return self.cmdColour(COLOURS_NAMED[colour])
|
|
except KeyError:
|
|
raise AnsiColourException('Unknown Colour %s' % (colour))
|
|
|
|
def cmdBold(self):
|
|
if sys.stdout.isatty() or self.forceAnsi:
|
|
return ESC + "[1m"
|
|
else:
|
|
return ""
|
|
|
|
def cmdUnderline(self):
|
|
if sys.stdout.isatty() or self.forceAnsi:
|
|
return ESC + "[4m"
|
|
else:
|
|
return ""
|
|
|
|
"""These exist to maintain compatibility with users of version<=1.9.0"""
|
|
def cmdReset():
|
|
return AnsiCmd(False).cmdReset()
|
|
|
|
def cmdColour(colour):
|
|
return AnsiCmd(False).cmdColour(colour)
|
|
|
|
def cmdColourNamed(colour):
|
|
return AnsiCmd(False).cmdColourNamed(colour)
|