summaryrefslogtreecommitdiff
path: root/tools/patman/tout.py
diff options
context:
space:
mode:
Diffstat (limited to 'tools/patman/tout.py')
-rw-r--r--tools/patman/tout.py179
1 files changed, 0 insertions, 179 deletions
diff --git a/tools/patman/tout.py b/tools/patman/tout.py
deleted file mode 100644
index ff0fd92afcc..00000000000
--- a/tools/patman/tout.py
+++ /dev/null
@@ -1,179 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0+
-# Copyright (c) 2016 Google, Inc
-#
-# Terminal output logging.
-#
-
-import sys
-
-from patman import terminal
-
-# Output verbosity levels that we support
-ERROR, WARNING, NOTICE, INFO, DETAIL, DEBUG = range(6)
-
-in_progress = False
-
-"""
-This class handles output of progress and other useful information
-to the user. It provides for simple verbosity level control and can
-output nothing but errors at verbosity zero.
-
-The idea is that modules set up an Output object early in their years and pass
-it around to other modules that need it. This keeps the output under control
-of a single class.
-
-Public properties:
- verbose: Verbosity level: 0=silent, 1=progress, 3=full, 4=debug
-"""
-def __enter__():
- return
-
-def __exit__(unused1, unused2, unused3):
- """Clean up and remove any progress message."""
- clear_progress()
- return False
-
-def user_is_present():
- """This returns True if it is likely that a user is present.
-
- Sometimes we want to prompt the user, but if no one is there then this
- is a waste of time, and may lock a script which should otherwise fail.
-
- Returns:
- True if it thinks the user is there, and False otherwise
- """
- return stdout_is_tty and verbose > 0
-
-def clear_progress():
- """Clear any active progress message on the terminal."""
- global in_progress
- if verbose > 0 and stdout_is_tty and in_progress:
- _stdout.write('\r%s\r' % (" " * len (_progress)))
- _stdout.flush()
- in_progress = False
-
-def progress(msg, warning=False, trailer='...'):
- """Display progress information.
-
- Args:
- msg: Message to display.
- warning: True if this is a warning."""
- global in_progress
- clear_progress()
- if verbose > 0:
- _progress = msg + trailer
- if stdout_is_tty:
- col = _color.YELLOW if warning else _color.GREEN
- _stdout.write('\r' + _color.build(col, _progress))
- _stdout.flush()
- in_progress = True
- else:
- _stdout.write(_progress + '\n')
-
-def _output(level, msg, color=None):
- """Output a message to the terminal.
-
- Args:
- level: Verbosity level for this message. It will only be displayed if
- this as high as the currently selected level.
- msg; Message to display.
- error: True if this is an error message, else False.
- """
- if verbose >= level:
- clear_progress()
- if color:
- msg = _color.build(color, msg)
- if level < NOTICE:
- print(msg, file=sys.stderr)
- else:
- print(msg)
-
-def do_output(level, msg):
- """Output a message to the terminal.
-
- Args:
- level: Verbosity level for this message. It will only be displayed if
- this as high as the currently selected level.
- msg; Message to display.
- """
- _output(level, msg)
-
-def error(msg):
- """Display an error message
-
- Args:
- msg; Message to display.
- """
- _output(ERROR, msg, _color.RED)
-
-def warning(msg):
- """Display a warning message
-
- Args:
- msg; Message to display.
- """
- _output(WARNING, msg, _color.YELLOW)
-
-def notice(msg):
- """Display an important infomation message
-
- Args:
- msg; Message to display.
- """
- _output(NOTICE, msg)
-
-def info(msg):
- """Display an infomation message
-
- Args:
- msg; Message to display.
- """
- _output(INFO, msg)
-
-def detail(msg):
- """Display a detailed message
-
- Args:
- msg; Message to display.
- """
- _output(DETAIL, msg)
-
-def debug(msg):
- """Display a debug message
-
- Args:
- msg; Message to display.
- """
- _output(DEBUG, msg)
-
-def user_output(msg):
- """Display a message regardless of the current output level.
-
- This is used when the output was specifically requested by the user.
- Args:
- msg; Message to display.
- """
- _output(0, msg)
-
-def init(_verbose=WARNING, stdout=sys.stdout):
- """Initialize a new output object.
-
- Args:
- verbose: Verbosity level (0-4).
- stdout: File to use for stdout.
- """
- global verbose, _progress, _color, _stdout, stdout_is_tty
-
- verbose = _verbose
- _progress = '' # Our last progress message
- _color = terminal.Color()
- _stdout = stdout
-
- # TODO(sjg): Move this into Chromite libraries when we have them
- stdout_is_tty = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()
- stderr_is_tty = hasattr(sys.stderr, 'isatty') and sys.stderr.isatty()
-
-def uninit():
- clear_progress()
-
-init()