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
122
self.ui_factory.note(fmt_string % args)
124
self.ui_factory.note(fmt_string)
127
# XXX: shouldn't be here; put it in mutter or the ui instead
128
self.ui_factory.clear_term()
131
def ProgressBar(to_file=None, **kwargs):
132
"""Abstract factory"""
135
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
136
# An value of '' or not set reverts to standard processing
137
if requested_bar_type in (None, ''):
138
if _supports_progress(to_file):
139
return TTYProgressBar(to_file=to_file, **kwargs)
141
return DummyProgress(to_file=to_file, **kwargs)
143
# Minor sanitation to prevent spurious errors
144
requested_bar_type = requested_bar_type.lower().strip()
145
# TODO: jam 20060710 Arguably we shouldn't raise an exception
146
# but should instead just disable progress bars if we
147
# don't recognize the type
148
if requested_bar_type not in _progress_bar_types:
149
raise errors.InvalidProgressBarType(requested_bar_type,
150
_progress_bar_types.keys())
151
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
154
class ProgressBarStack(object):
155
"""A stack of progress bars."""
164
to_messages_file=None,
166
"""Setup the stack with the parameters the progress bars should have."""
169
if to_messages_file is None:
170
to_messages_file = sys.stdout
171
self._to_file = to_file
172
self._show_pct = show_pct
173
self._show_spinner = show_spinner
174
self._show_eta = show_eta
175
self._show_bar = show_bar
176
self._show_count = show_count
177
self._to_messages_file = to_messages_file
179
self._klass = klass or ProgressBar
182
if len(self._stack) != 0:
183
return self._stack[-1]
188
if len(self._stack) != 0:
189
return self._stack[0]
193
def get_nested(self):
194
"""Return a nested progress bar."""
195
if len(self._stack) == 0:
198
func = self.top().child_progress
199
new_bar = func(to_file=self._to_file,
200
show_pct=self._show_pct,
201
show_spinner=self._show_spinner,
202
show_eta=self._show_eta,
203
show_bar=self._show_bar,
204
show_count=self._show_count,
205
to_messages_file=self._to_messages_file,
207
self._stack.append(new_bar)
210
def return_pb(self, bar):
211
"""Return bar after its been used."""
212
if bar is not self._stack[-1]:
213
warnings.warn("%r is not currently active" % (bar,))
218
class _BaseProgressBar(object):
227
to_messages_file=None,
229
object.__init__(self)
232
if to_messages_file is None:
233
to_messages_file = sys.stdout
234
self.to_file = to_file
235
self.to_messages_file = to_messages_file
238
self.last_total = None
239
self.show_pct = show_pct
240
self.show_spinner = show_spinner
241
self.show_eta = show_eta
242
self.show_bar = show_bar
243
self.show_count = show_count
246
self.MIN_PAUSE = 0.1 # seconds
249
self.start_time = now
250
# next update should not throttle
251
self.last_update = now - self.MIN_PAUSE - 1
254
"""Return this bar to its progress stack."""
256
self._stack.return_pb(self)
258
def note(self, fmt_string, *args, **kwargs):
259
"""Record a note without disrupting the progress bar."""
261
self.to_messages_file.write(fmt_string % args)
262
self.to_messages_file.write('\n')
264
def child_progress(self, **kwargs):
265
return ChildProgress(**kwargs)
268
class DummyProgress(_BaseProgressBar):
269
"""Progress-bar standin that does nothing.
271
This can be used as the default argument for methods that
272
take an optional progress indicator."""
277
def update(self, msg=None, current=None, total=None):
280
def child_update(self, message, current, total):
286
def note(self, fmt_string, *args, **kwargs):
287
"""See _BaseProgressBar.note()."""
289
def child_progress(self, **kwargs):
290
return DummyProgress(**kwargs)
293
class DotsProgressBar(_BaseProgressBar):
295
def __init__(self, **kwargs):
296
_BaseProgressBar.__init__(self, **kwargs)
303
def update(self, msg=None, current_cnt=None, total_cnt=None):
304
if msg and msg != self.last_msg:
306
self.to_file.write('\n')
307
self.to_file.write(msg + ': ')
310
self.to_file.write('.')
314
self.to_file.write('\n')
317
def child_update(self, message, current, total):
323
class TTYProgressBar(_BaseProgressBar):
324
"""Progress bar display object.
326
Several options are available to control the display. These can
327
be passed as parameters to the constructor or assigned at any time:
330
Show percentage complete.
332
Show rotating baton. This ticks over on every update even
333
if the values don't change.
335
Show predicted time-to-completion.
339
Show numerical counts.
341
The output file should be in line-buffered or unbuffered mode.
346
def __init__(self, **kwargs):
347
from bzrlib.osutils import terminal_width
348
_BaseProgressBar.__init__(self, **kwargs)
350
self.width = terminal_width()
351
self.last_updates = []
352
self._max_last_updates = 10
353
self.child_fraction = 0
354
self._have_output = False
356
def throttle(self, old_msg):
357
"""Return True if the bar was updated too recently"""
358
# time.time consistently takes 40/4000 ms = 0.01 ms.
359
# time.clock() is faster, but gives us CPU time, not wall-clock time
361
if self.start_time is not None and (now - self.start_time) < 1:
363
if old_msg != self.last_msg:
365
interval = now - self.last_update
367
if interval < self.MIN_PAUSE:
370
self.last_updates.append(now - self.last_update)
371
# Don't let the queue grow without bound
372
self.last_updates = self.last_updates[-self._max_last_updates:]
373
self.last_update = now
377
self.update(self.last_msg, self.last_cnt, self.last_total,
380
def child_update(self, message, current, total):
381
if current is not None and total != 0:
382
child_fraction = float(current) / total
383
if self.last_cnt is None:
385
elif self.last_cnt + child_fraction <= self.last_total:
386
self.child_fraction = child_fraction
387
if self.last_msg is None:
391
def update(self, msg, current_cnt=None, total_cnt=None,
393
"""Update and redraw progress bar.
398
if total_cnt is None:
399
total_cnt = self.last_total
404
if current_cnt > total_cnt:
405
total_cnt = current_cnt
407
## # optional corner case optimisation
408
## # currently does not seem to fire so costs more than saved.
409
## # trivial optimal case:
410
## # NB if callers are doing a clear and restore with
411
## # the saved values, this will prevent that:
412
## # in that case add a restore method that calls
413
## # _do_update or some such
414
## if (self.last_msg == msg and
415
## self.last_cnt == current_cnt and
416
## self.last_total == total_cnt and
417
## self.child_fraction == child_fraction):
423
old_msg = self.last_msg
424
# save these for the tick() function
426
self.last_cnt = current_cnt
427
self.last_total = total_cnt
428
self.child_fraction = child_fraction
430
# each function call takes 20ms/4000 = 0.005 ms,
431
# but multiple that by 4000 calls -> starts to cost.
432
# so anything to make this function call faster
433
# will improve base 'diff' time by up to 0.1 seconds.
434
if self.throttle(old_msg):
437
if self.show_eta and self.start_time and self.last_total:
438
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
439
self.last_total, last_updates = self.last_updates)
440
eta_str = " " + str_tdelta(eta)
444
if self.show_spinner:
445
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
449
# always update this; it's also used for the bar
452
if self.show_pct and self.last_total and self.last_cnt:
453
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
454
pct_str = ' (%5.1f%%)' % pct
458
if not self.show_count:
460
elif self.last_cnt is None:
462
elif self.last_total is None:
463
count_str = ' %i' % (self.last_cnt)
465
# make both fields the same size
466
t = '%i' % (self.last_total)
467
c = '%*i' % (len(t), self.last_cnt)
468
count_str = ' ' + c + '/' + t
471
# progress bar, if present, soaks up all remaining space
472
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
473
- len(eta_str) - len(count_str) - 3
476
# number of markers highlighted in bar
477
markers = int(round(float(cols) *
478
(self.last_cnt + self.child_fraction) / self.last_total))
479
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
481
# don't know total, so can't show completion.
482
# so just show an expanded spinning thingy
483
m = self.spin_pos % cols
484
ms = (' ' * m + '*').ljust(cols)
486
bar_str = '[' + ms + '] '
492
m = spin_str + bar_str + self.last_msg + count_str \
494
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
495
self._have_output = True
496
#self.to_file.flush()
499
if self._have_output:
500
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
501
self._have_output = False
502
#self.to_file.flush()
507
class ChildProgress(_BaseProgressBar):
508
"""A progress indicator that pushes its data to the parent"""
510
def __init__(self, _stack, **kwargs):
511
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
512
self.parent = _stack.top()
515
self.child_fraction = 0
518
def update(self, msg, current_cnt=None, total_cnt=None):
519
self.current = current_cnt
520
if total_cnt is not None:
521
self.total = total_cnt
523
self.child_fraction = 0
526
def child_update(self, message, current, total):
527
if current is None or total == 0:
528
self.child_fraction = 0
530
self.child_fraction = float(current) / total
534
if self.current is None:
537
count = self.current+self.child_fraction
538
if count > self.total:
540
mutter('clamping count of %d to %d' % (count, self.total))
542
self.parent.child_update(self.message, count, self.total)
547
def note(self, *args, **kwargs):
548
self.parent.note(*args, **kwargs)
551
class InstrumentedProgress(TTYProgressBar):
552
"""TTYProgress variant that tracks outcomes"""
554
def __init__(self, *args, **kwargs):
555
self.always_throttled = True
556
self.never_throttle = False
557
TTYProgressBar.__init__(self, *args, **kwargs)
559
def throttle(self, old_message):
560
if self.never_throttle:
563
result = TTYProgressBar.throttle(self, old_message)
565
self.always_throttled = False
568
def str_tdelta(delt):
571
delt = int(round(delt))
572
return '%d:%02d:%02d' % (delt/3600,
577
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
578
if start_time is None:
584
if current < enough_samples:
590
elapsed = time.time() - start_time
592
if elapsed < 2.0: # not enough time to estimate
595
total_duration = float(elapsed) * float(total) / float(current)
597
if last_updates and len(last_updates) >= n_recent:
598
avg = sum(last_updates) / float(len(last_updates))
599
time_left = avg * (total - current)
601
old_time_left = total_duration - elapsed
603
# We could return the average, or some other value here
604
return (time_left + old_time_left) / 2
606
return total_duration - elapsed
609
class ProgressPhase(object):
610
"""Update progress object with the current phase"""
611
def __init__(self, message, total, pb):
612
object.__init__(self)
614
self.message = message
616
self.cur_phase = None
618
def next_phase(self):
619
if self.cur_phase is None:
623
self.pb.update(self.message, self.cur_phase, self.total)
626
_progress_bar_types = {}
627
_progress_bar_types['dummy'] = DummyProgress
628
_progress_bar_types['none'] = DummyProgress
629
_progress_bar_types['tty'] = TTYProgressBar
630
_progress_bar_types['dots'] = DotsProgressBar
added
removed
bzrlib/progress.py
