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
20
Simple text-mode progress indicator.
22
Everyone loves ascii art!
24
To display an indicator, create a ProgressBar object. Call it,
25
passing Progress objects indicating the current state. When done,
28
Progress is suppressed when output is not sent to a terminal, so as
29
not to clutter log files.
32
# TODO: remove functions in favour of keeping everything in one class
34
# TODO: should be a global option e.g. --silent that disables progress
35
# indicators, preferably without needing to adjust all code that
36
# potentially calls them.
38
# TODO: Perhaps don't write updates faster than a certain rate, say
47
"""Return estimated terminal width.
49
TODO: Do something smart on Windows?
51
TODO: Is there anything that gets a better update when the window
52
is resized while the program is running?
56
return int(os.environ['COLUMNS'])
57
except (IndexError, KeyError, ValueError):
61
def _supports_progress(f):
62
if not hasattr(f, 'isatty'):
67
if os.environ.get('TERM') == 'dumb':
68
# e.g. emacs compile window
74
class ProgressBar(object):
75
"""Progress bar display object.
77
Several options are available to control the display. These can
78
be passed as parameters to the constructor or assigned at any time:
81
Show percentage complete.
83
Show rotating baton. This ticks over on every update even
84
if the values don't change.
86
Show predicted time-to-completion.
90
Show numerical counts.
92
The output file should be in line-buffered or unbuffered mode.
95
MIN_PAUSE = 0.1 # seconds
107
object.__init__(self)
108
self.to_file = to_file
109
self.suppressed = not _supports_progress(self.to_file)
114
self.last_total = None
115
self.show_pct = show_pct
116
self.show_spinner = show_spinner
117
self.show_eta = show_eta
118
self.show_bar = show_bar
119
self.show_count = show_count
123
self.update(self.last_msg, self.last_cnt, self.last_total)
127
def update(self, msg, current_cnt=None, total_cnt=None):
128
"""Update and redraw progress bar."""
132
# save these for the tick() function
134
self.last_cnt = current_cnt
135
self.last_total = total_cnt
138
if self.start_time is None:
139
self.start_time = now
141
interval = now - self.last_update
142
if interval > 0 and interval < self.MIN_PAUSE:
145
self.last_update = now
150
assert current_cnt <= total_cnt
152
assert current_cnt >= 0
154
if self.show_eta and self.start_time and total_cnt:
155
eta = get_eta(self.start_time, current_cnt, total_cnt)
156
eta_str = " " + str_tdelta(eta)
160
if self.show_spinner:
161
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
165
# always update this; it's also used for the bar
168
if self.show_pct and total_cnt and current_cnt:
169
pct = 100.0 * current_cnt / total_cnt
170
pct_str = ' (%5.1f%%)' % pct
174
if not self.show_count:
176
elif current_cnt is None:
178
elif total_cnt is None:
179
count_str = ' %i' % (current_cnt)
181
# make both fields the same size
182
t = '%i' % (total_cnt)
183
c = '%*i' % (len(t), current_cnt)
184
count_str = ' ' + c + '/' + t
187
# progress bar, if present, soaks up all remaining space
188
cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
189
- len(eta_str) - len(count_str) - 3
192
# number of markers highlighted in bar
193
markers = int(round(float(cols) * current_cnt / total_cnt))
194
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
196
# don't know total, so can't show completion.
197
# so just show an expanded spinning thingy
198
m = self.spin_pos % cols
199
ms = (' ' * m + '*').ljust(cols)
201
bar_str = '[' + ms + '] '
207
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
209
assert len(m) < width
210
self.to_file.write('\r' + m.ljust(width - 1))
211
#self.to_file.flush()
218
self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
219
#self.to_file.flush()
223
def str_tdelta(delt):
226
delt = int(round(delt))
227
return '%d:%02d:%02d' % (delt/3600,
232
def get_eta(start_time, current, total, enough_samples=3):
233
if start_time is None:
239
if current < enough_samples:
245
elapsed = time.time() - start_time
247
if elapsed < 2.0: # not enough time to estimate
250
total_duration = float(elapsed) * float(total) / float(current)
252
assert total_duration >= elapsed
254
return total_duration - elapsed
259
result = doctest.testmod()
262
print "All tests passed"
264
print "No tests to run"
268
from time import sleep
269
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
271
pb.update('Elephanten', i, 99)
278
if __name__ == "__main__":
added
removed
bzrlib/progress.py
