Skip to main content

Convenience functions for ANSI terminal colour sequences

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cs.ansi_colour-20180726.tar.gz (2.7 kB) Copy SHA256 hash SHA256 Source None Jul 25, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page