1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical Ltd
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 bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
49
from bzrlib.trace import mutter
52
def _supports_progress(f):
53
isatty = getattr(f, 'isatty', None)
58
if os.environ.get('TERM') == 'dumb':
59
# e.g. emacs compile window
64
_progress_bar_types = {}
67
def ProgressBar(to_file=None, **kwargs):
68
"""Abstract factory"""
71
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
72
# An value of '' or not set reverts to standard processing
73
if requested_bar_type in (None, ''):
74
if _supports_progress(to_file):
75
return TTYProgressBar(to_file=to_file, **kwargs)
77
return DotsProgressBar(to_file=to_file, **kwargs)
79
# Minor sanitation to prevent spurious errors
80
requested_bar_type = requested_bar_type.lower().strip()
81
# TODO: jam 20060710 Arguably we shouldn't raise an exception
82
# but should instead just disable progress bars if we
83
# don't recognize the type
84
if requested_bar_type not in _progress_bar_types:
85
raise errors.InvalidProgressBarType(requested_bar_type,
86
_progress_bar_types.keys())
87
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
90
class ProgressBarStack(object):
91
"""A stack of progress bars."""
100
to_messages_file=None,
102
"""Setup the stack with the parameters the progress bars should have."""
105
if to_messages_file is None:
106
to_messages_file = sys.stdout
107
self._to_file = to_file
108
self._show_pct = show_pct
109
self._show_spinner = show_spinner
110
self._show_eta = show_eta
111
self._show_bar = show_bar
112
self._show_count = show_count
113
self._to_messages_file = to_messages_file
115
self._klass = klass or ProgressBar
118
if len(self._stack) != 0:
119
return self._stack[-1]
124
if len(self._stack) != 0:
125
return self._stack[0]
129
def get_nested(self):
130
"""Return a nested progress bar."""
131
if len(self._stack) == 0:
134
func = self.top().child_progress
135
new_bar = func(to_file=self._to_file,
136
show_pct=self._show_pct,
137
show_spinner=self._show_spinner,
138
show_eta=self._show_eta,
139
show_bar=self._show_bar,
140
show_count=self._show_count,
141
to_messages_file=self._to_messages_file,
143
self._stack.append(new_bar)
146
def return_pb(self, bar):
147
"""Return bar after its been used."""
148
if bar is not self._stack[-1]:
149
raise errors.MissingProgressBarFinish()
153
class _BaseProgressBar(object):
162
to_messages_file=None,
164
object.__init__(self)
167
if to_messages_file is None:
168
to_messages_file = sys.stdout
169
self.to_file = to_file
170
self.to_messages_file = to_messages_file
173
self.last_total = None
174
self.show_pct = show_pct
175
self.show_spinner = show_spinner
176
self.show_eta = show_eta
177
self.show_bar = show_bar
178
self.show_count = show_count
181
self.MIN_PAUSE = 0.1 # seconds
184
self.start_time = now
185
# next update should not throttle
186
self.last_update = now - self.MIN_PAUSE - 1
189
"""Return this bar to its progress stack."""
191
assert self._stack is not None
192
self._stack.return_pb(self)
194
def note(self, fmt_string, *args, **kwargs):
195
"""Record a note without disrupting the progress bar."""
197
self.to_messages_file.write(fmt_string % args)
198
self.to_messages_file.write('\n')
200
def child_progress(self, **kwargs):
201
return ChildProgress(**kwargs)
204
class DummyProgress(_BaseProgressBar):
205
"""Progress-bar standin that does nothing.
207
This can be used as the default argument for methods that
208
take an optional progress indicator."""
212
def update(self, msg=None, current=None, total=None):
215
def child_update(self, message, current, total):
221
def note(self, fmt_string, *args, **kwargs):
222
"""See _BaseProgressBar.note()."""
224
def child_progress(self, **kwargs):
225
return DummyProgress(**kwargs)
228
_progress_bar_types['dummy'] = DummyProgress
229
_progress_bar_types['none'] = DummyProgress
232
class DotsProgressBar(_BaseProgressBar):
234
def __init__(self, **kwargs):
235
_BaseProgressBar.__init__(self, **kwargs)
242
def update(self, msg=None, current_cnt=None, total_cnt=None):
243
if msg and msg != self.last_msg:
245
self.to_file.write('\n')
246
self.to_file.write(msg + ': ')
249
self.to_file.write('.')
253
self.to_file.write('\n')
256
def child_update(self, message, current, total):
260
_progress_bar_types['dots'] = DotsProgressBar
263
class TTYProgressBar(_BaseProgressBar):
264
"""Progress bar display object.
266
Several options are available to control the display. These can
267
be passed as parameters to the constructor or assigned at any time:
270
Show percentage complete.
272
Show rotating baton. This ticks over on every update even
273
if the values don't change.
275
Show predicted time-to-completion.
279
Show numerical counts.
281
The output file should be in line-buffered or unbuffered mode.
286
def __init__(self, **kwargs):
287
from bzrlib.osutils import terminal_width
288
_BaseProgressBar.__init__(self, **kwargs)
290
self.width = terminal_width()
291
self.last_updates = []
292
self._max_last_updates = 10
293
self.child_fraction = 0
294
self._have_output = False
297
def throttle(self, old_msg):
298
"""Return True if the bar was updated too recently"""
299
# time.time consistently takes 40/4000 ms = 0.01 ms.
300
# but every single update to the pb invokes it.
301
# so we use time.clock which takes 20/4000 ms = 0.005ms
302
# on the downside, time.clock() appears to have approximately
303
# 10ms granularity, so we treat a zero-time change as 'throttled.'
305
if self.start_time is not None and (now - self.start_time) < 1:
307
if old_msg != self.last_msg:
309
interval = now - self.last_update
311
if interval < self.MIN_PAUSE:
314
self.last_updates.append(now - self.last_update)
315
# Don't let the queue grow without bound
316
self.last_updates = self.last_updates[-self._max_last_updates:]
317
self.last_update = now
321
self.update(self.last_msg, self.last_cnt, self.last_total,
324
def child_update(self, message, current, total):
325
if current is not None and total != 0:
326
child_fraction = float(current) / total
327
if self.last_cnt is None:
329
elif self.last_cnt + child_fraction <= self.last_total:
330
self.child_fraction = child_fraction
332
mutter('not updating child fraction')
333
if self.last_msg is None:
337
def update(self, msg, current_cnt=None, total_cnt=None,
339
"""Update and redraw progress bar."""
343
if total_cnt is None:
344
total_cnt = self.last_total
349
if current_cnt > total_cnt:
350
total_cnt = current_cnt
352
## # optional corner case optimisation
353
## # currently does not seem to fire so costs more than saved.
354
## # trivial optimal case:
355
## # NB if callers are doing a clear and restore with
356
## # the saved values, this will prevent that:
357
## # in that case add a restore method that calls
358
## # _do_update or some such
359
## if (self.last_msg == msg and
360
## self.last_cnt == current_cnt and
361
## self.last_total == total_cnt and
362
## self.child_fraction == child_fraction):
365
old_msg = self.last_msg
366
# save these for the tick() function
368
self.last_cnt = current_cnt
369
self.last_total = total_cnt
370
self.child_fraction = child_fraction
372
# each function call takes 20ms/4000 = 0.005 ms,
373
# but multiple that by 4000 calls -> starts to cost.
374
# so anything to make this function call faster
375
# will improve base 'diff' time by up to 0.1 seconds.
376
if self.throttle(old_msg):
379
if self.show_eta and self.start_time and self.last_total:
380
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
381
self.last_total, last_updates = self.last_updates)
382
eta_str = " " + str_tdelta(eta)
386
if self.show_spinner:
387
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
391
# always update this; it's also used for the bar
394
if self.show_pct and self.last_total and self.last_cnt:
395
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
396
pct_str = ' (%5.1f%%)' % pct
400
if not self.show_count:
402
elif self.last_cnt is None:
404
elif self.last_total is None:
405
count_str = ' %i' % (self.last_cnt)
407
# make both fields the same size
408
t = '%i' % (self.last_total)
409
c = '%*i' % (len(t), self.last_cnt)
410
count_str = ' ' + c + '/' + t
413
# progress bar, if present, soaks up all remaining space
414
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
415
- len(eta_str) - len(count_str) - 3
418
# number of markers highlighted in bar
419
markers = int(round(float(cols) *
420
(self.last_cnt + self.child_fraction) / self.last_total))
421
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
423
# don't know total, so can't show completion.
424
# so just show an expanded spinning thingy
425
m = self.spin_pos % cols
426
ms = (' ' * m + '*').ljust(cols)
428
bar_str = '[' + ms + '] '
434
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
435
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
436
self._have_output = True
437
#self.to_file.flush()
440
if self._have_output:
441
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
442
self._have_output = False
443
#self.to_file.flush()
446
_progress_bar_types['tty'] = TTYProgressBar
449
class ChildProgress(_BaseProgressBar):
450
"""A progress indicator that pushes its data to the parent"""
452
def __init__(self, _stack, **kwargs):
453
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
454
self.parent = _stack.top()
457
self.child_fraction = 0
460
def update(self, msg, current_cnt=None, total_cnt=None):
461
self.current = current_cnt
462
self.total = total_cnt
464
self.child_fraction = 0
467
def child_update(self, message, current, total):
468
if current is None or total == 0:
469
self.child_fraction = 0
471
self.child_fraction = float(current) / total
475
if self.current is None:
478
count = self.current+self.child_fraction
479
if count > self.total:
481
mutter('clamping count of %d to %d' % (count, self.total))
483
self.parent.child_update(self.message, count, self.total)
488
def note(self, *args, **kwargs):
489
self.parent.note(*args, **kwargs)
492
def str_tdelta(delt):
495
delt = int(round(delt))
496
return '%d:%02d:%02d' % (delt/3600,
501
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
502
if start_time is None:
508
if current < enough_samples:
514
elapsed = time.clock() - start_time
516
if elapsed < 2.0: # not enough time to estimate
519
total_duration = float(elapsed) * float(total) / float(current)
521
assert total_duration >= elapsed
523
if last_updates and len(last_updates) >= n_recent:
524
avg = sum(last_updates) / float(len(last_updates))
525
time_left = avg * (total - current)
527
old_time_left = total_duration - elapsed
529
# We could return the average, or some other value here
530
return (time_left + old_time_left) / 2
532
return total_duration - elapsed
535
class ProgressPhase(object):
536
"""Update progress object with the current phase"""
537
def __init__(self, message, total, pb):
538
object.__init__(self)
540
self.message = message
542
self.cur_phase = None
544
def next_phase(self):
545
if self.cur_phase is None:
549
assert self.cur_phase < self.total
550
self.pb.update(self.message, self.cur_phase, self.total)
555
result = doctest.testmod()
558
print "All tests passed"
560
print "No tests to run"
566
print 'dumb-terminal test:'
567
pb = DotsProgressBar()
569
pb.update('Leoparden', i, 99)
575
print 'smart-terminal test:'
576
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
578
pb.update('Elephanten', i, 99)
586
if __name__ == "__main__":
added
removed
bzrlib/progress.py
