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=None, **kwargs):
62
"""Abstract factory"""
65
if _supports_progress(to_file):
66
return TTYProgressBar(to_file=to_file, **kwargs)
68
return DotsProgressBar(to_file=to_file, **kwargs)
71
class ProgressBarStack(object):
72
"""A stack of progress bars."""
81
to_messages_file=None,
83
"""Setup the stack with the parameters the progress bars should have."""
86
if to_messages_file is None:
87
to_messages_file = sys.stdout
88
self._to_file = to_file
89
self._show_pct = show_pct
90
self._show_spinner = show_spinner
91
self._show_eta = show_eta
92
self._show_bar = show_bar
93
self._show_count = show_count
94
self._to_messages_file = to_messages_file
96
self._klass = klass or TTYProgressBar
99
if len(self._stack) != 0:
100
return self._stack[-1]
105
if len(self._stack) != 0:
106
return self._stack[0]
110
def get_nested(self):
111
"""Return a nested progress bar."""
112
if len(self._stack) == 0:
115
func = self.top().child_progress
116
new_bar = func(to_file=self._to_file,
117
show_pct=self._show_pct,
118
show_spinner=self._show_spinner,
119
show_eta=self._show_eta,
120
show_bar=self._show_bar,
121
show_count=self._show_count,
122
to_messages_file=self._to_messages_file,
124
self._stack.append(new_bar)
127
def return_pb(self, bar):
128
"""Return bar after its been used."""
129
if bar is not self._stack[-1]:
130
raise errors.MissingProgressBarFinish()
134
class _BaseProgressBar(object):
143
to_messages_file=None,
145
object.__init__(self)
148
if to_messages_file is None:
149
to_messages_file = sys.stdout
150
self.to_file = to_file
151
self.to_messages_file = to_messages_file
154
self.last_total = None
155
self.show_pct = show_pct
156
self.show_spinner = show_spinner
157
self.show_eta = show_eta
158
self.show_bar = show_bar
159
self.show_count = show_count
162
self.MIN_PAUSE = 0.1 # seconds
165
self.start_time = now
166
# next update should not throttle
167
self.last_update = now - self.MIN_PAUSE - 1
170
"""Return this bar to its progress stack."""
172
assert self._stack is not None
173
self._stack.return_pb(self)
175
def note(self, fmt_string, *args, **kwargs):
176
"""Record a note without disrupting the progress bar."""
178
self.to_messages_file.write(fmt_string % args)
179
self.to_messages_file.write('\n')
181
def child_progress(self, **kwargs):
182
return ChildProgress(**kwargs)
185
class DummyProgress(_BaseProgressBar):
186
"""Progress-bar standin that does nothing.
188
This can be used as the default argument for methods that
189
take an optional progress indicator."""
193
def update(self, msg=None, current=None, total=None):
196
def child_update(self, message, current, total):
202
def note(self, fmt_string, *args, **kwargs):
203
"""See _BaseProgressBar.note()."""
205
def child_progress(self, **kwargs):
206
return DummyProgress(**kwargs)
209
class DotsProgressBar(_BaseProgressBar):
211
def __init__(self, **kwargs):
212
_BaseProgressBar.__init__(self, **kwargs)
219
def update(self, msg=None, current_cnt=None, total_cnt=None):
220
if msg and msg != self.last_msg:
222
self.to_file.write('\n')
223
self.to_file.write(msg + ': ')
226
self.to_file.write('.')
230
self.to_file.write('\n')
233
def child_update(self, message, current, total):
237
class TTYProgressBar(_BaseProgressBar):
238
"""Progress bar display object.
240
Several options are available to control the display. These can
241
be passed as parameters to the constructor or assigned at any time:
244
Show percentage complete.
246
Show rotating baton. This ticks over on every update even
247
if the values don't change.
249
Show predicted time-to-completion.
253
Show numerical counts.
255
The output file should be in line-buffered or unbuffered mode.
260
def __init__(self, **kwargs):
261
from bzrlib.osutils import terminal_width
262
_BaseProgressBar.__init__(self, **kwargs)
264
self.width = terminal_width()
265
self.last_updates = deque()
266
self.child_fraction = 0
269
def throttle(self, old_msg):
270
"""Return True if the bar was updated too recently"""
271
# time.time consistently takes 40/4000 ms = 0.01 ms.
272
# but every single update to the pb invokes it.
273
# so we use time.clock which takes 20/4000 ms = 0.005ms
274
# on the downside, time.clock() appears to have approximately
275
# 10ms granularity, so we treat a zero-time change as 'throttled.'
277
if self.start_time is not None and (now - self.start_time) < 1:
279
if old_msg != self.last_msg:
281
interval = now - self.last_update
283
if interval < self.MIN_PAUSE:
286
self.last_updates.append(now - self.last_update)
287
self.last_update = now
291
self.update(self.last_msg, self.last_cnt, self.last_total,
294
def child_update(self, message, current, total):
295
if current is not None and total != 0:
296
child_fraction = float(current) / total
297
if self.last_cnt is None:
299
elif self.last_cnt + child_fraction <= self.last_total:
300
self.child_fraction = child_fraction
302
mutter('not updating child fraction')
303
if self.last_msg is None:
307
def update(self, msg, current_cnt=None, total_cnt=None,
309
"""Update and redraw progress bar."""
313
if total_cnt is None:
314
total_cnt = self.last_total
319
if current_cnt > total_cnt:
320
total_cnt = current_cnt
322
## # optional corner case optimisation
323
## # currently does not seem to fire so costs more than saved.
324
## # trivial optimal case:
325
## # NB if callers are doing a clear and restore with
326
## # the saved values, this will prevent that:
327
## # in that case add a restore method that calls
328
## # _do_update or some such
329
## if (self.last_msg == msg and
330
## self.last_cnt == current_cnt and
331
## self.last_total == total_cnt and
332
## self.child_fraction == child_fraction):
335
old_msg = self.last_msg
336
# save these for the tick() function
338
self.last_cnt = current_cnt
339
self.last_total = total_cnt
340
self.child_fraction = child_fraction
342
# each function call takes 20ms/4000 = 0.005 ms,
343
# but multiple that by 4000 calls -> starts to cost.
344
# so anything to make this function call faster
345
# will improve base 'diff' time by up to 0.1 seconds.
346
if self.throttle(old_msg):
349
if self.show_eta and self.start_time and self.last_total:
350
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
351
self.last_total, last_updates = self.last_updates)
352
eta_str = " " + str_tdelta(eta)
356
if self.show_spinner:
357
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
361
# always update this; it's also used for the bar
364
if self.show_pct and self.last_total and self.last_cnt:
365
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
366
pct_str = ' (%5.1f%%)' % pct
370
if not self.show_count:
372
elif self.last_cnt is None:
374
elif self.last_total is None:
375
count_str = ' %i' % (self.last_cnt)
377
# make both fields the same size
378
t = '%i' % (self.last_total)
379
c = '%*i' % (len(t), self.last_cnt)
380
count_str = ' ' + c + '/' + t
383
# progress bar, if present, soaks up all remaining space
384
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
385
- len(eta_str) - len(count_str) - 3
388
# number of markers highlighted in bar
389
markers = int(round(float(cols) *
390
(self.last_cnt + self.child_fraction) / self.last_total))
391
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
393
# don't know total, so can't show completion.
394
# so just show an expanded spinning thingy
395
m = self.spin_pos % cols
396
ms = (' ' * m + '*').ljust(cols)
398
bar_str = '[' + ms + '] '
404
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
406
assert len(m) < self.width
407
self.to_file.write('\r' + m.ljust(self.width - 1))
408
#self.to_file.flush()
411
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
412
#self.to_file.flush()
415
class ChildProgress(_BaseProgressBar):
416
"""A progress indicator that pushes its data to the parent"""
418
def __init__(self, _stack, **kwargs):
419
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
420
self.parent = _stack.top()
423
self.child_fraction = 0
426
def update(self, msg, current_cnt=None, total_cnt=None):
427
self.current = current_cnt
428
self.total = total_cnt
430
self.child_fraction = 0
433
def child_update(self, message, current, total):
434
if current is None or total == 0:
435
self.child_fraction = 0
437
self.child_fraction = float(current) / total
441
if self.current is None:
444
count = self.current+self.child_fraction
445
if count > self.total:
447
mutter('clamping count of %d to %d' % (count, self.total))
449
self.parent.child_update(self.message, count, self.total)
454
def note(self, *args, **kwargs):
455
self.parent.note(*args, **kwargs)
458
def str_tdelta(delt):
461
delt = int(round(delt))
462
return '%d:%02d:%02d' % (delt/3600,
467
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
468
if start_time is None:
474
if current < enough_samples:
480
elapsed = time.clock() - start_time
482
if elapsed < 2.0: # not enough time to estimate
485
total_duration = float(elapsed) * float(total) / float(current)
487
assert total_duration >= elapsed
489
if last_updates and len(last_updates) >= n_recent:
490
while len(last_updates) > n_recent:
491
last_updates.popleft()
492
avg = sum(last_updates) / float(len(last_updates))
493
time_left = avg * (total - current)
495
old_time_left = total_duration - elapsed
497
# We could return the average, or some other value here
498
return (time_left + old_time_left) / 2
500
return total_duration - elapsed
503
class ProgressPhase(object):
504
"""Update progress object with the current phase"""
505
def __init__(self, message, total, pb):
506
object.__init__(self)
508
self.message = message
510
self.cur_phase = None
512
def next_phase(self):
513
if self.cur_phase is None:
517
assert self.cur_phase < self.total
518
self.pb.update(self.message, self.cur_phase, self.total)
523
result = doctest.testmod()
526
print "All tests passed"
528
print "No tests to run"
534
print 'dumb-terminal test:'
535
pb = DotsProgressBar()
537
pb.update('Leoparden', i, 99)
543
print 'smart-terminal test:'
544
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
546
pb.update('Elephanten', i, 99)
554
if __name__ == "__main__":
added
removed
bzrlib/progress.py
