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.
31
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
32
# when the rate is unpredictable
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
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
45
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):
48
61
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)
62
if not hasattr(f, 'isatty'):
59
67
if os.environ.get('TERM') == 'dumb':
60
68
# e.g. emacs compile window
65
_progress_bar_types = {}
68
def ProgressBar(to_file=None, **kwargs):
69
"""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)
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()
154
class _BaseProgressBar(object):
163
to_messages_file=None,
165
object.__init__(self)
168
if to_messages_file is None:
169
to_messages_file = sys.stdout
170
self.to_file = to_file
171
self.to_messages_file = to_messages_file
174
self.last_total = None
175
self.show_pct = show_pct
176
self.show_spinner = show_spinner
177
self.show_eta = show_eta
178
self.show_bar = show_bar
179
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
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
296
def throttle(self, old_msg):
297
"""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
301
if self.start_time is not None and (now - self.start_time) < 1:
303
if old_msg != self.last_msg:
305
interval = now - self.last_update
307
if 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
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
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,
123
self.update(self.last_msg, self.last_cnt, self.last_total)
127
def update(self, msg, current_cnt=None, total_cnt=None):
333
128
"""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
132
# save these for the tick() function
361
133
self.last_msg = msg
362
134
self.last_cnt = current_cnt
363
135
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)
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)
376
156
eta_str = " " + str_tdelta(eta)
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
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))
431
211
#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
218
self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
437
219
#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
223
def str_tdelta(delt):
added
removed
bzrlib/progress.py
