Package: cs.ansi-colour
Convenience functions for ANSI terminal colour sequences [color].Latest release 20220227:New TerminalColors class parsing /etc/terminal-colors.d and honouring $*_COLORS.New colour_escape(code) to make the escape sequence for a colour code.New COLOUR_CODES mapping of known colour names.Mapping and function for adding ANSI terminal colour escape sequences
to strings for colour highlighting of output.Functioncolour_escape(code)Return the ANSI escape sequence to activate the colourcode.codemay be anintor astrwhich indexesCOLOUR_CODES.Functioncolourise(s, colour=None, uncolour=None)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' (fromNORMAL_COLOUR).Functioncolourise_patterns(s, patterns, default_colour=None)Colourise a stringsaccording topatterns.Parameters: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 "cyan" (fromDEFAULT_HIGHLIGHT).Each pattern may be:a string of the form "[colour]:regexp"a string containing no colon, taken to be a regexpa tuple of the form(colour,regexp)a regexp objectReturns the string with ANSI colour escapes embedded.Functionenv_no_color(environ=None)Test the$NO_COLORenvironment variable per the specification athttps://no-color.org/Functionmake_pattern(pattern, default_colour=None)Convert apatternspecification into a(colour,regexp)tuple.Parameters:pattern: the pattern to parsedefault_colour: the highlight colour,
default "cyan" (fromDEFAULT_HIGHLIGHT).Eachpatternmay be:a string of the form "[colour]:regexp"a string containing no colon, taken to be a regexpa tuple of the form(colour,regexp)a regexp objectFunctionmake_patterns(patterns, default_colour=None)Convert an iterable of pattern specifications into a list of(colour,regexp)tuples.Parameters:patterns: an iterable of patterns to parsedefault_colour: the highlight colour,
default "cyan" (fromDEFAULT_HIGHLIGHT).Each pattern may be:a string of the form "[colour]:regexp"a string containing no colon, taken to be a regexpa tuple of the form (colour, regexp)a regexp objectClassTerminalColorsA parser for/etc/terminal-colors.d'files.MethodTerminalColors.__init__(self, util_name=None, term_name=None, type_name=None, colors_dirpath=None, envvar=None):
Initialise theTerminalColorsinstance.Parameters:util_name: optional utility name, default fromsys.argv[0]term_name: optional terminal name, default from the$TERMenvvartype_name: optional type name, default'enable'colors_dirpath: optional specification files directory path,
default fromTerminalColors.TERMINAL_COLORS_Denvvar: environment variable to override matches;
the defaultutil_name+'_COLORS',
thus$LS_COLORSifutil_name=='ls'.
That may be the valueFalseif no environment variable should be an override.MethodTerminalColors.convert_sequence(sequence):
Convert a colour specification to an escape sequence.MethodTerminalColors.find_specfile(self):
Locate the most specific specification file matching our criteria.
ReturnNoneif no file matches.PropertyTerminalColors.mapping:
The mapping ofnameto escape sequence.MethodTerminalColors.scan(self, path=None):
Scan the colour specification inpathand yield(name,escape_sequence)tuples.Release LogRelease 20220227:New TerminalColors class parsing /etc/terminal-colors.d and honouring $*_COLORS.New colour_escape(code) to make the escape sequence for a colour code.New COLOUR_CODES mapping of known colour names.Release 20200729:New env_no_color() test function honouring the $NO_COLOUR envvar perhttps://no-color.org/colourise: get the "normal" default from the global NORMAL_COLOUR.Release 20180726:
greater markdowning of docstringsRelease 20180725.2:
some markdown, still release testingRelease 20180725.1:
Trivial changes, testing release process.Release 20180725:
rename second colourise function to colourise_patterns, was shadowing thingsRelease 20180422:New function colourise to colour strings with regexp matches.New helper functions make_pattern and make_patterns to construct (colour, regexp)s from specifications.New public names NORMAL_COLOUR and DEFAULT_HIGHLIGHT.Release 20170902:
Release metadata changes.Release 20160828:
Add PyPI category, other minor tweaks.Release 20150112:
PyPI release.Release 20150107:
first standalone pypi release