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
152
self.MIN_PAUSE = 0.1 # seconds
155
self.start_time = now
156
# next update should not throttle
157
self.last_update = now - self.MIN_PAUSE - 1
160
"""Return this bar to its progress stack."""
162
assert self._stack is not None
163
self._stack.return_pb(self)
165
def note(self, fmt_string, *args, **kwargs):
166
"""Record a note without disrupting the progress bar."""
168
self.to_messages_file.write(fmt_string % args)
169
self.to_messages_file.write('\n')
171
def child_progress(self, **kwargs):
172
return ChildProgress(**kwargs)
175
class DummyProgress(_BaseProgressBar):
176
"""Progress-bar standin that does nothing.
178
This can be used as the default argument for methods that
179
take an optional progress indicator."""
183
def update(self, msg=None, current=None, total=None):
186
def child_update(self, message, current, total):
192
def note(self, fmt_string, *args, **kwargs):
193
"""See _BaseProgressBar.note()."""
195
def child_progress(self, **kwargs):
196
return DummyProgress(**kwargs)
198
class DotsProgressBar(_BaseProgressBar):
200
def __init__(self, **kwargs):
201
_BaseProgressBar.__init__(self, **kwargs)
208
def update(self, msg=None, current_cnt=None, total_cnt=None):
209
if msg and msg != self.last_msg:
211
self.to_file.write('\n')
213
self.to_file.write(msg + ': ')
216
self.to_file.write('.')
220
self.to_file.write('\n')
222
def child_update(self, message, current, total):
225
class TTYProgressBar(_BaseProgressBar):
226
"""Progress bar display object.
228
Several options are available to control the display. These can
229
be passed as parameters to the constructor or assigned at any time:
232
Show percentage complete.
234
Show rotating baton. This ticks over on every update even
235
if the values don't change.
237
Show predicted time-to-completion.
241
Show numerical counts.
243
The output file should be in line-buffered or unbuffered mode.
248
def __init__(self, **kwargs):
249
from bzrlib.osutils import terminal_width
250
_BaseProgressBar.__init__(self, **kwargs)
252
self.width = terminal_width()
253
self.start_time = None
254
self.last_updates = deque()
255
self.child_fraction = 0
259
"""Return True if the bar was updated too recently"""
260
# time.time consistently takes 40/4000 ms = 0.01 ms.
261
# but every single update to the pb invokes it.
262
# so we use time.clock which takes 20/4000 ms = 0.005ms
263
# on the downside, time.clock() appears to have approximately
264
# 10ms granularity, so we treat a zero-time change as 'throttled.'
267
interval = now - self.last_update
269
if interval < self.MIN_PAUSE:
272
self.last_updates.append(now - self.last_update)
273
self.last_update = now
278
self.update(self.last_msg, self.last_cnt, self.last_total,
281
def child_update(self, message, current, total):
282
if current is not None and total != 0:
283
child_fraction = float(current) / total
284
if self.last_cnt is None:
286
elif self.last_cnt + child_fraction <= self.last_total:
287
self.child_fraction = child_fraction
289
mutter('not updating child fraction')
290
if self.last_msg is None:
295
def update(self, msg, current_cnt=None, total_cnt=None,
297
"""Update and redraw progress bar."""
302
if current_cnt > total_cnt:
303
total_cnt = current_cnt
305
## # optional corner case optimisation
306
## # currently does not seem to fire so costs more than saved.
307
## # trivial optimal case:
308
## # NB if callers are doing a clear and restore with
309
## # the saved values, this will prevent that:
310
## # in that case add a restore method that calls
311
## # _do_update or some such
312
## if (self.last_msg == msg and
313
## self.last_cnt == current_cnt and
314
## self.last_total == total_cnt and
315
## self.child_fraction == child_fraction):
318
old_msg = self.last_msg
319
# save these for the tick() function
321
self.last_cnt = current_cnt
322
self.last_total = total_cnt
323
self.child_fraction = child_fraction
325
# each function call takes 20ms/4000 = 0.005 ms,
326
# but multiple that by 4000 calls -> starts to cost.
327
# so anything to make this function call faster
328
# will improve base 'diff' time by up to 0.1 seconds.
329
if old_msg == self.last_msg and self.throttle():
332
if self.show_eta and self.start_time and self.last_total:
333
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
334
self.last_total, last_updates = self.last_updates)
335
eta_str = " " + str_tdelta(eta)
339
if self.show_spinner:
340
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
344
# always update this; it's also used for the bar
347
if self.show_pct and self.last_total and self.last_cnt:
348
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
349
pct_str = ' (%5.1f%%)' % pct
353
if not self.show_count:
355
elif self.last_cnt is None:
357
elif self.last_total is None:
358
count_str = ' %i' % (self.last_cnt)
360
# make both fields the same size
361
t = '%i' % (self.last_total)
362
c = '%*i' % (len(t), self.last_cnt)
363
count_str = ' ' + c + '/' + t
366
# progress bar, if present, soaks up all remaining space
367
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
368
- len(eta_str) - len(count_str) - 3
371
# number of markers highlighted in bar
372
markers = int(round(float(cols) *
373
(self.last_cnt + self.child_fraction) / self.last_total))
374
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
376
# don't know total, so can't show completion.
377
# so just show an expanded spinning thingy
378
m = self.spin_pos % cols
379
ms = (' ' * m + '*').ljust(cols)
381
bar_str = '[' + ms + '] '
387
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
389
assert len(m) < self.width
390
self.to_file.write('\r' + m.ljust(self.width - 1))
391
#self.to_file.flush()
394
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
395
#self.to_file.flush()
398
class ChildProgress(_BaseProgressBar):
399
"""A progress indicator that pushes its data to the parent"""
400
def __init__(self, _stack, **kwargs):
401
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
402
self.parent = _stack.top()
405
self.child_fraction = 0
408
def update(self, msg, current_cnt=None, total_cnt=None):
409
self.current = current_cnt
410
self.total = total_cnt
412
self.child_fraction = 0
415
def child_update(self, message, current, total):
416
if current is None or total == 0:
417
self.child_fraction = 0
419
self.child_fraction = float(current) / total
423
if self.current is None:
426
count = self.current+self.child_fraction
427
if count > self.total:
429
mutter('clamping count of %d to %d' % (count, self.total))
431
self.parent.child_update(self.message, count, self.total)
436
def note(self, *args, **kwargs):
437
self.parent.note(*args, **kwargs)
440
def str_tdelta(delt):
443
delt = int(round(delt))
444
return '%d:%02d:%02d' % (delt/3600,
449
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
450
if start_time is None:
456
if current < enough_samples:
462
elapsed = time.clock() - start_time
464
if elapsed < 2.0: # not enough time to estimate
467
total_duration = float(elapsed) * float(total) / float(current)
469
assert total_duration >= elapsed
471
if last_updates and len(last_updates) >= n_recent:
472
while len(last_updates) > n_recent:
473
last_updates.popleft()
474
avg = sum(last_updates) / float(len(last_updates))
475
time_left = avg * (total - current)
477
old_time_left = total_duration - elapsed
479
# We could return the average, or some other value here
480
return (time_left + old_time_left) / 2
482
return total_duration - elapsed
485
class ProgressPhase(object):
486
"""Update progress object with the current phase"""
487
def __init__(self, message, total, pb):
488
object.__init__(self)
490
self.message = message
492
self.cur_phase = None
494
def next_phase(self):
495
if self.cur_phase is None:
499
assert self.cur_phase < self.total
500
self.pb.update(self.message, self.cur_phase, self.total)
505
result = doctest.testmod()
508
print "All tests passed"
510
print "No tests to run"
516
print 'dumb-terminal test:'
517
pb = DotsProgressBar()
519
pb.update('Leoparden', i, 99)
525
print 'smart-terminal test:'
526
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
528
pb.update('Elephanten', i, 99)
536
if __name__ == "__main__":
added
removed
bzrlib/progress.py
