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
46
"""Return estimated terminal width.
48
TODO: Do something smart on Windows?
50
TODO: Is there anything that gets a better update when the window
51
is resized while the program is running?
54
return int(os.environ['COLUMNS'])
55
except (IndexError, KeyError, ValueError):
59
def _supports_progress(f):
60
if not hasattr(f, 'isatty'):
64
if os.environ.get('TERM') == 'dumb':
65
# e.g. emacs compile window
71
def ProgressBar(to_file=sys.stderr, **kwargs):
72
"""Abstract factory"""
73
if _supports_progress(to_file):
74
return TTYProgressBar(to_file=to_file, **kwargs)
76
return DotsProgressBar(to_file=to_file, **kwargs)
79
class _BaseProgressBar(object):
88
self.to_file = to_file
92
self.last_total = None
93
self.show_pct = show_pct
94
self.show_spinner = show_spinner
95
self.show_eta = show_eta
96
self.show_bar = show_bar
97
self.show_count = show_count
101
class DummyProgress(_BaseProgressBar):
102
"""Progress-bar standin that does nothing.
104
This can be used as the default argument for methods that
105
take an optional progress indicator."""
109
def update(self, msg=None, current=None, total=None):
116
class DotsProgressBar(_BaseProgressBar):
117
def __init__(self, **kwargs):
118
_BaseProgressBar.__init__(self, **kwargs)
125
def update(self, msg=None, current_cnt=None, total_cnt=None):
126
if msg and msg != self.last_msg:
128
self.to_file.write('\n')
130
self.to_file.write(msg + ': ')
133
self.to_file.write('.')
137
self.to_file.write('\n')
140
class TTYProgressBar(_BaseProgressBar):
141
"""Progress bar display object.
143
Several options are available to control the display. These can
144
be passed as parameters to the constructor or assigned at any time:
147
Show percentage complete.
149
Show rotating baton. This ticks over on every update even
150
if the values don't change.
152
Show predicted time-to-completion.
156
Show numerical counts.
158
The output file should be in line-buffered or unbuffered mode.
161
MIN_PAUSE = 0.1 # seconds
164
def __init__(self, **kwargs):
165
_BaseProgressBar.__init__(self, **kwargs)
167
self.width = _width()
168
self.start_time = None
169
self.last_update = None
170
self.last_updates = deque()
174
"""Return True if the bar was updated too recently"""
176
if self.start_time is None:
177
self.start_time = self.last_update = now
180
interval = now - self.last_update
181
if interval > 0 and interval < self.MIN_PAUSE:
184
self.last_updates.append(now - self.last_update)
185
self.last_update = now
190
self.update(self.last_msg, self.last_cnt, self.last_total)
194
def update(self, msg, current_cnt=None, total_cnt=None):
195
"""Update and redraw progress bar."""
200
if current_cnt > total_cnt:
201
total_cnt = current_cnt
203
# save these for the tick() function
205
self.last_cnt = current_cnt
206
self.last_total = total_cnt
211
if self.show_eta and self.start_time and total_cnt:
212
eta = get_eta(self.start_time, current_cnt, total_cnt,
213
last_updates = self.last_updates)
214
eta_str = " " + str_tdelta(eta)
218
if self.show_spinner:
219
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
223
# always update this; it's also used for the bar
226
if self.show_pct and total_cnt and current_cnt:
227
pct = 100.0 * current_cnt / total_cnt
228
pct_str = ' (%5.1f%%)' % pct
232
if not self.show_count:
234
elif current_cnt is None:
236
elif total_cnt is None:
237
count_str = ' %i' % (current_cnt)
239
# make both fields the same size
240
t = '%i' % (total_cnt)
241
c = '%*i' % (len(t), current_cnt)
242
count_str = ' ' + c + '/' + t
245
# progress bar, if present, soaks up all remaining space
246
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
247
- len(eta_str) - len(count_str) - 3
250
# number of markers highlighted in bar
251
markers = int(round(float(cols) * current_cnt / total_cnt))
252
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
254
# don't know total, so can't show completion.
255
# so just show an expanded spinning thingy
256
m = self.spin_pos % cols
257
ms = (' ' * m + '*').ljust(cols)
259
bar_str = '[' + ms + '] '
265
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
267
assert len(m) < self.width
268
self.to_file.write('\r' + m.ljust(self.width - 1))
269
#self.to_file.flush()
273
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
274
#self.to_file.flush()
278
def str_tdelta(delt):
281
delt = int(round(delt))
282
return '%d:%02d:%02d' % (delt/3600,
287
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
288
if start_time is None:
294
if current < enough_samples:
300
elapsed = time.time() - start_time
302
if elapsed < 2.0: # not enough time to estimate
305
total_duration = float(elapsed) * float(total) / float(current)
307
assert total_duration >= elapsed
309
if last_updates and len(last_updates) >= n_recent:
310
while len(last_updates) > n_recent:
311
last_updates.popleft()
312
avg = sum(last_updates) / float(len(last_updates))
313
time_left = avg * (total - current)
315
old_time_left = total_duration - elapsed
317
# We could return the average, or some other value here
318
return (time_left + old_time_left) / 2
320
return total_duration - elapsed
325
result = doctest.testmod()
328
print "All tests passed"
330
print "No tests to run"
336
print 'dumb-terminal test:'
337
pb = DotsProgressBar()
339
pb.update('Leoparden', i, 99)
345
print 'smart-terminal test:'
346
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
348
pb.update('Elephanten', i, 99)
356
if __name__ == "__main__":
added
removed
bzrlib/progress.py
