1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Progress indicators.
20
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
21
will maintain a ProgressBarStack for you.
23
For direct use, the factory ProgressBar will return an auto-detected progress
24
bar that should match your terminal type. You can manually create a
25
ProgressBarStack too if you need multiple levels of cooperating progress bars.
26
Note that bzrlib's internal functions use the ui module, so if you are using
27
bzrlib it really is best to use bzrlib.ui.ui_factory.
43
from bzrlib.trace import mutter
46
def _supports_progress(f):
47
"""Detect if we can use pretty progress bars on the output stream f.
49
If this returns true we expect that a human may be looking at that
50
output, and that we can repaint a line to update it.
52
isatty = getattr(f, 'isatty', None)
57
if os.environ.get('TERM') == 'dumb':
58
# e.g. emacs compile window
63
class ProgressTask(object):
64
"""Model component of a progress indicator.
66
Most code that needs to indicate progress should update one of these,
67
and it will in turn update the display, if one is present.
69
Code updating the task may also set fields as hints about how to display
70
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
71
will not necessarily respect all these fields.
74
def __init__(self, parent_task=None, ui_factory=None):
75
self._parent_task = parent_task
78
self.current_cnt = None
80
self.ui_factory = ui_factory
82
self.show_spinner = True
83
self.show_eta = False,
84
self.show_count = True
87
def update(self, msg, current_cnt=None, total_cnt=None):
89
self.current_cnt = current_cnt
91
self.total_cnt = total_cnt
92
self.ui_factory.show_progress(self)
98
self.ui_factory.progress_finished(self)
100
def make_sub_task(self):
101
return ProgressTask(self, self.ui_factory)
103
def _overall_completion_fraction(self, child_fraction=0.0):
104
"""Return fractional completion of this task and its parents
106
Returns None if no completion can be computed."""
108
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
111
if self._parent_task is None:
114
if own_fraction is None:
116
return self._parent_task._overall_completion_fraction(own_fraction)
118
def note(self, fmt_string, *args):
119
"""Record a note without disrupting the progress bar."""
120
# XXX: shouldn't be here; put it in mutter or the ui instead
121
self.ui_factory.note(fmt_string % args)
124
# XXX: shouldn't be here; put it in mutter or the ui instead
125
self.ui_factory.clear_term()
128
def ProgressBar(to_file=None, **kwargs):
129
"""Abstract factory"""
132
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
133
# An value of '' or not set reverts to standard processing
134
if requested_bar_type in (None, ''):
135
if _supports_progress(to_file):
136
return TTYProgressBar(to_file=to_file, **kwargs)
138
return DummyProgress(to_file=to_file, **kwargs)
140
# Minor sanitation to prevent spurious errors
141
requested_bar_type = requested_bar_type.lower().strip()
142
# TODO: jam 20060710 Arguably we shouldn't raise an exception
143
# but should instead just disable progress bars if we
144
# don't recognize the type
145
if requested_bar_type not in _progress_bar_types:
146
raise errors.InvalidProgressBarType(requested_bar_type,
147
_progress_bar_types.keys())
148
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
151
class ProgressBarStack(object):
152
"""A stack of progress bars."""
161
to_messages_file=None,
163
"""Setup the stack with the parameters the progress bars should have."""
166
if to_messages_file is None:
167
to_messages_file = sys.stdout
168
self._to_file = to_file
169
self._show_pct = show_pct
170
self._show_spinner = show_spinner
171
self._show_eta = show_eta
172
self._show_bar = show_bar
173
self._show_count = show_count
174
self._to_messages_file = to_messages_file
176
self._klass = klass or ProgressBar
179
if len(self._stack) != 0:
180
return self._stack[-1]
185
if len(self._stack) != 0:
186
return self._stack[0]
190
def get_nested(self):
191
"""Return a nested progress bar."""
192
if len(self._stack) == 0:
195
func = self.top().child_progress
196
new_bar = func(to_file=self._to_file,
197
show_pct=self._show_pct,
198
show_spinner=self._show_spinner,
199
show_eta=self._show_eta,
200
show_bar=self._show_bar,
201
show_count=self._show_count,
202
to_messages_file=self._to_messages_file,
204
self._stack.append(new_bar)
207
def return_pb(self, bar):
208
"""Return bar after its been used."""
209
if bar is not self._stack[-1]:
210
warnings.warn("%r is not currently active" % (bar,))
215
class _BaseProgressBar(object):
224
to_messages_file=None,
226
object.__init__(self)
229
if to_messages_file is None:
230
to_messages_file = sys.stdout
231
self.to_file = to_file
232
self.to_messages_file = to_messages_file
235
self.last_total = None
236
self.show_pct = show_pct
237
self.show_spinner = show_spinner
238
self.show_eta = show_eta
239
self.show_bar = show_bar
240
self.show_count = show_count
243
self.MIN_PAUSE = 0.1 # seconds
246
self.start_time = now
247
# next update should not throttle
248
self.last_update = now - self.MIN_PAUSE - 1
251
"""Return this bar to its progress stack."""
253
self._stack.return_pb(self)
255
def note(self, fmt_string, *args, **kwargs):
256
"""Record a note without disrupting the progress bar."""
258
self.to_messages_file.write(fmt_string % args)
259
self.to_messages_file.write('\n')
261
def child_progress(self, **kwargs):
262
return ChildProgress(**kwargs)
265
class DummyProgress(_BaseProgressBar):
266
"""Progress-bar standin that does nothing.
268
This can be used as the default argument for methods that
269
take an optional progress indicator."""
274
def update(self, msg=None, current=None, total=None):
277
def child_update(self, message, current, total):
283
def note(self, fmt_string, *args, **kwargs):
284
"""See _BaseProgressBar.note()."""
286
def child_progress(self, **kwargs):
287
return DummyProgress(**kwargs)
290
class DotsProgressBar(_BaseProgressBar):
292
def __init__(self, **kwargs):
293
_BaseProgressBar.__init__(self, **kwargs)
300
def update(self, msg=None, current_cnt=None, total_cnt=None):
301
if msg and msg != self.last_msg:
303
self.to_file.write('\n')
304
self.to_file.write(msg + ': ')
307
self.to_file.write('.')
311
self.to_file.write('\n')
314
def child_update(self, message, current, total):
320
class TTYProgressBar(_BaseProgressBar):
321
"""Progress bar display object.
323
Several options are available to control the display. These can
324
be passed as parameters to the constructor or assigned at any time:
327
Show percentage complete.
329
Show rotating baton. This ticks over on every update even
330
if the values don't change.
332
Show predicted time-to-completion.
336
Show numerical counts.
338
The output file should be in line-buffered or unbuffered mode.
343
def __init__(self, **kwargs):
344
from bzrlib.osutils import terminal_width
345
_BaseProgressBar.__init__(self, **kwargs)
347
self.width = terminal_width()
348
self.last_updates = []
349
self._max_last_updates = 10
350
self.child_fraction = 0
351
self._have_output = False
353
def throttle(self, old_msg):
354
"""Return True if the bar was updated too recently"""
355
# time.time consistently takes 40/4000 ms = 0.01 ms.
356
# time.clock() is faster, but gives us CPU time, not wall-clock time
358
if self.start_time is not None and (now - self.start_time) < 1:
360
if old_msg != self.last_msg:
362
interval = now - self.last_update
364
if interval < self.MIN_PAUSE:
367
self.last_updates.append(now - self.last_update)
368
# Don't let the queue grow without bound
369
self.last_updates = self.last_updates[-self._max_last_updates:]
370
self.last_update = now
374
self.update(self.last_msg, self.last_cnt, self.last_total,
377
def child_update(self, message, current, total):
378
if current is not None and total != 0:
379
child_fraction = float(current) / total
380
if self.last_cnt is None:
382
elif self.last_cnt + child_fraction <= self.last_total:
383
self.child_fraction = child_fraction
384
if self.last_msg is None:
388
def update(self, msg, current_cnt=None, total_cnt=None,
390
"""Update and redraw progress bar.
395
if total_cnt is None:
396
total_cnt = self.last_total
401
if current_cnt > total_cnt:
402
total_cnt = current_cnt
404
## # optional corner case optimisation
405
## # currently does not seem to fire so costs more than saved.
406
## # trivial optimal case:
407
## # NB if callers are doing a clear and restore with
408
## # the saved values, this will prevent that:
409
## # in that case add a restore method that calls
410
## # _do_update or some such
411
## if (self.last_msg == msg and
412
## self.last_cnt == current_cnt and
413
## self.last_total == total_cnt and
414
## self.child_fraction == child_fraction):
420
old_msg = self.last_msg
421
# save these for the tick() function
423
self.last_cnt = current_cnt
424
self.last_total = total_cnt
425
self.child_fraction = child_fraction
427
# each function call takes 20ms/4000 = 0.005 ms,
428
# but multiple that by 4000 calls -> starts to cost.
429
# so anything to make this function call faster
430
# will improve base 'diff' time by up to 0.1 seconds.
431
if self.throttle(old_msg):
434
if self.show_eta and self.start_time and self.last_total:
435
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
436
self.last_total, last_updates = self.last_updates)
437
eta_str = " " + str_tdelta(eta)
441
if self.show_spinner:
442
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
446
# always update this; it's also used for the bar
449
if self.show_pct and self.last_total and self.last_cnt:
450
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
451
pct_str = ' (%5.1f%%)' % pct
455
if not self.show_count:
457
elif self.last_cnt is None:
459
elif self.last_total is None:
460
count_str = ' %i' % (self.last_cnt)
462
# make both fields the same size
463
t = '%i' % (self.last_total)
464
c = '%*i' % (len(t), self.last_cnt)
465
count_str = ' ' + c + '/' + t
468
# progress bar, if present, soaks up all remaining space
469
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
470
- len(eta_str) - len(count_str) - 3
473
# number of markers highlighted in bar
474
markers = int(round(float(cols) *
475
(self.last_cnt + self.child_fraction) / self.last_total))
476
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
478
# don't know total, so can't show completion.
479
# so just show an expanded spinning thingy
480
m = self.spin_pos % cols
481
ms = (' ' * m + '*').ljust(cols)
483
bar_str = '[' + ms + '] '
489
m = spin_str + bar_str + self.last_msg + count_str \
491
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
492
self._have_output = True
493
#self.to_file.flush()
496
if self._have_output:
497
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
498
self._have_output = False
499
#self.to_file.flush()
504
class ChildProgress(_BaseProgressBar):
505
"""A progress indicator that pushes its data to the parent"""
507
def __init__(self, _stack, **kwargs):
508
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
509
self.parent = _stack.top()
512
self.child_fraction = 0
515
def update(self, msg, current_cnt=None, total_cnt=None):
516
self.current = current_cnt
517
if total_cnt is not None:
518
self.total = total_cnt
520
self.child_fraction = 0
523
def child_update(self, message, current, total):
524
if current is None or total == 0:
525
self.child_fraction = 0
527
self.child_fraction = float(current) / total
531
if self.current is None:
534
count = self.current+self.child_fraction
535
if count > self.total:
537
mutter('clamping count of %d to %d' % (count, self.total))
539
self.parent.child_update(self.message, count, self.total)
544
def note(self, *args, **kwargs):
545
self.parent.note(*args, **kwargs)
548
class InstrumentedProgress(TTYProgressBar):
549
"""TTYProgress variant that tracks outcomes"""
551
def __init__(self, *args, **kwargs):
552
self.always_throttled = True
553
self.never_throttle = False
554
TTYProgressBar.__init__(self, *args, **kwargs)
556
def throttle(self, old_message):
557
if self.never_throttle:
560
result = TTYProgressBar.throttle(self, old_message)
562
self.always_throttled = False
565
def str_tdelta(delt):
568
delt = int(round(delt))
569
return '%d:%02d:%02d' % (delt/3600,
574
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
575
if start_time is None:
581
if current < enough_samples:
587
elapsed = time.time() - start_time
589
if elapsed < 2.0: # not enough time to estimate
592
total_duration = float(elapsed) * float(total) / float(current)
594
if last_updates and len(last_updates) >= n_recent:
595
avg = sum(last_updates) / float(len(last_updates))
596
time_left = avg * (total - current)
598
old_time_left = total_duration - elapsed
600
# We could return the average, or some other value here
601
return (time_left + old_time_left) / 2
603
return total_duration - elapsed
606
class ProgressPhase(object):
607
"""Update progress object with the current phase"""
608
def __init__(self, message, total, pb):
609
object.__init__(self)
611
self.message = message
613
self.cur_phase = None
615
def next_phase(self):
616
if self.cur_phase is None:
620
self.pb.update(self.message, self.cur_phase, self.total)
623
_progress_bar_types = {}
624
_progress_bar_types['dummy'] = DummyProgress
625
_progress_bar_types['none'] = DummyProgress
626
_progress_bar_types['tty'] = TTYProgressBar
627
_progress_bar_types['dots'] = DotsProgressBar
added
removed
bzrlib/progress.py
