Inheritance diagram for ANSIColors:

Public Member Functions
	convert_color (cls, color)

	color (cls, foreground=None, background=None, bold=False, underline=False, inverted=False)

	fg (cls, color)

	bg (cls, color)

	reset (cls)

Static Public Member Functions
	supported ()

Detailed Description

Simple class to handle color output to the terminal.

This class allows to very easily add color output to the terminal

>>> from terminal_utils import ANSIColors as ac
>>> print(f"{ac.fg('red')}Some text in {ac.color(underline=True)}RED{ac.reset()}")

The basic colors can be specified by name (case insensitive) or by enum value.
Custom colors can be supplied using hex notation like ``#rgb`` or ``#rrggbb``
(Hint: ``matplotlib.colors.to_hex`` might be useful here). As an example to
use the viridis colormap to color the output on the terminal::

    from matplotlib import cm
    from matplotlib.colors import to_hex
    from terminal_utils import ANSIColors as ac

    # sample the viridis colormap at 16 points
    for i in range(16):
        # convert i to be in [0..1] and get the hex color
        color = to_hex(cm.viridis(i/15))
        # and print the hex color in the correct color
        print(f"{i}. {ac.fg(color)}{color}{ac.reset()}")


If the output is not to a terminal color output will be disabled and nothing
will be added to the output, for example when redirecting the output to a
logfile.

Definition at line 33 of file terminal_utils.py.

Member Function Documentation

◆ bg()

bg	(		cls,
			color )

Shorthand for `color(background=color) <color>`

Definition at line 149 of file terminal_utils.py.

    def bg(cls, color):
        """Shorthand for `color(background=color) <color>`"""
        return cls.color(background=color)
 

◆ color()

color	(	cls,
		foreground = None,
		background = None,
		bold = False,
		underline = False,
		inverted = False )

Change terminal colors to the given foreground/background colors and attributes.

This will return a string to be printed to change the color on the terminal.
To revert to default print the output of `reset()`

Parameters:
    foreground (int or str): foreground color to use, can be any value accepted by `convert_color`
                             If None is given the current color will not be changed.
    background (int or str): background color to use, can be any value accepted by `convert_color`.
                             If None is given the current color will not be changed.
    bold (bool): Use bold font
    underline (bool): Underline the text
    inverted (bool): Flip background and foreground color

Definition at line 109 of file terminal_utils.py.

    def color(cls, foreground=None, background=None, bold=False, underline=False, inverted=False):
        """
        Change terminal colors to the given foreground/background colors and attributes.
 
        This will return a string to be printed to change the color on the terminal.
        To revert to default print the output of `reset()`
 
        Parameters:
            foreground (int or str): foreground color to use, can be any value accepted by `convert_color`
                                     If None is given the current color will not be changed.
            background (int or str): background color to use, can be any value accepted by `convert_color`.
                                     If None is given the current color will not be changed.
            bold (bool): Use bold font
            underline (bool): Underline the text
            inverted (bool): Flip background and foreground color
        """
        if not cls.supported():
            return ""
 
        codes = []
        if foreground is not None:
            codes.append(f"38;{cls.convert_color(foreground)}")
        if background is not None:
            codes.append(f"48;{cls.convert_color(background)}")
        if bold:
            codes.append(1)
        if underline:
            codes.append(4)
        if inverted:
            codes.append(7)
        if not codes:
            return ""
        return f"\x1b[{';'.join(map(str, codes))}m"
 

◆ convert_color()

convert_color	(		cls,
			color )

Convert a color to the necessary ansi code. The argument can either bei

* an integer corresponding to the ansi color (see the enum values of this class)
* the name (case insensitive) of one of the enum values of this class
* a hex color code of the form ``#rgb`` or ``#rrggbb``

Raises:
    KeyError: if the argument is a string not matching to one of the known colors

Definition at line 85 of file terminal_utils.py.

    def convert_color(cls, color):
        """Convert a color to the necessary ansi code. The argument can either bei
 
        * an integer corresponding to the ansi color (see the enum values of this class)
        * the name (case insensitive) of one of the enum values of this class
        * a hex color code of the form ``#rgb`` or ``#rrggbb``
 
        Raises:
            KeyError: if the argument is a string not matching to one of the known colors
        """
        if isinstance(color, str):
            if color[0] == '#':
                if len(color) == 4:
                    r, g, b = (int(e, 16)*17 for e in color[1:])
                else:
                    r, g, b = (int(color[i:i+2], 16) for i in [1, 3, 5])
                return f"2;{r};{g};{b}"
            try:
                color = cls[color.upper()].value
            except KeyError as e:
                raise KeyError(f"Unknown color: '{color}'") from e
        return f"5;{color}"
 

◆ fg()

fg	(		cls,
			color )

Shorthand for `color(foreground=color) <color>`

Definition at line 144 of file terminal_utils.py.

    def fg(cls, color):
        """Shorthand for `color(foreground=color) <color>`"""
        return cls.color(foreground=color)
 

◆ reset()

reset ( cls )

Reset colors to default

Definition at line 154 of file terminal_utils.py.

    def reset(cls):
        """Reset colors to default"""
        return '\x1b[0m' if cls.supported() else ''
 
 

◆ supported()

supported ( )

static

Check whether the output is a terminal.

If this is False, the methods `color`, `fg`, `bg` and `reset` will only
return an empty string as color output will be disabled

Definition at line 75 of file terminal_utils.py.

    def supported():
        """
        Check whether the output is a terminal.
 
        If this is False, the methods `color`, `fg`, `bg` and `reset` will only
        return an empty string as color output will be disabled
        """
        return sys.stdout.isatty()
 

The documentation for this class was generated from the following file:

framework/scripts/terminal_utils.py

Public Member Functions

Static Public Member Functions