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: Perhaps don't write updates faster than a certain rate, say
36
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
37
# 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?
54
return int(os.environ['COLUMNS'])
55
except (IndexError, KeyError, ValueError):
59
def _supports_progress(f):
60
if not hasattr(f, 'isatty'):
65
if os.environ.get('TERM') == 'dumb':
66
# e.g. emacs compile window
72
class ProgressBar(object):
73
"""Progress bar display object.
75
Several options are available to control the display. These can
76
be passed as parameters to the constructor or assigned at any time:
79
Show percentage complete.
81
Show rotating baton. This ticks over on every update even
82
if the values don't change.
84
Show predicted time-to-completion.
88
Show numerical counts.
90
The output file should be in line-buffered or unbuffered mode.
93
MIN_PAUSE = 0.1 # seconds
105
object.__init__(self)
106
self.to_file = to_file
107
self.suppressed = not _supports_progress(self.to_file)
112
self.last_total = None
113
self.show_pct = show_pct
114
self.show_spinner = show_spinner
115
self.show_eta = show_eta
116
self.show_bar = show_bar
117
self.show_count = show_count
119
self.width = _width()
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
148
assert current_cnt <= total_cnt
150
assert current_cnt >= 0
152
if self.show_eta and self.start_time and total_cnt:
153
eta = get_eta(self.start_time, current_cnt, total_cnt)
154
eta_str = " " + str_tdelta(eta)
158
if self.show_spinner:
159
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
163
# always update this; it's also used for the bar
166
if self.show_pct and total_cnt and current_cnt:
167
pct = 100.0 * current_cnt / total_cnt
168
pct_str = ' (%5.1f%%)' % pct
172
if not self.show_count:
174
elif current_cnt is None:
176
elif total_cnt is None:
177
count_str = ' %i' % (current_cnt)
179
# make both fields the same size
180
t = '%i' % (total_cnt)
181
c = '%*i' % (len(t), current_cnt)
182
count_str = ' ' + c + '/' + t
185
# progress bar, if present, soaks up all remaining space
186
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
187
- len(eta_str) - len(count_str) - 3
190
# number of markers highlighted in bar
191
markers = int(round(float(cols) * current_cnt / total_cnt))
192
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
194
# don't know total, so can't show completion.
195
# so just show an expanded spinning thingy
196
m = self.spin_pos % cols
197
ms = (' ' * m + '*').ljust(cols)
199
bar_str = '[' + ms + '] '
205
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
207
assert len(m) < self.width
208
self.to_file.write('\r' + m.ljust(self.width - 1))
209
#self.to_file.flush()
216
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
217
#self.to_file.flush()
221
def str_tdelta(delt):
224
delt = int(round(delt))
225
return '%d:%02d:%02d' % (delt/3600,
230
def get_eta(start_time, current, total, enough_samples=3):
231
if start_time is None:
237
if current < enough_samples:
243
elapsed = time.time() - start_time
245
if elapsed < 2.0: # not enough time to estimate
248
total_duration = float(elapsed) * float(total) / float(current)
250
assert total_duration >= elapsed
252
return total_duration - elapsed
257
result = doctest.testmod()
260
print "All tests passed"
262
print "No tests to run"
266
from time import sleep
267
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
269
pb.update('Elephanten', i, 99)
276
if __name__ == "__main__":
added
removed
bzrlib/progress.py
