terminal.py 4.42 KB
Newer Older
1 2
# Copyright (c) 2011 The Chromium OS Authors.
#
3
# SPDX-License-Identifier:	GPL-2.0+
4 5 6 7 8 9 10
#

"""Terminal utilities

This module handles terminal interaction including ANSI color codes.
"""

11 12
from __future__ import print_function

13 14 15 16 17 18
import os
import sys

# Selection of when we want our output to be colored
COLOR_IF_TERMINAL, COLOR_ALWAYS, COLOR_NEVER = range(3)

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
# Initially, we are set up to print to the terminal
print_test_mode = False
print_test_list = []

class PrintLine:
    """A line of text output

    Members:
        text: Text line that was printed
        newline: True to output a newline after the text
        colour: Text colour to use
    """
    def __init__(self, text, newline, colour):
        self.text = text
        self.newline = newline
        self.colour = colour

    def __str__(self):
        return 'newline=%s, colour=%s, text=%s' % (self.newline, self.colour,
                self.text)

def Print(text='', newline=True, colour=None):
    """Handle a line of output to the terminal.

    In test mode this is recorded in a list. Otherwise it is output to the
    terminal.

    Args:
        text: Text to print
        newline: True to add a new line at the end of the text
        colour: Colour to use for the text
    """
    if print_test_mode:
        print_test_list.append(PrintLine(text, newline, colour))
    else:
        if colour:
            col = Color()
            text = col.Color(colour, text)
57
        print(text, end='')
58
        if newline:
59
            print()
60 61
        else:
            sys.stdout.flush()
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

def SetPrintTestMode():
    """Go into test mode, where all printing is recorded"""
    global print_test_mode

    print_test_mode = True

def GetPrintTestLines():
    """Get a list of all lines output through Print()

    Returns:
        A list of PrintLine objects
    """
    global print_test_list

    ret = print_test_list
    print_test_list = []
    return ret

def EchoPrintTestLines():
    """Print out the text lines collected"""
    for line in print_test_list:
        if line.colour:
            col = Color()
86
            print(col.Color(line.colour, line.text), end='')
87
        else:
88
            print(line.text, end='')
89
        if line.newline:
90
            print()
91 92


93
class Color(object):
94 95 96 97 98 99 100
    """Conditionally wraps text in ANSI color escape sequences."""
    BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
    BOLD = -1
    BRIGHT_START = '\033[1;%dm'
    NORMAL_START = '\033[22;%dm'
    BOLD_START = '\033[1m'
    RESET = '\033[0m'
101

102 103
    def __init__(self, colored=COLOR_IF_TERMINAL):
        """Create a new Color object, optionally disabling color output.
104

105 106 107 108
        Args:
          enabled: True if color output should be enabled. If False then this
            class will not add color codes at all.
        """
109 110 111 112 113 114
        try:
            self._enabled = (colored == COLOR_ALWAYS or
                    (colored == COLOR_IF_TERMINAL and
                     os.isatty(sys.stdout.fileno())))
        except:
            self._enabled = False
115

116 117
    def Start(self, color, bright=True):
        """Returns a start color code.
118

119 120
        Args:
          color: Color to use, .e.g BLACK, RED, etc.
121

122 123 124 125 126 127 128 129
        Returns:
          If color is enabled, returns an ANSI sequence to start the given
          color, otherwise returns empty string
        """
        if self._enabled:
            base = self.BRIGHT_START if bright else self.NORMAL_START
            return base % (color + 30)
        return ''
130

131 132
    def Stop(self):
        """Retruns a stop color code.
133

134 135 136 137 138 139 140
        Returns:
          If color is enabled, returns an ANSI color reset sequence,
          otherwise returns empty string
        """
        if self._enabled:
            return self.RESET
        return ''
141

142 143
    def Color(self, color, text, bright=True):
        """Returns text with conditionally added color escape sequences.
144

145 146 147 148
        Keyword arguments:
          color: Text color -- one of the color constants defined in this
                  class.
          text: The text to color.
149

150 151 152 153 154 155 156 157 158 159 160 161 162
        Returns:
          If self._enabled is False, returns the original text. If it's True,
          returns text with color escape sequences based on the value of
          color.
        """
        if not self._enabled:
            return text
        if color == self.BOLD:
            start = self.BOLD_START
        else:
            base = self.BRIGHT_START if bright else self.NORMAL_START
            start = base % (color + 30)
        return start + text + self.RESET