Skip to content

colors

Color

A class for terminal color codes.

Source code in m/color/colors.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class Color:
    """A class for terminal color codes."""

    bold = '\033[1m'
    blue = '\033[94m'
    aqua = '\033[96m'
    white = '\033[97m'
    green = '\033[92m'
    orange = '\033[38;5;172m'
    yellow = '\033[93m'
    gray = '\033[90m'
    red = '\033[91m'
    purple = '\033[95m'
    bold_white = bold + white
    bold_blue = bold + blue
    bold_aqua = bold + aqua
    bold_green = bold + green
    bold_orange = bold + orange
    bold_yellow = bold + yellow
    bold_gray = bold + gray
    bold_red = bold + red
    bold_purple = bold + purple
    end = '\033[0m'

color(*args, auto_end=True)

Color a message.

Format the arguments by replacing the colors in the Colors class. For instance::

color('{blue}Hello there{end}\n{yellow}WARNING')

Parameters:

Name Type Description Default
args str

Strings to color

 ()
auto_end bool

Add a string to end coloring

 True

Returns:

Type Description
str

A formatted message.
Source code in m/color/colors.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def color(*args: str, auto_end: bool = True) -> str:
    r"""Color a message.

    Format the arguments by replacing the colors in the Colors class.
    For instance::

        color('{blue}Hello there{end}\n{yellow}WARNING')

    Args:
        args: Strings to color
        auto_end: Add a string to end coloring

    Returns:
        A formatted message.
    """
    no_color = color_disabled()
    color_map = no_color_dict if no_color else color_dict
    end = '' if no_color or not auto_end else Color.end
    msg_list = [msg.format(**color_map) for msg in args]
    return ''.join(msg_list) + end