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
45
"""Return estimated terminal width.
47
TODO: Do something smart on Windows?
49
TODO: Is there anything that gets a better update when the window
50
is resized while the program is running?
53
return int(os.environ['COLUMNS'])
54
except (IndexError, KeyError, ValueError):
58
def _supports_progress(f):
59
if not hasattr(f, 'isatty'):
63
if os.environ.get('TERM') == 'dumb':
64
# e.g. emacs compile window
70
def ProgressBar(to_file=sys.stderr, **kwargs):
71
"""Abstract factory"""
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
75
return DotsProgressBar(to_file=to_file, **kwargs)
78
class _BaseProgressBar(object):
87
self.to_file = to_file
91
self.last_total = None
92
self.show_pct = show_pct
93
self.show_spinner = show_spinner
94
self.show_eta = show_eta
95
self.show_bar = show_bar
96
self.show_count = show_count
100
class DummyProgress(_BaseProgressBar):
101
"""Progress-bar standin that does nothing.
103
This can be used as the default argument for methods that
104
take an optional progress indicator."""
108
def update(self, msg=None, current=None, total=None):
115
class DotsProgressBar(_BaseProgressBar):
116
def __init__(self, **kwargs):
117
_BaseProgressBar.__init__(self, **kwargs)
124
def update(self, msg=None, current_cnt=None, total_cnt=None):
125
if msg and msg != self.last_msg:
127
self.to_file.write('\n')
129
self.to_file.write(msg + ': ')
132
self.to_file.write('.')
136
self.to_file.write('\n')
139
class TTYProgressBar(_BaseProgressBar):
140
"""Progress bar display object.
142
Several options are available to control the display. These can
143
be passed as parameters to the constructor or assigned at any time:
146
Show percentage complete.
148
Show rotating baton. This ticks over on every update even
149
if the values don't change.
151
Show predicted time-to-completion.
155
Show numerical counts.
157
The output file should be in line-buffered or unbuffered mode.
160
MIN_PAUSE = 0.1 # seconds
163
def __init__(self, **kwargs):
164
_BaseProgressBar.__init__(self, **kwargs)
166
self.width = _width()
167
self.start_time = None
168
self.last_update = None
172
"""Return True if the bar was updated too recently"""
174
if self.start_time is None:
175
self.start_time = self.last_update = now
178
interval = now - self.last_update
179
if interval > 0 and interval < self.MIN_PAUSE:
182
self.last_update = now
187
self.update(self.last_msg, self.last_cnt, self.last_total)
191
def update(self, msg, current_cnt=None, total_cnt=None):
192
"""Update and redraw progress bar."""
194
# save these for the tick() function
196
self.last_cnt = current_cnt
197
self.last_total = total_cnt
203
assert current_cnt <= total_cnt
205
assert current_cnt >= 0
207
if self.show_eta and self.start_time and total_cnt:
208
eta = get_eta(self.start_time, current_cnt, total_cnt)
209
eta_str = " " + str_tdelta(eta)
213
if self.show_spinner:
214
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
218
# always update this; it's also used for the bar
221
if self.show_pct and total_cnt and current_cnt:
222
pct = 100.0 * current_cnt / total_cnt
223
pct_str = ' (%5.1f%%)' % pct
227
if not self.show_count:
229
elif current_cnt is None:
231
elif total_cnt is None:
232
count_str = ' %i' % (current_cnt)
234
# make both fields the same size
235
t = '%i' % (total_cnt)
236
c = '%*i' % (len(t), current_cnt)
237
count_str = ' ' + c + '/' + t
240
# progress bar, if present, soaks up all remaining space
241
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
242
- len(eta_str) - len(count_str) - 3
245
# number of markers highlighted in bar
246
markers = int(round(float(cols) * current_cnt / total_cnt))
247
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
249
# don't know total, so can't show completion.
250
# so just show an expanded spinning thingy
251
m = self.spin_pos % cols
252
ms = (' ' * m + '*').ljust(cols)
254
bar_str = '[' + ms + '] '
260
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
262
assert len(m) < self.width
263
self.to_file.write('\r' + m.ljust(self.width - 1))
264
#self.to_file.flush()
268
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
269
#self.to_file.flush()
273
def str_tdelta(delt):
276
delt = int(round(delt))
277
return '%d:%02d:%02d' % (delt/3600,
282
def get_eta(start_time, current, total, enough_samples=3):
283
if start_time is None:
289
if current < enough_samples:
295
elapsed = time.time() - start_time
297
if elapsed < 2.0: # not enough time to estimate
300
total_duration = float(elapsed) * float(total) / float(current)
302
assert total_duration >= elapsed
304
return total_duration - elapsed
309
result = doctest.testmod()
312
print "All tests passed"
314
print "No tests to run"
320
print 'dumb-terminal test:'
321
pb = DotsProgressBar()
323
pb.update('Leoparden', i, 99)
329
print 'smart-terminal test:'
330
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
332
pb.update('Elephanten', i, 99)
340
if __name__ == "__main__":
added
removed
bzrlib/progress.py
