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
"""Progress indicators.
21
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
22
will maintain a ProgressBarStack for you.
24
For direct use, the factory ProgressBar will return an auto-detected progress
25
bar that should match your terminal type. You can manually create a
26
ProgressBarStack too if you need multiple levels of cooperating progress bars.
27
Note that bzrlib's internal functions use the ui module, so if you are using
28
bzrlib it really is best to use bzrlib.ui.ui_factory.
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
31
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
32
36
# when the rate is unpredictable
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
45
from bzrlib.trace import mutter
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):
48
58
def _supports_progress(f):
49
"""Detect if we can use pretty progress bars on the output stream f.
51
If this returns true we expect that a human may be looking at that
52
output, and that we can repaint a line to update it.
54
isatty = getattr(f, 'isatty', None)
59
if not hasattr(f, 'isatty'):
59
63
if os.environ.get('TERM') == 'dumb':
60
64
# e.g. emacs compile window
65
_progress_bar_types = {}
68
def ProgressBar(to_file=None, **kwargs):
70
def ProgressBar(to_file=sys.stderr, **kwargs):
69
71
"""Abstract factory"""
72
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
73
# An value of '' or not set reverts to standard processing
74
if requested_bar_type in (None, ''):
75
if _supports_progress(to_file):
76
return TTYProgressBar(to_file=to_file, **kwargs)
78
return DummyProgress(to_file=to_file, **kwargs)
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
80
# Minor sanitation to prevent spurious errors
81
requested_bar_type = requested_bar_type.lower().strip()
82
# TODO: jam 20060710 Arguably we shouldn't raise an exception
83
# but should instead just disable progress bars if we
84
# don't recognize the type
85
if requested_bar_type not in _progress_bar_types:
86
raise errors.InvalidProgressBarType(requested_bar_type,
87
_progress_bar_types.keys())
88
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
91
class ProgressBarStack(object):
92
"""A stack of progress bars."""
101
to_messages_file=None,
103
"""Setup the stack with the parameters the progress bars should have."""
106
if to_messages_file is None:
107
to_messages_file = sys.stdout
108
self._to_file = to_file
109
self._show_pct = show_pct
110
self._show_spinner = show_spinner
111
self._show_eta = show_eta
112
self._show_bar = show_bar
113
self._show_count = show_count
114
self._to_messages_file = to_messages_file
116
self._klass = klass or ProgressBar
119
if len(self._stack) != 0:
120
return self._stack[-1]
125
if len(self._stack) != 0:
126
return self._stack[0]
130
def get_nested(self):
131
"""Return a nested progress bar."""
132
if len(self._stack) == 0:
135
func = self.top().child_progress
136
new_bar = func(to_file=self._to_file,
137
show_pct=self._show_pct,
138
show_spinner=self._show_spinner,
139
show_eta=self._show_eta,
140
show_bar=self._show_bar,
141
show_count=self._show_count,
142
to_messages_file=self._to_messages_file,
144
self._stack.append(new_bar)
147
def return_pb(self, bar):
148
"""Return bar after its been used."""
149
if bar is not self._stack[-1]:
150
raise errors.MissingProgressBarFinish()
75
return DotsProgressBar(to_file=to_file, **kwargs)
154
78
class _BaseProgressBar(object):
156
79
def __init__(self,
159
82
show_spinner=False,
163
to_messages_file=None,
165
86
object.__init__(self)
168
if to_messages_file is None:
169
to_messages_file = sys.stdout
170
87
self.to_file = to_file
171
self.to_messages_file = to_messages_file
172
89
self.last_msg = None
173
90
self.last_cnt = None
174
91
self.last_total = None
177
94
self.show_eta = show_eta
178
95
self.show_bar = show_bar
179
96
self.show_count = show_count
182
self.MIN_PAUSE = 0.1 # seconds
185
self.start_time = now
186
# next update should not throttle
187
self.last_update = now - self.MIN_PAUSE - 1
190
"""Return this bar to its progress stack."""
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
100
class DotsProgressBar(_BaseProgressBar):
234
101
def __init__(self, **kwargs):
235
102
_BaseProgressBar.__init__(self, **kwargs)
236
103
self.last_msg = None
281
142
The output file should be in line-buffered or unbuffered mode.
283
144
SPIN_CHARS = r'/-\|'
145
MIN_PAUSE = 0.1 # seconds
286
148
def __init__(self, **kwargs):
287
from bzrlib.osutils import terminal_width
288
149
_BaseProgressBar.__init__(self, **kwargs)
289
150
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
151
self.width = _width()
152
self.start_time = None
153
self.last_update = None
296
def throttle(self, old_msg):
297
157
"""Return True if the bar was updated too recently"""
298
# time.time consistently takes 40/4000 ms = 0.01 ms.
299
# time.clock() is faster, but gives us CPU time, not wall-clock time
300
158
now = time.time()
301
if self.start_time is not None and (now - self.start_time) < 1:
303
if old_msg != self.last_msg:
159
if self.start_time is None:
160
self.start_time = self.last_update = now
305
interval = now - self.last_update
307
if interval < self.MIN_PAUSE:
163
interval = now - self.last_update
164
if interval > 0 and interval < self.MIN_PAUSE:
310
self.last_updates.append(now - self.last_update)
311
# Don't let the queue grow without bound
312
self.last_updates = self.last_updates[-self._max_last_updates:]
313
167
self.last_update = now
317
self.update(self.last_msg, self.last_cnt, self.last_total,
320
def child_update(self, message, current, total):
321
if current is not None and total != 0:
322
child_fraction = float(current) / total
323
if self.last_cnt is None:
325
elif self.last_cnt + child_fraction <= self.last_total:
326
self.child_fraction = child_fraction
327
if self.last_msg is None:
331
def update(self, msg, current_cnt=None, total_cnt=None,
172
self.update(self.last_msg, self.last_cnt, self.last_total)
176
def update(self, msg, current_cnt=None, total_cnt=None):
333
177
"""Update and redraw progress bar."""
337
if total_cnt is None:
338
total_cnt = self.last_total
343
if current_cnt > total_cnt:
344
total_cnt = current_cnt
346
## # optional corner case optimisation
347
## # currently does not seem to fire so costs more than saved.
348
## # trivial optimal case:
349
## # NB if callers are doing a clear and restore with
350
## # the saved values, this will prevent that:
351
## # in that case add a restore method that calls
352
## # _do_update or some such
353
## if (self.last_msg == msg and
354
## self.last_cnt == current_cnt and
355
## self.last_total == total_cnt and
356
## self.child_fraction == child_fraction):
359
old_msg = self.last_msg
360
179
# save these for the tick() function
361
180
self.last_msg = msg
362
181
self.last_cnt = current_cnt
363
182
self.last_total = total_cnt
364
self.child_fraction = child_fraction
366
# each function call takes 20ms/4000 = 0.005 ms,
367
# but multiple that by 4000 calls -> starts to cost.
368
# so anything to make this function call faster
369
# will improve base 'diff' time by up to 0.1 seconds.
370
if self.throttle(old_msg):
373
if self.show_eta and self.start_time and self.last_total:
374
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
375
self.last_total, last_updates = self.last_updates)
188
assert current_cnt <= total_cnt
190
assert current_cnt >= 0
192
if self.show_eta and self.start_time and total_cnt:
193
eta = get_eta(self.start_time, current_cnt, total_cnt)
376
194
eta_str = " " + str_tdelta(eta)
385
203
# always update this; it's also used for the bar
386
204
self.spin_pos += 1
388
if self.show_pct and self.last_total and self.last_cnt:
389
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
206
if self.show_pct and total_cnt and current_cnt:
207
pct = 100.0 * current_cnt / total_cnt
390
208
pct_str = ' (%5.1f%%)' % pct
394
212
if not self.show_count:
396
elif self.last_cnt is None:
214
elif current_cnt is None:
398
elif self.last_total is None:
399
count_str = ' %i' % (self.last_cnt)
216
elif total_cnt is None:
217
count_str = ' %i' % (current_cnt)
401
219
# make both fields the same size
402
t = '%i' % (self.last_total)
403
c = '%*i' % (len(t), self.last_cnt)
220
t = '%i' % (total_cnt)
221
c = '%*i' % (len(t), current_cnt)
404
222
count_str = ' ' + c + '/' + t
406
224
if self.show_bar:
407
225
# progress bar, if present, soaks up all remaining space
408
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
226
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
409
227
- len(eta_str) - len(count_str) - 3
412
230
# number of markers highlighted in bar
413
markers = int(round(float(cols) *
414
(self.last_cnt + self.child_fraction) / self.last_total))
231
markers = int(round(float(cols) * current_cnt / total_cnt))
415
232
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
417
234
# don't know total, so can't show completion.
428
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
429
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
430
self._have_output = True
245
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
247
assert len(m) < self.width
248
self.to_file.write('\r' + m.ljust(self.width - 1))
431
249
#self.to_file.flush()
434
if self._have_output:
435
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
436
self._have_output = False
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
437
254
#self.to_file.flush()
440
_progress_bar_types['tty'] = TTYProgressBar
443
class ChildProgress(_BaseProgressBar):
444
"""A progress indicator that pushes its data to the parent"""
446
def __init__(self, _stack, **kwargs):
447
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
448
self.parent = _stack.top()
451
self.child_fraction = 0
454
def update(self, msg, current_cnt=None, total_cnt=None):
455
self.current = current_cnt
456
if total_cnt is not None:
457
self.total = total_cnt
459
self.child_fraction = 0
462
def child_update(self, message, current, total):
463
if current is None or total == 0:
464
self.child_fraction = 0
466
self.child_fraction = float(current) / total
470
if self.current is None:
473
count = self.current+self.child_fraction
474
if count > self.total:
476
mutter('clamping count of %d to %d' % (count, self.total))
478
self.parent.child_update(self.message, count, self.total)
483
def note(self, *args, **kwargs):
484
self.parent.note(*args, **kwargs)
487
class InstrumentedProgress(TTYProgressBar):
488
"""TTYProgress variant that tracks outcomes"""
490
def __init__(self, *args, **kwargs):
491
self.always_throttled = True
492
self.never_throttle = False
493
TTYProgressBar.__init__(self, *args, **kwargs)
495
def throttle(self, old_message):
496
if self.never_throttle:
499
result = TTYProgressBar.throttle(self, old_message)
501
self.always_throttled = False
504
258
def str_tdelta(delt):
531
285
total_duration = float(elapsed) * float(total) / float(current)
533
if last_updates and len(last_updates) >= n_recent:
534
avg = sum(last_updates) / float(len(last_updates))
535
time_left = avg * (total - current)
537
old_time_left = total_duration - elapsed
539
# We could return the average, or some other value here
540
return (time_left + old_time_left) / 2
287
assert total_duration >= elapsed
542
289
return total_duration - elapsed
545
class ProgressPhase(object):
546
"""Update progress object with the current phase"""
547
def __init__(self, message, total, pb):
548
object.__init__(self)
550
self.message = message
552
self.cur_phase = None
554
def next_phase(self):
555
if self.cur_phase is None:
559
self.pb.update(self.message, self.cur_phase, self.total)
294
result = doctest.testmod()
297
print "All tests passed"
299
print "No tests to run"
305
print 'dumb-terminal test:'
306
pb = DotsProgressBar()
308
pb.update('Leoparden', i, 99)
314
print 'smart-terminal test:'
315
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
317
pb.update('Elephanten', i, 99)
325
if __name__ == "__main__":
added
removed
bzrlib/progress.py
