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
48
def _supports_progress(f):
49
if not hasattr(f, 'isatty'):
53
if os.environ.get('TERM') == 'dumb':
54
# e.g. emacs compile window
60
def ProgressBar(to_file=sys.stderr, **kwargs):
61
"""Abstract factory"""
62
if _supports_progress(to_file):
63
return TTYProgressBar(to_file=to_file, **kwargs)
65
return DotsProgressBar(to_file=to_file, **kwargs)
68
class ProgressBarStack(object):
69
"""A stack of progress bars."""
78
to_messages_file=sys.stdout):
79
"""Setup the stack with the parameters the progress bars should have."""
80
self._to_file = to_file
81
self._show_pct = show_pct
82
self._show_spinner = show_spinner
83
self._show_eta = show_eta
84
self._show_bar = show_bar
85
self._show_count = show_count
86
self._to_messages_file = to_messages_file
90
"""Return a nested progress bar."""
91
# initial implementation - return a new bar each time.
92
new_bar = TTYProgressBar(to_file=self._to_file,
93
show_pct=self._show_pct,
94
show_spinner=self._show_spinner,
95
show_eta=self._show_eta,
96
show_bar=self._show_bar,
97
show_count=self._show_count,
98
to_messages_file=self._to_messages_file,
100
self._stack.append(new_bar)
103
def return_pb(self, bar):
104
"""Return bar after its been used."""
105
if bar != self._stack[-1]:
106
raise errors.MissingProgressBarFinish()
110
class _BaseProgressBar(object):
119
to_messages_file=sys.stdout,
121
object.__init__(self)
122
self.to_file = to_file
123
self.to_messages_file = to_messages_file
126
self.last_total = None
127
self.show_pct = show_pct
128
self.show_spinner = show_spinner
129
self.show_eta = show_eta
130
self.show_bar = show_bar
131
self.show_count = show_count
135
"""Return this bar to its progress stack."""
138
self._stack.return_pb(self)
140
def note(self, fmt_string, *args, **kwargs):
141
"""Record a note without disrupting the progress bar."""
143
self.to_messages_file.write(fmt_string % args)
144
self.to_messages_file.write('\n')
147
class DummyProgress(_BaseProgressBar):
148
"""Progress-bar standin that does nothing.
150
This can be used as the default argument for methods that
151
take an optional progress indicator."""
155
def update(self, msg=None, current=None, total=None):
161
def note(self, fmt_string, *args, **kwargs):
162
"""See _BaseProgressBar.note()."""
165
class DotsProgressBar(_BaseProgressBar):
166
def __init__(self, **kwargs):
167
_BaseProgressBar.__init__(self, **kwargs)
174
def update(self, msg=None, current_cnt=None, total_cnt=None):
175
if msg and msg != self.last_msg:
177
self.to_file.write('\n')
179
self.to_file.write(msg + ': ')
182
self.to_file.write('.')
186
self.to_file.write('\n')
189
class TTYProgressBar(_BaseProgressBar):
190
"""Progress bar display object.
192
Several options are available to control the display. These can
193
be passed as parameters to the constructor or assigned at any time:
196
Show percentage complete.
198
Show rotating baton. This ticks over on every update even
199
if the values don't change.
201
Show predicted time-to-completion.
205
Show numerical counts.
207
The output file should be in line-buffered or unbuffered mode.
210
MIN_PAUSE = 0.1 # seconds
213
def __init__(self, **kwargs):
214
from bzrlib.osutils import terminal_width
215
_BaseProgressBar.__init__(self, **kwargs)
217
self.width = terminal_width()
218
self.start_time = None
219
self.last_update = None
220
self.last_updates = deque()
224
"""Return True if the bar was updated too recently"""
226
if self.start_time is None:
227
self.start_time = self.last_update = now
230
interval = now - self.last_update
231
if interval > 0 and interval < self.MIN_PAUSE:
234
self.last_updates.append(now - self.last_update)
235
self.last_update = now
240
self.update(self.last_msg, self.last_cnt, self.last_total)
244
def update(self, msg, current_cnt=None, total_cnt=None):
245
"""Update and redraw progress bar."""
250
if current_cnt > total_cnt:
251
total_cnt = current_cnt
253
old_msg = self.last_msg
254
# save these for the tick() function
256
self.last_cnt = current_cnt
257
self.last_total = total_cnt
259
if old_msg == self.last_msg and self.throttle():
262
if self.show_eta and self.start_time and total_cnt:
263
eta = get_eta(self.start_time, current_cnt, total_cnt,
264
last_updates = self.last_updates)
265
eta_str = " " + str_tdelta(eta)
269
if self.show_spinner:
270
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
274
# always update this; it's also used for the bar
277
if self.show_pct and total_cnt and current_cnt:
278
pct = 100.0 * current_cnt / total_cnt
279
pct_str = ' (%5.1f%%)' % pct
283
if not self.show_count:
285
elif current_cnt is None:
287
elif total_cnt is None:
288
count_str = ' %i' % (current_cnt)
290
# make both fields the same size
291
t = '%i' % (total_cnt)
292
c = '%*i' % (len(t), current_cnt)
293
count_str = ' ' + c + '/' + t
296
# progress bar, if present, soaks up all remaining space
297
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
298
- len(eta_str) - len(count_str) - 3
301
# number of markers highlighted in bar
302
markers = int(round(float(cols) * current_cnt / total_cnt))
303
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
305
# don't know total, so can't show completion.
306
# so just show an expanded spinning thingy
307
m = self.spin_pos % cols
308
ms = (' ' * m + '*').ljust(cols)
310
bar_str = '[' + ms + '] '
316
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
318
assert len(m) < self.width
319
self.to_file.write('\r' + m.ljust(self.width - 1))
320
#self.to_file.flush()
323
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
324
#self.to_file.flush()
327
def str_tdelta(delt):
330
delt = int(round(delt))
331
return '%d:%02d:%02d' % (delt/3600,
336
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
337
if start_time is None:
343
if current < enough_samples:
349
elapsed = time.time() - start_time
351
if elapsed < 2.0: # not enough time to estimate
354
total_duration = float(elapsed) * float(total) / float(current)
356
assert total_duration >= elapsed
358
if last_updates and len(last_updates) >= n_recent:
359
while len(last_updates) > n_recent:
360
last_updates.popleft()
361
avg = sum(last_updates) / float(len(last_updates))
362
time_left = avg * (total - current)
364
old_time_left = total_duration - elapsed
366
# We could return the average, or some other value here
367
return (time_left + old_time_left) / 2
369
return total_duration - elapsed
374
result = doctest.testmod()
377
print "All tests passed"
379
print "No tests to run"
385
print 'dumb-terminal test:'
386
pb = DotsProgressBar()
388
pb.update('Leoparden', i, 99)
394
print 'smart-terminal test:'
395
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
397
pb.update('Elephanten', i, 99)
405
if __name__ == "__main__":
added
removed
bzrlib/progress.py
