1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2016 Google, Inc
4 # Terminal output logging.
9 from patman import terminal
11 # Output verbosity levels that we support
12 ERROR, WARNING, NOTICE, INFO, DETAIL, DEBUG = range(6)
17 This class handles output of progress and other useful information
18 to the user. It provides for simple verbosity level control and can
19 output nothing but errors at verbosity zero.
21 The idea is that modules set up an Output object early in their years and pass
22 it around to other modules that need it. This keeps the output under control
26 verbose: Verbosity level: 0=silent, 1=progress, 3=full, 4=debug
31 def __exit__(unused1, unused2, unused3):
32 """Clean up and remove any progress message."""
37 """This returns True if it is likely that a user is present.
39 Sometimes we want to prompt the user, but if no one is there then this
40 is a waste of time, and may lock a script which should otherwise fail.
43 True if it thinks the user is there, and False otherwise
45 return stdout_is_tty and verbose > 0
48 """Clear any active progress message on the terminal."""
50 if verbose > 0 and stdout_is_tty and in_progress:
51 _stdout.write('\r%s\r' % (" " * len (_progress)))
55 def Progress(msg, warning=False, trailer='...'):
56 """Display progress information.
59 msg: Message to display.
60 warning: True if this is a warning."""
64 _progress = msg + trailer
66 col = _color.YELLOW if warning else _color.GREEN
67 _stdout.write('\r' + _color.Color(col, _progress))
71 _stdout.write(_progress + '\n')
73 def _Output(level, msg, color=None):
74 """Output a message to the terminal.
77 level: Verbosity level for this message. It will only be displayed if
78 this as high as the currently selected level.
79 msg; Message to display.
80 error: True if this is an error message, else False.
85 msg = _color.Color(color, msg)
88 def DoOutput(level, msg):
89 """Output a message to the terminal.
92 level: Verbosity level for this message. It will only be displayed if
93 this as high as the currently selected level.
94 msg; Message to display.
99 """Display an error message
102 msg; Message to display.
104 _Output(ERROR, msg, _color.RED)
107 """Display a warning message
110 msg; Message to display.
112 _Output(WARNING, msg, _color.YELLOW)
115 """Display an important infomation message
118 msg; Message to display.
123 """Display an infomation message
126 msg; Message to display.
131 """Display a detailed message
134 msg; Message to display.
139 """Display a debug message
142 msg; Message to display.
147 """Display a message regardless of the current output level.
149 This is used when the output was specifically requested by the user.
151 msg; Message to display.
155 def Init(_verbose=WARNING, stdout=sys.stdout):
156 """Initialize a new output object.
159 verbose: Verbosity level (0-4).
160 stdout: File to use for stdout.
162 global verbose, _progress, _color, _stdout, stdout_is_tty
165 _progress = '' # Our last progress message
166 _color = terminal.Color()
169 # TODO(sjg): Move this into Chromite libraries when we have them
170 stdout_is_tty = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()