mirror of
https://gerrit.googlesource.com/git-repo
synced 2024-12-21 07:16:21 +00:00
70d861fa29
When displaying progress bars, we use \r to reset the cursor to the start of the line before showing the new update. This assumes the new line will fully erase whatever was displayed there previously. The "done" codepath tries to handle this by including a few extra spaces at the end of the message to "white out" what was there. Lets replace that hack with the standard ECMA escape sequence that clears the current line completely. This is the CSI "erase in line" sequence that the terminal will use to delete all content. The \r is still needed to move the cursor to the start of the line. Using this sequence should be OK since we're already assuming the terminal is ECMA compliant with our use of coloring sequences. We also put the \r after the CSI sequence on the off chance the terminal can't process it and displays a few bytes of garbage. The other improvement is to the syncbuffer API. When it dumps its status information, it almost always comes after a progress bar update which leads to confusing comingled output. Something like: Fetching projects: 100% (2/2) error: src/platform2/: branch ... Since the progress bar is "throw away", have the syncbuffer reset the current output to the start of the line before showing whatever messages it has queued. Bug: https://crbug.com/gerrit/11293 Change-Id: I6544d073fe993d98ee7e91fca5e501ba5fecfe4c Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/236615 Reviewed-by: David Pursehouse <dpursehouse@collab.net> Tested-by: Mike Frysinger <vapier@google.com>
93 lines
2.5 KiB
Python
93 lines
2.5 KiB
Python
# -*- coding:utf-8 -*-
|
|
#
|
|
# Copyright (C) 2009 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import sys
|
|
from time import time
|
|
from repo_trace import IsTrace
|
|
|
|
_NOT_TTY = not os.isatty(2)
|
|
|
|
# This will erase all content in the current line (wherever the cursor is).
|
|
# It does not move the cursor, so this is usually followed by \r to move to
|
|
# column 0.
|
|
CSI_ERASE_LINE = '\x1b[2K'
|
|
|
|
class Progress(object):
|
|
def __init__(self, title, total=0, units='', print_newline=False,
|
|
always_print_percentage=False):
|
|
self._title = title
|
|
self._total = total
|
|
self._done = 0
|
|
self._lastp = -1
|
|
self._start = time()
|
|
self._show = False
|
|
self._units = units
|
|
self._print_newline = print_newline
|
|
self._always_print_percentage = always_print_percentage
|
|
|
|
def update(self, inc=1):
|
|
self._done += inc
|
|
|
|
if _NOT_TTY or IsTrace():
|
|
return
|
|
|
|
if not self._show:
|
|
if 0.5 <= time() - self._start:
|
|
self._show = True
|
|
else:
|
|
return
|
|
|
|
if self._total <= 0:
|
|
sys.stderr.write('%s\r%s: %d,' % (
|
|
CSI_ERASE_LINE,
|
|
self._title,
|
|
self._done))
|
|
sys.stderr.flush()
|
|
else:
|
|
p = (100 * self._done) / self._total
|
|
|
|
if self._lastp != p or self._always_print_percentage:
|
|
self._lastp = p
|
|
sys.stderr.write('%s\r%s: %3d%% (%d%s/%d%s)%s' % (
|
|
CSI_ERASE_LINE,
|
|
self._title,
|
|
p,
|
|
self._done, self._units,
|
|
self._total, self._units,
|
|
"\n" if self._print_newline else ""))
|
|
sys.stderr.flush()
|
|
|
|
def end(self):
|
|
if _NOT_TTY or IsTrace() or not self._show:
|
|
return
|
|
|
|
if self._total <= 0:
|
|
sys.stderr.write('%s\r%s: %d, done.\n' % (
|
|
CSI_ERASE_LINE,
|
|
self._title,
|
|
self._done))
|
|
sys.stderr.flush()
|
|
else:
|
|
p = (100 * self._done) / self._total
|
|
sys.stderr.write('%s\r%s: %3d%% (%d%s/%d%s), done.\n' % (
|
|
CSI_ERASE_LINE,
|
|
self._title,
|
|
p,
|
|
self._done, self._units,
|
|
self._total, self._units))
|
|
sys.stderr.flush()
|