beffroi-tools/tools/progress.py

105 lines
3.2 KiB
Python

"""Transient terminal progress with ordinary line logs when redirected."""
import os
import shutil
import sys
import threading
import time
_active = None
def status(message, level='info', *, persist=False):
if _active is not None:
_active.message(message, level, persist)
else:
_print_status(message, level)
def _print_status(message, level):
stream = sys.stderr if level in ('warning', 'error') else sys.stdout
label, color = {
'info': ('INFO', '36'), 'success': ('OK', '32'),
'warning': ('WARN', '33'), 'error': ('ERROR', '31'),
}[level]
prefix = f'[{label}]'
if stream.isatty() and 'NO_COLOR' not in os.environ and os.environ.get('TERM') != 'dumb':
prefix = f'\033[{color}m{prefix}\033[0m'
print(f'{prefix} {message}', file=stream, flush=True)
class Progress:
def __init__(self):
self.stream = sys.stderr
self.interactive = self.stream.isatty() and sys.stdout.isatty() and os.environ.get('TERM') != 'dumb'
self.lock = threading.RLock()
self.stop = threading.Event()
self.thread = None
self.text = ''
self.done = 0
self.total = None
self.started = time.monotonic()
self.previous = None
def __enter__(self):
global _active
self.previous, _active = _active, self
if self.interactive:
self.thread = threading.Thread(target=self._animate, daemon=True)
self.thread.start()
return self
def __exit__(self, *_):
global _active
self.stop.set()
if self.thread:
self.thread.join()
with self.lock:
self._clear()
_active = self.previous
def set(self, done, total=None):
with self.lock:
self.done = done
if total is not None:
self.total = total
self._draw()
def message(self, message, level, persist):
with self.lock:
if not self.interactive:
_print_status(message, level)
elif persist or level in ('warning', 'error'):
self._clear()
_print_status(message, level)
self.text = ''
else:
self.text = ' '.join(str(message).split())
self._draw()
def _clear(self):
if self.interactive:
self.stream.write('\r\033[2K')
self.stream.flush()
def _draw(self):
if not self.interactive or not self.text:
return
elapsed = time.monotonic() - self.started
spinner = '|/-\\'[int(elapsed * 8) % 4]
if self.total:
filled = min(16, max(0, int(16 * self.done / self.total)))
indicator = '[' + '=' * filled + '-' * (16 - filled) + f'] {self.done}/{self.total}'
else:
indicator = spinner
width = max(1, shutil.get_terminal_size((80, 24)).columns - 1)
line = f'{spinner} {indicator} {elapsed:5.1f}s {self.text}'[:width]
if 'NO_COLOR' not in os.environ:
line = f'\033[36m{line}\033[0m'
self.stream.write('\r\033[2K' + line)
self.stream.flush()
def _animate(self):
while not self.stop.wait(0.1):
with self.lock:
self._draw()