progress.py
295 lines
| 10.6 KiB
| text/x-python
|
PythonLexer
/ hgext / progress.py
|
r10434 | # progress.py show progress bars for some actions | ||
# | ||||
# Copyright (C) 2010 Augie Fackler <durin42@gmail.com> | ||||
# | ||||
|
r15772 | # This software may be used and distributed according to the terms of the | ||
# GNU General Public License version 2 or any later version. | ||||
|
r10434 | |||
"""show progress bars for some actions | ||||
|
r10450 | This extension uses the progress information logged by hg commands | ||
to draw progress bars that are as informative as possible. Some progress | ||||
|
r10434 | bars only offer indeterminate information, while others have a definite | ||
end point. | ||||
The following settings are available:: | ||||
[progress] | ||||
delay = 3 # number of seconds (float) before showing the progress bar | ||||
|
r14838 | changedelay = 1 # changedelay: minimum delay before showing a new topic. | ||
# If set to less than 3 * refresh, that value will | ||||
# be used instead. | ||||
|
r10434 | refresh = 0.1 # time in seconds between refreshes of the progress bar | ||
|
r13148 | format = topic bar number estimate # format of the progress bar | ||
|
r10434 | width = <none> # if set, the maximum width of the progress information | ||
# (that is, min(width, term width) will be used) | ||||
clear-complete = True # clear the progress bar after it's done | ||||
|
r10656 | disable = False # if true, don't show a progress bar | ||
|
r10788 | assume-tty = False # if true, ALWAYS show a progress bar, unless | ||
# disable is given | ||||
|
r10434 | |||
|
r13147 | Valid entries for the format field are topic, bar, number, unit, | ||
|
r14280 | estimate, speed, and item. item defaults to the last 20 characters of | ||
the item, but this can be changed by adding either ``-<num>`` which | ||||
would take the last num characters, or ``+<num>`` for the first num | ||||
|
r13147 | characters. | ||
|
r10434 | """ | ||
import sys | ||||
import time | ||||
|
r14515 | from mercurial import util | ||
|
r13131 | from mercurial.i18n import _ | ||
|
r10434 | |||
def spacejoin(*args): | ||||
|
r10452 | return ' '.join(s for s in args if s) | ||
|
r10434 | |||
|
r11458 | def shouldprint(ui): | ||
|
r14836 | return util.isatty(sys.stderr) or ui.configbool('progress', 'assume-tty') | ||
|
r11458 | |||
|
r13132 | def fmtremaining(seconds): | ||
if seconds < 60: | ||||
|
r13139 | # i18n: format XX seconds as "XXs" | ||
|
r13132 | return _("%02ds") % (seconds) | ||
minutes = seconds // 60 | ||||
if minutes < 60: | ||||
seconds -= minutes * 60 | ||||
|
r13139 | # i18n: format X minutes and YY seconds as "XmYYs" | ||
|
r13132 | return _("%dm%02ds") % (minutes, seconds) | ||
# we're going to ignore seconds in this case | ||||
minutes += 1 | ||||
hours = minutes // 60 | ||||
minutes -= hours * 60 | ||||
|
r13236 | if hours < 30: | ||
# i18n: format X hours and YY minutes as "XhYYm" | ||||
return _("%dh%02dm") % (hours, minutes) | ||||
# we're going to ignore minutes in this case | ||||
hours += 1 | ||||
days = hours // 24 | ||||
hours -= days * 24 | ||||
if days < 15: | ||||
# i18n: format X days and YY hours as "XdYYh" | ||||
return _("%dd%02dh") % (days, hours) | ||||
# we're going to ignore hours in this case | ||||
days += 1 | ||||
weeks = days // 7 | ||||
days -= weeks * 7 | ||||
if weeks < 55: | ||||
# i18n: format X weeks and YY days as "XwYYd" | ||||
return _("%dw%02dd") % (weeks, days) | ||||
# we're going to ignore days and treat a year as 52 weeks | ||||
weeks += 1 | ||||
years = weeks // 52 | ||||
weeks -= years * 52 | ||||
# i18n: format X years and YY weeks as "XyYYw" | ||||
return _("%dy%02dw") % (years, weeks) | ||||
|
r13132 | |||
|
r10434 | class progbar(object): | ||
def __init__(self, ui): | ||||
self.ui = ui | ||||
self.resetstate() | ||||
def resetstate(self): | ||||
self.topics = [] | ||||
|
r13130 | self.topicstates = {} | ||
|
r13131 | self.starttimes = {} | ||
self.startvals = {} | ||||
|
r10434 | self.printed = False | ||
self.lastprint = time.time() + float(self.ui.config( | ||||
'progress', 'delay', default=3)) | ||||
|
r14838 | self.lasttopic = None | ||
|
r10434 | self.indetcount = 0 | ||
self.refresh = float(self.ui.config( | ||||
'progress', 'refresh', default=0.1)) | ||||
|
r14838 | self.changedelay = max(3 * self.refresh, | ||
float(self.ui.config( | ||||
'progress', 'changedelay', default=1))) | ||||
|
r10434 | self.order = self.ui.configlist( | ||
'progress', 'format', | ||||
|
r13148 | default=['topic', 'bar', 'number', 'estimate']) | ||
|
r10434 | |||
|
r13131 | def show(self, now, topic, pos, item, unit, total): | ||
|
r11458 | if not shouldprint(self.ui): | ||
return | ||||
|
r10434 | termwidth = self.width() | ||
self.printed = True | ||||
head = '' | ||||
needprogress = False | ||||
tail = '' | ||||
for indicator in self.order: | ||||
add = '' | ||||
if indicator == 'topic': | ||||
add = topic | ||||
elif indicator == 'number': | ||||
if total: | ||||
add = ('% ' + str(len(str(total))) + | ||||
's/%s') % (pos, total) | ||||
else: | ||||
add = str(pos) | ||||
elif indicator.startswith('item') and item: | ||||
slice = 'end' | ||||
if '-' in indicator: | ||||
wid = int(indicator.split('-')[1]) | ||||
elif '+' in indicator: | ||||
slice = 'beginning' | ||||
wid = int(indicator.split('+')[1]) | ||||
else: | ||||
wid = 20 | ||||
if slice == 'end': | ||||
add = item[-wid:] | ||||
else: | ||||
add = item[:wid] | ||||
add += (wid - len(add)) * ' ' | ||||
elif indicator == 'bar': | ||||
add = '' | ||||
needprogress = True | ||||
elif indicator == 'unit' and unit: | ||||
add = unit | ||||
|
r13147 | elif indicator == 'estimate': | ||
add = self.estimate(topic, pos, total, now) | ||||
|
r14280 | elif indicator == 'speed': | ||
add = self.speed(topic, pos, unit, now) | ||||
|
r10434 | if not needprogress: | ||
head = spacejoin(head, add) | ||||
else: | ||||
|
r13146 | tail = spacejoin(tail, add) | ||
|
r10434 | if needprogress: | ||
used = 0 | ||||
if head: | ||||
used += len(head) + 1 | ||||
if tail: | ||||
used += len(tail) + 1 | ||||
progwidth = termwidth - used - 3 | ||||
|
r10891 | if total and pos <= total: | ||
|
r10434 | amt = pos * progwidth // total | ||
|
r10453 | bar = '=' * (amt - 1) | ||
if amt > 0: | ||||
bar += '>' | ||||
bar += ' ' * (progwidth - amt) | ||||
|
r10434 | else: | ||
progwidth -= 3 | ||||
self.indetcount += 1 | ||||
# mod the count by twice the width so we can make the | ||||
# cursor bounce between the right and left sides | ||||
amt = self.indetcount % (2 * progwidth) | ||||
amt -= progwidth | ||||
bar = (' ' * int(progwidth - abs(amt)) + '<=>' + | ||||
' ' * int(abs(amt))) | ||||
prog = ''.join(('[', bar , ']')) | ||||
out = spacejoin(head, prog, tail) | ||||
else: | ||||
out = spacejoin(head, tail) | ||||
|
r10788 | sys.stderr.write('\r' + out[:termwidth]) | ||
|
r14838 | self.lasttopic = topic | ||
|
r10788 | sys.stderr.flush() | ||
|
r10434 | |||
def clear(self): | ||||
|
r11458 | if not shouldprint(self.ui): | ||
return | ||||
|
r10788 | sys.stderr.write('\r%s\r' % (' ' * self.width())) | ||
|
r10434 | |||
|
r10439 | def complete(self): | ||
|
r11458 | if not shouldprint(self.ui): | ||
return | ||||
|
r10439 | if self.ui.configbool('progress', 'clear-complete', default=True): | ||
self.clear() | ||||
else: | ||||
|
r10788 | sys.stderr.write('\n') | ||
sys.stderr.flush() | ||||
|
r10439 | |||
|
r10434 | def width(self): | ||
|
r12689 | tw = self.ui.termwidth() | ||
|
r10434 | return min(int(self.ui.config('progress', 'width', default=tw)), tw) | ||
|
r13147 | def estimate(self, topic, pos, total, now): | ||
|
r13154 | if total is None: | ||
return '' | ||||
|
r13147 | initialpos = self.startvals[topic] | ||
target = total - initialpos | ||||
delta = pos - initialpos | ||||
if delta > 0: | ||||
elapsed = now - self.starttimes[topic] | ||||
if elapsed > float( | ||||
self.ui.config('progress', 'estimate', default=2)): | ||||
seconds = (elapsed * (target - delta)) // delta + 1 | ||||
return fmtremaining(seconds) | ||||
return '' | ||||
|
r14280 | def speed(self, topic, pos, unit, now): | ||
initialpos = self.startvals[topic] | ||||
delta = pos - initialpos | ||||
elapsed = now - self.starttimes[topic] | ||||
if elapsed > float( | ||||
self.ui.config('progress', 'estimate', default=2)): | ||||
return _('%d %s/sec') % (delta / elapsed, unit) | ||||
return '' | ||||
|
r11555 | def progress(self, topic, pos, item='', unit='', total=None): | ||
|
r13131 | now = time.time() | ||
|
r10439 | if pos is None: | ||
|
r13131 | self.starttimes.pop(topic, None) | ||
self.startvals.pop(topic, None) | ||||
|
r13130 | self.topicstates.pop(topic, None) | ||
# reset the progress bar if this is the outermost topic | ||||
if self.topics and self.topics[0] == topic and self.printed: | ||||
|
r10439 | self.complete() | ||
|
r10441 | self.resetstate() | ||
|
r13130 | # truncate the list of topics assuming all topics within | ||
# this one are also closed | ||||
if topic in self.topics: | ||||
|
r16676 | self.topics = self.topics[:self.topics.index(topic)] | ||
|
r10439 | else: | ||
if topic not in self.topics: | ||||
|
r13131 | self.starttimes[topic] = now | ||
self.startvals[topic] = pos | ||||
|
r10439 | self.topics.append(topic) | ||
|
r13130 | self.topicstates[topic] = pos, item, unit, total | ||
if now - self.lastprint >= self.refresh and self.topics: | ||||
|
r14838 | if (self.lasttopic is None # first time we printed | ||
# not a topic change | ||||
or topic == self.lasttopic | ||||
# it's been long enough we should print anyway | ||||
or now - self.lastprint >= self.changedelay): | ||||
self.lastprint = now | ||||
self.show(now, topic, *self.topicstates[topic]) | ||||
|
r10434 | |||
|
r14837 | _singleton = None | ||
|
r10434 | def uisetup(ui): | ||
|
r14837 | global _singleton | ||
|
r11555 | class progressui(ui.__class__): | ||
_progbar = None | ||||
|
r15662 | def _quiet(self): | ||
return self.debugflag or self.quiet | ||||
|
r11555 | def progress(self, *args, **opts): | ||
|
r15662 | if not self._quiet(): | ||
self._progbar.progress(*args, **opts) | ||||
|
r11555 | return super(progressui, self).progress(*args, **opts) | ||
def write(self, *args, **opts): | ||||
|
r15662 | if not self._quiet() and self._progbar.printed: | ||
|
r11555 | self._progbar.clear() | ||
return super(progressui, self).write(*args, **opts) | ||||
def write_err(self, *args, **opts): | ||||
|
r15662 | if not self._quiet() and self._progbar.printed: | ||
|
r11555 | self._progbar.clear() | ||
return super(progressui, self).write_err(*args, **opts) | ||||
|
r10540 | # Apps that derive a class from ui.ui() can use | ||
# setconfig('progress', 'disable', 'True') to disable this extension | ||||
if ui.configbool('progress', 'disable'): | ||||
return | ||||
|
r11458 | if shouldprint(ui) and not ui.debugflag and not ui.quiet: | ||
|
r11555 | ui.__class__ = progressui | ||
|
r10434 | # we instantiate one globally shared progress bar to avoid | ||
# competing progress bars when multiple UI objects get created | ||||
|
r11555 | if not progressui._progbar: | ||
|
r14837 | if _singleton is None: | ||
_singleton = progbar(ui) | ||||
progressui._progbar = _singleton | ||||
|
r10434 | |||
def reposetup(ui, repo): | ||||
uisetup(repo.ui) | ||||