1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
18
"""Progress indicators.
21
20
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.
21
will manage a conceptual stack of nested activities.
31
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
32
# when the rate is unpredictable
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
40
31
from bzrlib import (
45
37
from bzrlib.trace import mutter
38
from bzrlib.symbol_versioning import (
45
# XXX: deprecated; can be removed when the ProgressBar factory is removed
48
46
def _supports_progress(f):
49
47
"""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
49
If this returns true we expect that a human may be looking at that
52
50
output, and that we can repaint a line to update it.
54
52
isatty = getattr(f, 'isatty', None)
65
_progress_bar_types = {}
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
"""Construct a new progress task.
77
Normally you should not call this directly but rather through
78
`ui_factory.nested_progress_bar`.
80
self._parent_task = parent_task
83
self.current_cnt = None
85
self.ui_factory = ui_factory
87
self.show_spinner = True
88
self.show_eta = False,
89
self.show_count = True
93
return '%s(%r/%r, msg=%r)' % (
94
self.__class__.__name__,
99
def update(self, msg, current_cnt=None, total_cnt=None):
101
self.current_cnt = current_cnt
103
self.total_cnt = total_cnt
104
self.ui_factory._progress_updated(self)
107
self.update(self.msg)
110
self.ui_factory._progress_finished(self)
112
def make_sub_task(self):
113
return ProgressTask(self, self.ui_factory)
115
def _overall_completion_fraction(self, child_fraction=0.0):
116
"""Return fractional completion of this task and its parents
118
Returns None if no completion can be computed."""
119
if self.current_cnt is not None and self.total_cnt:
120
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
122
# if this task has no estimation, it just passes on directly
123
# whatever the child has measured...
124
own_fraction = child_fraction
125
if self._parent_task is None:
128
if own_fraction is None:
130
return self._parent_task._overall_completion_fraction(own_fraction)
132
def note(self, fmt_string, *args):
133
"""Record a note without disrupting the progress bar."""
134
# XXX: shouldn't be here; put it in mutter or the ui instead
136
self.ui_factory.note(fmt_string % args)
138
self.ui_factory.note(fmt_string)
141
# XXX: shouldn't be here; put it in mutter or the ui instead
142
self.ui_factory.clear_term()
145
@deprecated_function(deprecated_in((1, 16, 0)))
68
146
def ProgressBar(to_file=None, **kwargs):
69
147
"""Abstract factory"""
70
148
if to_file is None:
87
165
_progress_bar_types.keys())
88
166
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
169
class _BaseProgressBar(object):
156
171
def __init__(self,
225
242
return DummyProgress(**kwargs)
228
_progress_bar_types['dummy'] = DummyProgress
229
_progress_bar_types['none'] = DummyProgress
232
245
class DotsProgressBar(_BaseProgressBar):
247
@deprecated_function(deprecated_in((1, 16, 0)))
234
248
def __init__(self, **kwargs):
235
249
_BaseProgressBar.__init__(self, **kwargs)
236
250
self.last_msg = None
237
251
self.need_nl = False
242
256
def update(self, msg=None, current_cnt=None, total_cnt=None):
243
257
if msg and msg != self.last_msg:
363
378
self.last_total = total_cnt
364
379
self.child_fraction = child_fraction
366
# each function call takes 20ms/4000 = 0.005 ms,
381
# each function call takes 20ms/4000 = 0.005 ms,
367
382
# but multiple that by 4000 calls -> starts to cost.
368
383
# so anything to make this function call faster
369
384
# will improve base 'diff' time by up to 0.1 seconds.
373
388
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,
389
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
375
390
self.last_total, last_updates = self.last_updates)
376
391
eta_str = " " + str_tdelta(eta)
380
395
if self.show_spinner:
381
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
396
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
401
416
# make both fields the same size
402
417
t = '%i' % (self.last_total)
403
418
c = '%*i' % (len(t), self.last_cnt)
404
count_str = ' ' + c + '/' + t
419
count_str = ' ' + c + '/' + t
406
421
if self.show_bar:
407
422
# progress bar, if present, soaks up all remaining space
418
433
# so just show an expanded spinning thingy
419
434
m = self.spin_pos % cols
420
435
ms = (' ' * m + '*').ljust(cols)
422
437
bar_str = '[' + ms + '] '
428
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
443
m = spin_str + bar_str + self.last_msg + count_str \
429
445
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
430
446
self._have_output = True
431
447
#self.to_file.flush()
434
450
if self._have_output:
435
451
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
436
452
self._have_output = False
437
#self.to_file.flush()
440
_progress_bar_types['tty'] = TTYProgressBar
453
#self.to_file.flush()
443
456
class ChildProgress(_BaseProgressBar):
444
457
"""A progress indicator that pushes its data to the parent"""
459
@deprecated_function(deprecated_in((1, 16, 0)))
446
460
def __init__(self, _stack, **kwargs):
447
461
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
448
462
self.parent = _stack.top()
484
498
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
501
def str_tdelta(delt):
added
removed
bzrlib/progress.py
