1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical <canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Simple text-mode progress indicator.
21
To display an indicator, create a ProgressBar object. Call it,
22
passing Progress objects indicating the current state. When done,
25
Progress is suppressed when output is not sent to a terminal, so as
26
not to clutter log files.
29
# TODO: should be a global option e.g. --silent that disables progress
30
# indicators, preferably without needing to adjust all code that
31
# potentially calls them.
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
# when the rate is unpredictable
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
49
def _supports_progress(f):
50
if not hasattr(f, 'isatty'):
54
if os.environ.get('TERM') == 'dumb':
55
# e.g. emacs compile window
61
def ProgressBar(to_file=sys.stderr, **kwargs):
62
"""Abstract factory"""
63
if _supports_progress(to_file):
64
return TTYProgressBar(to_file=to_file, **kwargs)
66
return DotsProgressBar(to_file=to_file, **kwargs)
69
class ProgressBarStack(object):
70
"""A stack of progress bars."""
79
to_messages_file=sys.stdout,
81
"""Setup the stack with the parameters the progress bars should have."""
82
self._to_file = to_file
83
self._show_pct = show_pct
84
self._show_spinner = show_spinner
85
self._show_eta = show_eta
86
self._show_bar = show_bar
87
self._show_count = show_count
88
self._to_messages_file = to_messages_file
90
self._klass = klass or TTYProgressBar
93
if len(self._stack) != 0:
94
return self._stack[-1]
99
if len(self._stack) != 0:
100
return self._stack[0]
104
def get_nested(self):
105
"""Return a nested progress bar."""
106
if len(self._stack) == 0:
109
func = self.top().child_progress
110
new_bar = func(to_file=self._to_file,
111
show_pct=self._show_pct,
112
show_spinner=self._show_spinner,
113
show_eta=self._show_eta,
114
show_bar=self._show_bar,
115
show_count=self._show_count,
116
to_messages_file=self._to_messages_file,
118
self._stack.append(new_bar)
121
def return_pb(self, bar):
122
"""Return bar after its been used."""
123
if bar is not self._stack[-1]:
124
raise errors.MissingProgressBarFinish()
128
class _BaseProgressBar(object):
137
to_messages_file=sys.stdout,
139
object.__init__(self)
140
self.to_file = to_file
141
self.to_messages_file = to_messages_file
144
self.last_total = None
145
self.show_pct = show_pct
146
self.show_spinner = show_spinner
147
self.show_eta = show_eta
148
self.show_bar = show_bar
149
self.show_count = show_count
153
"""Return this bar to its progress stack."""
155
assert self._stack is not None
156
self._stack.return_pb(self)
158
def note(self, fmt_string, *args, **kwargs):
159
"""Record a note without disrupting the progress bar."""
161
self.to_messages_file.write(fmt_string % args)
162
self.to_messages_file.write('\n')
164
def child_progress(self, **kwargs):
165
return ChildProgress(**kwargs)
168
class DummyProgress(_BaseProgressBar):
169
"""Progress-bar standin that does nothing.
171
This can be used as the default argument for methods that
172
take an optional progress indicator."""
176
def update(self, msg=None, current=None, total=None):
179
def child_update(self, message, current, total):
185
def note(self, fmt_string, *args, **kwargs):
186
"""See _BaseProgressBar.note()."""
188
def child_progress(self, **kwargs):
189
return DummyProgress(**kwargs)
191
class DotsProgressBar(_BaseProgressBar):
193
def __init__(self, **kwargs):
194
_BaseProgressBar.__init__(self, **kwargs)
201
def update(self, msg=None, current_cnt=None, total_cnt=None):
202
if msg and msg != self.last_msg:
204
self.to_file.write('\n')
206
self.to_file.write(msg + ': ')
209
self.to_file.write('.')
213
self.to_file.write('\n')
215
def child_update(self, message, current, total):
218
class TTYProgressBar(_BaseProgressBar):
219
"""Progress bar display object.
221
Several options are available to control the display. These can
222
be passed as parameters to the constructor or assigned at any time:
225
Show percentage complete.
227
Show rotating baton. This ticks over on every update even
228
if the values don't change.
230
Show predicted time-to-completion.
234
Show numerical counts.
236
The output file should be in line-buffered or unbuffered mode.
239
MIN_PAUSE = 0.1 # seconds
242
def __init__(self, **kwargs):
243
from bzrlib.osutils import terminal_width
244
_BaseProgressBar.__init__(self, **kwargs)
246
self.width = terminal_width()
247
self.start_time = None
248
self.last_update = None
249
self.last_updates = deque()
250
self.child_fraction = 0
254
"""Return True if the bar was updated too recently"""
256
if self.start_time is None:
257
self.start_time = self.last_update = now
260
interval = now - self.last_update
261
if interval > 0 and interval < self.MIN_PAUSE:
264
self.last_updates.append(now - self.last_update)
265
self.last_update = now
270
self.update(self.last_msg, self.last_cnt, self.last_total,
273
def child_update(self, message, current, total):
274
if current is not None and total != 0:
275
child_fraction = float(current) / total
276
if self.last_cnt is None:
278
elif self.last_cnt + child_fraction <= self.last_total:
279
self.child_fraction = child_fraction
281
mutter('not updating child fraction')
282
if self.last_msg is None:
287
def update(self, msg, current_cnt=None, total_cnt=None,
289
"""Update and redraw progress bar."""
290
self.child_fraction = child_fraction
295
if current_cnt > total_cnt:
296
total_cnt = current_cnt
298
old_msg = self.last_msg
299
# save these for the tick() function
301
self.last_cnt = current_cnt
302
self.last_total = total_cnt
304
if old_msg == self.last_msg and self.throttle():
307
if self.show_eta and self.start_time and total_cnt:
308
eta = get_eta(self.start_time, current_cnt+child_fraction,
309
total_cnt, last_updates = self.last_updates)
310
eta_str = " " + str_tdelta(eta)
314
if self.show_spinner:
315
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
319
# always update this; it's also used for the bar
322
if self.show_pct and total_cnt and current_cnt:
323
pct = 100.0 * ((current_cnt + child_fraction) / total_cnt)
324
pct_str = ' (%5.1f%%)' % pct
328
if not self.show_count:
330
elif current_cnt is None:
332
elif total_cnt is None:
333
count_str = ' %i' % (current_cnt)
335
# make both fields the same size
336
t = '%i' % (total_cnt)
337
c = '%*i' % (len(t), current_cnt)
338
count_str = ' ' + c + '/' + t
341
# progress bar, if present, soaks up all remaining space
342
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
343
- len(eta_str) - len(count_str) - 3
346
# number of markers highlighted in bar
347
markers = int(round(float(cols) *
348
(current_cnt + child_fraction) / total_cnt))
349
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
351
# don't know total, so can't show completion.
352
# so just show an expanded spinning thingy
353
m = self.spin_pos % cols
354
ms = (' ' * m + '*').ljust(cols)
356
bar_str = '[' + ms + '] '
362
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
364
assert len(m) < self.width
365
self.to_file.write('\r' + m.ljust(self.width - 1))
366
#self.to_file.flush()
369
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
370
#self.to_file.flush()
373
class ChildProgress(_BaseProgressBar):
374
"""A progress indicator that pushes its data to the parent"""
375
def __init__(self, _stack, **kwargs):
376
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
377
self.parent = _stack.top()
380
self.child_fraction = 0
383
def update(self, msg, current_cnt=None, total_cnt=None):
384
self.current = current_cnt
385
self.total = total_cnt
387
self.child_fraction = 0
390
def child_update(self, message, current, total):
391
if current is None or total == 0:
392
self.child_fraction = 0
394
self.child_fraction = float(current) / total
398
if self.current is None:
401
count = self.current+self.child_fraction
402
if count > self.total:
403
mutter('clamping count of %d to %d' % (count, self.total))
405
self.parent.child_update(self.message, count, self.total)
411
def str_tdelta(delt):
414
delt = int(round(delt))
415
return '%d:%02d:%02d' % (delt/3600,
420
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
421
if start_time is None:
427
if current < enough_samples:
433
elapsed = time.time() - start_time
435
if elapsed < 2.0: # not enough time to estimate
438
total_duration = float(elapsed) * float(total) / float(current)
440
assert total_duration >= elapsed
442
if last_updates and len(last_updates) >= n_recent:
443
while len(last_updates) > n_recent:
444
last_updates.popleft()
445
avg = sum(last_updates) / float(len(last_updates))
446
time_left = avg * (total - current)
448
old_time_left = total_duration - elapsed
450
# We could return the average, or some other value here
451
return (time_left + old_time_left) / 2
453
return total_duration - elapsed
456
class ProgressPhase(object):
457
"""Update progress object with the current phase"""
458
def __init__(self, message, total, pb):
459
object.__init__(self)
461
self.message = message
463
self.cur_phase = None
465
def next_phase(self):
466
if self.cur_phase is None:
470
assert self.cur_phase < self.total
471
self.pb.update(self.message, self.cur_phase, self.total)
476
result = doctest.testmod()
479
print "All tests passed"
481
print "No tests to run"
487
print 'dumb-terminal test:'
488
pb = DotsProgressBar()
490
pb.update('Leoparden', i, 99)
496
print 'smart-terminal test:'
497
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
499
pb.update('Elephanten', i, 99)
507
if __name__ == "__main__":
added
removed
bzrlib/progress.py
