1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005 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
def _supports_progress(f):
46
if not hasattr(f, 'isatty'):
50
if os.environ.get('TERM') == 'dumb':
51
# e.g. emacs compile window
57
def ProgressBar(to_file=sys.stderr, **kwargs):
58
"""Abstract factory"""
59
if _supports_progress(to_file):
60
return TTYProgressBar(to_file=to_file, **kwargs)
62
return DotsProgressBar(to_file=to_file, **kwargs)
65
class _BaseProgressBar(object):
73
to_messages_file=sys.stdout):
75
self.to_file = to_file
76
self.to_messages_file = to_messages_file
79
self.last_total = None
80
self.show_pct = show_pct
81
self.show_spinner = show_spinner
82
self.show_eta = show_eta
83
self.show_bar = show_bar
84
self.show_count = show_count
86
def note(self, fmt_string, *args, **kwargs):
87
"""Record a note without disrupting the progress bar."""
89
self.to_messages_file.write(fmt_string % args)
90
self.to_messages_file.write('\n')
93
class DummyProgress(_BaseProgressBar):
94
"""Progress-bar standin that does nothing.
96
This can be used as the default argument for methods that
97
take an optional progress indicator."""
101
def update(self, msg=None, current=None, total=None):
107
def note(self, fmt_string, *args, **kwargs):
108
"""See _BaseProgressBar.note()."""
111
class DotsProgressBar(_BaseProgressBar):
112
def __init__(self, **kwargs):
113
_BaseProgressBar.__init__(self, **kwargs)
120
def update(self, msg=None, current_cnt=None, total_cnt=None):
121
if msg and msg != self.last_msg:
123
self.to_file.write('\n')
125
self.to_file.write(msg + ': ')
128
self.to_file.write('.')
132
self.to_file.write('\n')
135
class TTYProgressBar(_BaseProgressBar):
136
"""Progress bar display object.
138
Several options are available to control the display. These can
139
be passed as parameters to the constructor or assigned at any time:
142
Show percentage complete.
144
Show rotating baton. This ticks over on every update even
145
if the values don't change.
147
Show predicted time-to-completion.
151
Show numerical counts.
153
The output file should be in line-buffered or unbuffered mode.
156
MIN_PAUSE = 0.1 # seconds
159
def __init__(self, **kwargs):
160
from bzrlib.osutils import terminal_width
161
_BaseProgressBar.__init__(self, **kwargs)
163
self.width = terminal_width()
164
self.start_time = None
165
self.last_update = None
166
self.last_updates = deque()
170
"""Return True if the bar was updated too recently"""
172
if self.start_time is None:
173
self.start_time = self.last_update = now
176
interval = now - self.last_update
177
if interval > 0 and interval < self.MIN_PAUSE:
180
self.last_updates.append(now - self.last_update)
181
self.last_update = now
186
self.update(self.last_msg, self.last_cnt, self.last_total)
190
def update(self, msg, current_cnt=None, total_cnt=None):
191
"""Update and redraw progress bar."""
196
if current_cnt > total_cnt:
197
total_cnt = current_cnt
199
# save these for the tick() function
201
self.last_cnt = current_cnt
202
self.last_total = total_cnt
207
if self.show_eta and self.start_time and total_cnt:
208
eta = get_eta(self.start_time, current_cnt, total_cnt,
209
last_updates = self.last_updates)
210
eta_str = " " + str_tdelta(eta)
214
if self.show_spinner:
215
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
219
# always update this; it's also used for the bar
222
if self.show_pct and total_cnt and current_cnt:
223
pct = 100.0 * current_cnt / total_cnt
224
pct_str = ' (%5.1f%%)' % pct
228
if not self.show_count:
230
elif current_cnt is None:
232
elif total_cnt is None:
233
count_str = ' %i' % (current_cnt)
235
# make both fields the same size
236
t = '%i' % (total_cnt)
237
c = '%*i' % (len(t), current_cnt)
238
count_str = ' ' + c + '/' + t
241
# progress bar, if present, soaks up all remaining space
242
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
243
- len(eta_str) - len(count_str) - 3
246
# number of markers highlighted in bar
247
markers = int(round(float(cols) * current_cnt / total_cnt))
248
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
250
# don't know total, so can't show completion.
251
# so just show an expanded spinning thingy
252
m = self.spin_pos % cols
253
ms = (' ' * m + '*').ljust(cols)
255
bar_str = '[' + ms + '] '
261
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
263
assert len(m) < self.width
264
self.to_file.write('\r' + m.ljust(self.width - 1))
265
#self.to_file.flush()
268
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
269
#self.to_file.flush()
272
def str_tdelta(delt):
275
delt = int(round(delt))
276
return '%d:%02d:%02d' % (delt/3600,
281
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
282
if start_time is None:
288
if current < enough_samples:
294
elapsed = time.time() - start_time
296
if elapsed < 2.0: # not enough time to estimate
299
total_duration = float(elapsed) * float(total) / float(current)
301
assert total_duration >= elapsed
303
if last_updates and len(last_updates) >= n_recent:
304
while len(last_updates) > n_recent:
305
last_updates.popleft()
306
avg = sum(last_updates) / float(len(last_updates))
307
time_left = avg * (total - current)
309
old_time_left = total_duration - elapsed
311
# We could return the average, or some other value here
312
return (time_left + old_time_left) / 2
314
return total_duration - elapsed
319
result = doctest.testmod()
322
print "All tests passed"
324
print "No tests to run"
330
print 'dumb-terminal test:'
331
pb = DotsProgressBar()
333
pb.update('Leoparden', i, 99)
339
print 'smart-terminal test:'
340
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
342
pb.update('Elephanten', i, 99)
350
if __name__ == "__main__":
added
removed
bzrlib/progress.py
