cs-ansi-colour 20180726

Convenience functions for ANSI terminal colour sequences

Mapping and function for adding ANSI terminal colour escape sequences to strings for colour highlighting of output.

Function colourise(s, colour=None, uncolour='normal')

Return a string enclosed in colour-on and colour-off ANSI sequences.

• colour: names the desired ANSI colour.
• uncolour: may be used to specify the colour-off colour; the default is 'normal'.

Function colourise_patterns(s, patterns, default_colour=None)

Colourise a string according to patterns.

• s: the string
• patterns: a sequence of patterns
• default_colour: if a string pattern has no colon, or starts with a colon, use this colour; default DEFAULT_HIGHLIGHT

Each pattern may be:

• a string of the form "[colour]:regexp"
• a string containing no colon, taken to be a regexp
• a tuple of the form (colour, regexp)
• a regexp object

Returns the string with ANSI colour escapes embedded.

Function make_pattern(pattern, default_colour=None)

Convert a pattern specification into a (colour, regexp) tuple.

Each pattern may be:

• a string of the form "[colour]:regexp"
• a string containing no colon, taken to be a regexp
• a tuple of the form (colour, regexp)
• a regexp object

Function make_patterns(patterns, default_colour=None)

Convert an iterable of pattern specifications into a list of (colour, regexp) tuples.

Each pattern may be:

• a string of the form "[colour]:regexp"
• a string containing no colon, taken to be a regexp
• a tuple of the form (colour, regexp)
• a regexp object