1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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!
21
24
To display an indicator, create a ProgressBar object. Call it,
22
25
passing Progress objects indicating the current state. When done,
26
29
not to clutter log files.
32
# TODO: remove functions in favour of keeping everything in one class
29
34
# TODO: should be a global option e.g. --silent that disables progress
30
35
# indicators, preferably without needing to adjust all code that
31
36
# potentially calls them.
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
38
# TODO: Perhaps don't write updates faster than a certain rate, say
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
# when the rate is unpredictable
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
49
from bzrlib.trace import mutter
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):
52
61
def _supports_progress(f):
53
isatty = getattr(f, 'isatty', None)
62
if not hasattr(f, 'isatty'):
58
67
if os.environ.get('TERM') == 'dumb':
59
68
# e.g. emacs compile window
64
_progress_bar_types = {}
67
def ProgressBar(to_file=None, **kwargs):
68
"""Abstract factory"""
71
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
72
# An value of '' or not set reverts to standard processing
73
if requested_bar_type in (None, ''):
74
if _supports_progress(to_file):
75
return TTYProgressBar(to_file=to_file, **kwargs)
77
return DotsProgressBar(to_file=to_file, **kwargs)
79
# Minor sanitation to prevent spurious errors
80
requested_bar_type = requested_bar_type.lower().strip()
81
# TODO: jam 20060710 Arguably we shouldn't raise an exception
82
# but should instead just disable progress bars if we
83
# don't recognize the type
84
if requested_bar_type not in _progress_bar_types:
85
raise errors.InvalidProgressBarType(requested_bar_type,
86
_progress_bar_types.keys())
87
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
90
class ProgressBarStack(object):
91
"""A stack of progress bars."""
100
to_messages_file=None,
102
"""Setup the stack with the parameters the progress bars should have."""
105
if to_messages_file is None:
106
to_messages_file = sys.stdout
107
self._to_file = to_file
108
self._show_pct = show_pct
109
self._show_spinner = show_spinner
110
self._show_eta = show_eta
111
self._show_bar = show_bar
112
self._show_count = show_count
113
self._to_messages_file = to_messages_file
115
self._klass = klass or ProgressBar
118
if len(self._stack) != 0:
119
return self._stack[-1]
124
if len(self._stack) != 0:
125
return self._stack[0]
129
def get_nested(self):
130
"""Return a nested progress bar."""
131
if len(self._stack) == 0:
134
func = self.top().child_progress
135
new_bar = func(to_file=self._to_file,
136
show_pct=self._show_pct,
137
show_spinner=self._show_spinner,
138
show_eta=self._show_eta,
139
show_bar=self._show_bar,
140
show_count=self._show_count,
141
to_messages_file=self._to_messages_file,
143
self._stack.append(new_bar)
146
def return_pb(self, bar):
147
"""Return bar after its been used."""
148
if bar is not self._stack[-1]:
149
raise errors.MissingProgressBarFinish()
153
class _BaseProgressBar(object):
162
to_messages_file=None,
164
object.__init__(self)
167
if to_messages_file is None:
168
to_messages_file = sys.stdout
169
self.to_file = to_file
170
self.to_messages_file = to_messages_file
173
self.last_total = None
174
self.show_pct = show_pct
175
self.show_spinner = show_spinner
176
self.show_eta = show_eta
177
self.show_bar = show_bar
178
self.show_count = show_count
181
self.MIN_PAUSE = 0.1 # seconds
184
self.start_time = now
185
# next update should not throttle
186
self.last_update = now - self.MIN_PAUSE - 1
189
"""Return this bar to its progress stack."""
191
assert self._stack is not None
192
self._stack.return_pb(self)
194
def note(self, fmt_string, *args, **kwargs):
195
"""Record a note without disrupting the progress bar."""
197
self.to_messages_file.write(fmt_string % args)
198
self.to_messages_file.write('\n')
200
def child_progress(self, **kwargs):
201
return ChildProgress(**kwargs)
204
class DummyProgress(_BaseProgressBar):
205
"""Progress-bar standin that does nothing.
207
This can be used as the default argument for methods that
208
take an optional progress indicator."""
212
def update(self, msg=None, current=None, total=None):
215
def child_update(self, message, current, total):
221
def note(self, fmt_string, *args, **kwargs):
222
"""See _BaseProgressBar.note()."""
224
def child_progress(self, **kwargs):
225
return DummyProgress(**kwargs)
228
_progress_bar_types['dummy'] = DummyProgress
229
_progress_bar_types['none'] = DummyProgress
232
class DotsProgressBar(_BaseProgressBar):
234
def __init__(self, **kwargs):
235
_BaseProgressBar.__init__(self, **kwargs)
242
def update(self, msg=None, current_cnt=None, total_cnt=None):
243
if msg and msg != self.last_msg:
245
self.to_file.write('\n')
246
self.to_file.write(msg + ': ')
249
self.to_file.write('.')
253
self.to_file.write('\n')
256
def child_update(self, message, current, total):
260
_progress_bar_types['dots'] = DotsProgressBar
263
class TTYProgressBar(_BaseProgressBar):
74
class ProgressBar(object):
264
75
"""Progress bar display object.
266
77
Several options are available to control the display. These can
281
92
The output file should be in line-buffered or unbuffered mode.
283
94
SPIN_CHARS = r'/-\|'
286
def __init__(self, **kwargs):
287
from bzrlib.osutils import terminal_width
288
_BaseProgressBar.__init__(self, **kwargs)
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)
289
110
self.spin_pos = 0
290
self.width = terminal_width()
291
self.last_updates = []
292
self._max_last_updates = 10
293
self.child_fraction = 0
294
self._have_output = False
297
def throttle(self, old_msg):
298
"""Return True if the bar was updated too recently"""
299
# time.time consistently takes 40/4000 ms = 0.01 ms.
300
# time.clock() is faster, but gives us CPU time, not wall-clock time
302
if self.start_time is not None and (now - self.start_time) < 1:
304
if old_msg != self.last_msg:
306
interval = now - self.last_update
308
if interval < self.MIN_PAUSE:
311
self.last_updates.append(now - self.last_update)
312
# Don't let the queue grow without bound
313
self.last_updates = self.last_updates[-self._max_last_updates:]
314
self.last_update = now
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
318
self.update(self.last_msg, self.last_cnt, self.last_total,
321
def child_update(self, message, current, total):
322
if current is not None and total != 0:
323
child_fraction = float(current) / total
324
if self.last_cnt is None:
326
elif self.last_cnt + child_fraction <= self.last_total:
327
self.child_fraction = child_fraction
329
mutter('not updating child fraction')
330
if self.last_msg is None:
334
def update(self, msg, current_cnt=None, total_cnt=None,
123
self.update(self.last_msg, self.last_cnt, self.last_total)
127
def update(self, msg, current_cnt=None, total_cnt=None):
336
128
"""Update and redraw progress bar."""
340
if total_cnt is None:
341
total_cnt = self.last_total
346
if current_cnt > total_cnt:
347
total_cnt = current_cnt
349
## # optional corner case optimisation
350
## # currently does not seem to fire so costs more than saved.
351
## # trivial optimal case:
352
## # NB if callers are doing a clear and restore with
353
## # the saved values, this will prevent that:
354
## # in that case add a restore method that calls
355
## # _do_update or some such
356
## if (self.last_msg == msg and
357
## self.last_cnt == current_cnt and
358
## self.last_total == total_cnt and
359
## self.child_fraction == child_fraction):
362
old_msg = self.last_msg
363
132
# save these for the tick() function
364
133
self.last_msg = msg
365
134
self.last_cnt = current_cnt
366
135
self.last_total = total_cnt
367
self.child_fraction = child_fraction
369
# each function call takes 20ms/4000 = 0.005 ms,
370
# but multiple that by 4000 calls -> starts to cost.
371
# so anything to make this function call faster
372
# will improve base 'diff' time by up to 0.1 seconds.
373
if self.throttle(old_msg):
376
if self.show_eta and self.start_time and self.last_total:
377
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
378
self.last_total, last_updates = self.last_updates)
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)
379
156
eta_str = " " + str_tdelta(eta)
388
165
# always update this; it's also used for the bar
389
166
self.spin_pos += 1
391
if self.show_pct and self.last_total and self.last_cnt:
392
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
168
if self.show_pct and total_cnt and current_cnt:
169
pct = 100.0 * current_cnt / total_cnt
393
170
pct_str = ' (%5.1f%%)' % pct
397
174
if not self.show_count:
399
elif self.last_cnt is None:
176
elif current_cnt is None:
401
elif self.last_total is None:
402
count_str = ' %i' % (self.last_cnt)
178
elif total_cnt is None:
179
count_str = ' %i' % (current_cnt)
404
181
# make both fields the same size
405
t = '%i' % (self.last_total)
406
c = '%*i' % (len(t), self.last_cnt)
182
t = '%i' % (total_cnt)
183
c = '%*i' % (len(t), current_cnt)
407
184
count_str = ' ' + c + '/' + t
409
186
if self.show_bar:
410
187
# progress bar, if present, soaks up all remaining space
411
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
188
cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
412
189
- len(eta_str) - len(count_str) - 3
415
192
# number of markers highlighted in bar
416
markers = int(round(float(cols) *
417
(self.last_cnt + self.child_fraction) / self.last_total))
193
markers = int(round(float(cols) * current_cnt / total_cnt))
418
194
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
420
196
# don't know total, so can't show completion.
431
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
432
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
433
self._have_output = True
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))
434
211
#self.to_file.flush()
437
if self._have_output:
438
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
439
self._have_output = False
218
self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
440
219
#self.to_file.flush()
443
_progress_bar_types['tty'] = TTYProgressBar
446
class ChildProgress(_BaseProgressBar):
447
"""A progress indicator that pushes its data to the parent"""
449
def __init__(self, _stack, **kwargs):
450
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
451
self.parent = _stack.top()
454
self.child_fraction = 0
457
def update(self, msg, current_cnt=None, total_cnt=None):
458
self.current = current_cnt
459
self.total = total_cnt
461
self.child_fraction = 0
464
def child_update(self, message, current, total):
465
if current is None or total == 0:
466
self.child_fraction = 0
468
self.child_fraction = float(current) / total
472
if self.current is None:
475
count = self.current+self.child_fraction
476
if count > self.total:
478
mutter('clamping count of %d to %d' % (count, self.total))
480
self.parent.child_update(self.message, count, self.total)
485
def note(self, *args, **kwargs):
486
self.parent.note(*args, **kwargs)
489
223
def str_tdelta(delt):
added
removed
bzrlib/progress.py
