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
"""Return a nested progress bar."""
100
if len(self._stack) == 0:
103
func = self.top().child_progress
104
new_bar = func(to_file=self._to_file,
105
show_pct=self._show_pct,
106
show_spinner=self._show_spinner,
107
show_eta=self._show_eta,
108
show_bar=self._show_bar,
109
show_count=self._show_count,
110
to_messages_file=self._to_messages_file,
112
self._stack.append(new_bar)
115
def return_pb(self, bar):
116
"""Return bar after its been used."""
117
if bar is not self._stack[-1]:
118
raise errors.MissingProgressBarFinish()
122
class _BaseProgressBar(object):
131
to_messages_file=sys.stdout,
133
object.__init__(self)
134
self.to_file = to_file
135
self.to_messages_file = to_messages_file
138
self.last_total = None
139
self.show_pct = show_pct
140
self.show_spinner = show_spinner
141
self.show_eta = show_eta
142
self.show_bar = show_bar
143
self.show_count = show_count
147
"""Return this bar to its progress stack."""
149
assert self._stack is not None
150
self._stack.return_pb(self)
152
def note(self, fmt_string, *args, **kwargs):
153
"""Record a note without disrupting the progress bar."""
155
self.to_messages_file.write(fmt_string % args)
156
self.to_messages_file.write('\n')
158
def child_progress(self, **kwargs):
159
return ChildProgress(**kwargs)
162
class DummyProgress(_BaseProgressBar):
163
"""Progress-bar standin that does nothing.
165
This can be used as the default argument for methods that
166
take an optional progress indicator."""
170
def update(self, msg=None, current=None, total=None):
173
def child_update(self, message, current, total):
179
def note(self, fmt_string, *args, **kwargs):
180
"""See _BaseProgressBar.note()."""
182
def child_progress(self, **kwargs):
183
return DummyProgress(**kwargs)
185
class DotsProgressBar(_BaseProgressBar):
187
def __init__(self, **kwargs):
188
_BaseProgressBar.__init__(self, **kwargs)
195
def update(self, msg=None, current_cnt=None, total_cnt=None):
196
if msg and msg != self.last_msg:
198
self.to_file.write('\n')
200
self.to_file.write(msg + ': ')
203
self.to_file.write('.')
207
self.to_file.write('\n')
209
def child_update(self, message, current, total):
212
class TTYProgressBar(_BaseProgressBar):
213
"""Progress bar display object.
215
Several options are available to control the display. These can
216
be passed as parameters to the constructor or assigned at any time:
219
Show percentage complete.
221
Show rotating baton. This ticks over on every update even
222
if the values don't change.
224
Show predicted time-to-completion.
228
Show numerical counts.
230
The output file should be in line-buffered or unbuffered mode.
233
MIN_PAUSE = 0.1 # seconds
236
def __init__(self, **kwargs):
237
from bzrlib.osutils import terminal_width
238
_BaseProgressBar.__init__(self, **kwargs)
240
self.width = terminal_width()
241
self.start_time = None
242
self.last_update = None
243
self.last_updates = deque()
244
self.child_fraction = 0
248
"""Return True if the bar was updated too recently"""
250
if self.start_time is None:
251
self.start_time = self.last_update = now
254
interval = now - self.last_update
255
if interval > 0 and interval < self.MIN_PAUSE:
258
self.last_updates.append(now - self.last_update)
259
self.last_update = now
264
self.update(self.last_msg, self.last_cnt, self.last_total,
267
def child_update(self, message, current, total):
268
if current is not None and total != 0:
269
child_fraction = float(current) / total
270
if self.last_cnt is None:
272
elif self.last_cnt + child_fraction <= self.last_total:
273
self.child_fraction = child_fraction
275
mutter('not updating child fraction')
276
if self.last_msg is None:
281
def update(self, msg, current_cnt=None, total_cnt=None,
283
"""Update and redraw progress bar."""
284
self.child_fraction = child_fraction
289
if current_cnt > total_cnt:
290
total_cnt = current_cnt
292
old_msg = self.last_msg
293
# save these for the tick() function
295
self.last_cnt = current_cnt
296
self.last_total = total_cnt
298
if old_msg == self.last_msg and self.throttle():
301
if self.show_eta and self.start_time and total_cnt:
302
eta = get_eta(self.start_time, current_cnt+child_fraction,
303
total_cnt, last_updates = self.last_updates)
304
eta_str = " " + str_tdelta(eta)
308
if self.show_spinner:
309
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
313
# always update this; it's also used for the bar
316
if self.show_pct and total_cnt and current_cnt:
317
pct = 100.0 * ((current_cnt + child_fraction) / total_cnt)
318
pct_str = ' (%5.1f%%)' % pct
322
if not self.show_count:
324
elif current_cnt is None:
326
elif total_cnt is None:
327
count_str = ' %i' % (current_cnt)
329
# make both fields the same size
330
t = '%i' % (total_cnt)
331
c = '%*i' % (len(t), current_cnt)
332
count_str = ' ' + c + '/' + t
335
# progress bar, if present, soaks up all remaining space
336
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
337
- len(eta_str) - len(count_str) - 3
340
# number of markers highlighted in bar
341
markers = int(round(float(cols) *
342
(current_cnt + child_fraction) / total_cnt))
343
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
345
# don't know total, so can't show completion.
346
# so just show an expanded spinning thingy
347
m = self.spin_pos % cols
348
ms = (' ' * m + '*').ljust(cols)
350
bar_str = '[' + ms + '] '
356
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
358
assert len(m) < self.width
359
self.to_file.write('\r' + m.ljust(self.width - 1))
360
#self.to_file.flush()
363
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
364
#self.to_file.flush()
367
class ChildProgress(_BaseProgressBar):
368
"""A progress indicator that pushes its data to the parent"""
369
def __init__(self, _stack, **kwargs):
370
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
371
self.parent = _stack.top()
374
self.child_fraction = 0
377
def update(self, msg, current_cnt=None, total_cnt=None):
378
self.current = current_cnt
379
self.total = total_cnt
381
self.child_fraction = 0
384
def child_update(self, message, current, total):
385
if current is None or total == 0:
386
self.child_fraction = 0
388
self.child_fraction = float(current) / total
392
if self.current is None:
395
count = self.current+self.child_fraction
396
if count > self.total:
397
mutter('clamping count of %d to %d' % (count, self.total))
399
self.parent.child_update(self.message, count, self.total)
405
def str_tdelta(delt):
408
delt = int(round(delt))
409
return '%d:%02d:%02d' % (delt/3600,
414
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
415
if start_time is None:
421
if current < enough_samples:
427
elapsed = time.time() - start_time
429
if elapsed < 2.0: # not enough time to estimate
432
total_duration = float(elapsed) * float(total) / float(current)
434
assert total_duration >= elapsed
436
if last_updates and len(last_updates) >= n_recent:
437
while len(last_updates) > n_recent:
438
last_updates.popleft()
439
avg = sum(last_updates) / float(len(last_updates))
440
time_left = avg * (total - current)
442
old_time_left = total_duration - elapsed
444
# We could return the average, or some other value here
445
return (time_left + old_time_left) / 2
447
return total_duration - elapsed
450
class ProgressPhase(object):
451
"""Update progress object with the current phase"""
452
def __init__(self, message, total, pb):
453
object.__init__(self)
455
self.message = message
457
self.cur_phase = None
459
def next_phase(self):
460
if self.cur_phase is None:
464
assert self.cur_phase < self.total
465
self.pb.update(self.message, self.cur_phase, self.total)
470
result = doctest.testmod()
473
print "All tests passed"
475
print "No tests to run"
481
print 'dumb-terminal test:'
482
pb = DotsProgressBar()
484
pb.update('Leoparden', i, 99)
490
print 'smart-terminal test:'
491
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
493
pb.update('Elephanten', i, 99)
501
if __name__ == "__main__":
added
removed
bzrlib/progress.py
