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
return hasattr(f, 'isatty') and f.isatty()
66
class ProgressBar(object):
67
"""Progress bar display object.
69
Several options are available to control the display. These can
70
be passed as parameters to the constructor or assigned at any time:
73
Show percentage complete.
75
Show rotating baton. This ticks over on every update even
76
if the values don't change.
78
Show predicted time-to-completion.
82
Show numerical counts.
84
The output file should be in line-buffered or unbuffered mode.
96
self.start_time = None
97
self.to_file = to_file
98
self.suppressed = not _supports_progress(self.to_file)
101
self.show_pct = show_pct
102
self.show_spinner = show_spinner
103
self.show_eta = show_eta
104
self.show_bar = show_bar
105
self.show_count = show_count
109
self.update(self.last_msg, self.last_cnt, self.last_total)
113
def update(self, msg, current_cnt, total_cnt=None):
114
"""Update and redraw progress bar."""
115
if self.start_time is None:
116
self.start_time = datetime.datetime.now()
118
# save these for the tick() function
120
self.last_cnt = current_cnt
121
self.last_total = total_cnt
129
assert current_cnt <= total_cnt
131
assert current_cnt >= 0
133
if self.show_eta and self.start_time and total_cnt:
134
eta = get_eta(self.start_time, current_cnt, total_cnt)
135
eta_str = " " + str_tdelta(eta)
139
if self.show_spinner:
140
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
144
# always update this; it's also used for the bar
147
if self.show_pct and total_cnt and current_cnt:
148
pct = 100.0 * current_cnt / total_cnt
149
pct_str = ' (%5.1f%%)' % pct
153
if not self.show_count:
155
elif current_cnt is None:
157
elif total_cnt is None:
158
count_str = ' %i' % (current_cnt)
160
# make both fields the same size
161
t = '%i' % (total_cnt)
162
c = '%*i' % (len(t), current_cnt)
163
count_str = ' ' + c + '/' + t
166
# progress bar, if present, soaks up all remaining space
167
cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
168
- len(eta_str) - len(count_str) - 3
171
# number of markers highlighted in bar
172
markers = int(round(float(cols) * current_cnt / total_cnt))
173
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
175
# don't know total, so can't show completion.
176
# so just show an expanded spinning thingy
177
m = self.spin_pos % cols
181
bar_str = '[' + ms + '] '
185
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
187
assert len(m) < width
188
self.to_file.write('\r' + m.ljust(width - 1))
189
#self.to_file.flush()
196
self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
197
#self.to_file.flush()
201
def divide_timedelta(delt, divisor):
202
"""Divides a timedelta object"""
203
return datetime.timedelta(float(delt.days)/divisor,
204
float(delt.seconds)/divisor,
205
float(delt.microseconds)/divisor)
207
def str_tdelta(delt):
210
return str(datetime.timedelta(delt.days, delt.seconds))
213
def get_eta(start_time, current, total, enough_samples=20):
214
if start_time is None or current == 0:
216
elif current < enough_samples:
217
# FIXME: No good if it's not a count
219
elapsed = datetime.datetime.now() - start_time
220
total_duration = divide_timedelta(elapsed * long(total),
222
if elapsed < total_duration:
223
eta = total_duration - elapsed
225
eta = total_duration - total_duration
231
result = doctest.testmod()
234
print "All tests passed"
236
print "No tests to run"
240
from time import sleep
241
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
243
pb.update('Elephanten', i, 99)
250
if __name__ == "__main__":
added
removed
bzrlib/progress.py
