13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19
"""Progress indicators.
20
21
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
21
will manage a conceptual stack of nested activities.
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
30
from bzrlib.symbol_versioning import (
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
45
from bzrlib.trace import mutter
36
48
def _supports_progress(f):
37
"""Detect if we can use pretty progress bars on file F.
49
"""Detect if we can use pretty progress bars on the output stream f.
39
If this returns true we expect that a human may be looking at that
51
If this returns true we expect that a human may be looking at that
40
52
output, and that we can repaint a line to update it.
42
This doesn't check the policy for whether we *should* use them.
44
54
isatty = getattr(f, 'isatty', None)
49
# The following case also handles Win32 - on that platform $TERM is
50
# typically never set, so the case None is treated as a smart terminal,
51
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
52
# isatty methods that return true.
53
59
if os.environ.get('TERM') == 'dumb':
54
60
# e.g. emacs compile window
59
class ProgressTask(object):
60
"""Model component of a progress indicator.
62
Most code that needs to indicate progress should update one of these,
63
and it will in turn update the display, if one is present.
65
Code updating the task may also set fields as hints about how to display
66
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
67
will not necessarily respect all these fields.
69
:ivar update_latency: The interval (in seconds) at which the PB should be
70
updated. Setting this to zero suggests every update should be shown
73
:ivar show_transport_activity: If true (default), transport activity
74
will be shown when this task is drawn. Disable it if you're sure
75
that only irrelevant or uninteresting transport activity can occur
79
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
80
"""Construct a new progress task.
82
:param parent_task: Enclosing ProgressTask or None.
84
:param progress_view: ProgressView to display this ProgressTask.
86
:param ui_factory: The UI factory that will display updates;
87
deprecated in favor of passing progress_view directly.
89
Normally you should not call this directly but rather through
90
`ui_factory.nested_progress_bar`.
92
self._parent_task = parent_task
95
self.current_cnt = None
97
# TODO: deprecate passing ui_factory
98
self.ui_factory = ui_factory
99
self.progress_view = progress_view
100
self.show_pct = False
101
self.show_spinner = True
102
self.show_eta = False,
103
self.show_count = True
105
self.update_latency = 0.1
106
self.show_transport_activity = True
109
return '%s(%r/%r, msg=%r)' % (
110
self.__class__.__name__,
115
def update(self, msg, current_cnt=None, total_cnt=None):
117
self.current_cnt = current_cnt
119
self.total_cnt = total_cnt
120
if self.progress_view:
121
self.progress_view.show_progress(self)
123
self.ui_factory._progress_updated(self)
126
self.update(self.msg)
129
if self.progress_view:
130
self.progress_view.task_finished(self)
132
self.ui_factory._progress_finished(self)
134
def make_sub_task(self):
135
return ProgressTask(self, ui_factory=self.ui_factory,
136
progress_view=self.progress_view)
138
def _overall_completion_fraction(self, child_fraction=0.0):
139
"""Return fractional completion of this task and its parents
141
Returns None if no completion can be computed."""
142
if self.current_cnt is not None and self.total_cnt:
143
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
145
# if this task has no estimation, it just passes on directly
146
# whatever the child has measured...
147
own_fraction = child_fraction
148
if self._parent_task is None:
151
if own_fraction is None:
153
return self._parent_task._overall_completion_fraction(own_fraction)
155
@deprecated_method(deprecated_in((2, 1, 0)))
156
def note(self, fmt_string, *args):
157
"""Record a note without disrupting the progress bar.
159
Deprecated: use ui_factory.note() instead or bzrlib.trace. Note that
160
ui_factory.note takes just one string as the argument, not a format
161
string and arguments.
164
self.ui_factory.note(fmt_string % args)
166
self.ui_factory.note(fmt_string)
169
# TODO: deprecate this method; the model object shouldn't be concerned
170
# with whether it's shown or not. Most callers use this because they
171
# want to write some different non-progress output to the screen, but
172
# they should probably instead use a stream that's synchronized with
173
# the progress output. It may be there is a model-level use for
174
# saying "this task's not active at the moment" but I don't see it. --
176
if self.progress_view:
177
self.progress_view.clear()
179
self.ui_factory.clear_term()
182
# NOTE: This is also deprecated; you should provide a ProgressView instead.
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()
183
154
class _BaseProgressBar(object):
185
156
def __init__(self,
255
226
return DummyProgress(**kwargs)
229
_progress_bar_types['dummy'] = DummyProgress
230
_progress_bar_types['none'] = DummyProgress
233
class DotsProgressBar(_BaseProgressBar):
235
def __init__(self, **kwargs):
236
_BaseProgressBar.__init__(self, **kwargs)
243
def update(self, msg=None, current_cnt=None, total_cnt=None):
244
if msg and msg != self.last_msg:
246
self.to_file.write('\n')
247
self.to_file.write(msg + ': ')
250
self.to_file.write('.')
254
self.to_file.write('\n')
257
def child_update(self, message, current, total):
261
_progress_bar_types['dots'] = DotsProgressBar
264
class TTYProgressBar(_BaseProgressBar):
265
"""Progress bar display object.
267
Several options are available to control the display. These can
268
be passed as parameters to the constructor or assigned at any time:
271
Show percentage complete.
273
Show rotating baton. This ticks over on every update even
274
if the values don't change.
276
Show predicted time-to-completion.
280
Show numerical counts.
282
The output file should be in line-buffered or unbuffered mode.
287
def __init__(self, **kwargs):
288
from bzrlib.osutils import terminal_width
289
_BaseProgressBar.__init__(self, **kwargs)
291
self.width = terminal_width()
292
self.last_updates = []
293
self._max_last_updates = 10
294
self.child_fraction = 0
295
self._have_output = False
297
def throttle(self, old_msg):
298
"""Return True if the bar was updated too recently"""
299
# time.time consistently takes 40/4000 ms = 0.01 ms.
300
# time.clock() is faster, but gives us CPU time, not wall-clock time
302
if self.start_time is not None and (now - self.start_time) < 1:
304
if old_msg != self.last_msg:
306
interval = now - self.last_update
308
if interval < self.MIN_PAUSE:
311
self.last_updates.append(now - self.last_update)
312
# Don't let the queue grow without bound
313
self.last_updates = self.last_updates[-self._max_last_updates:]
314
self.last_update = now
318
self.update(self.last_msg, self.last_cnt, self.last_total,
321
def child_update(self, message, current, total):
322
if current is not None and total != 0:
323
child_fraction = float(current) / total
324
if self.last_cnt is None:
326
elif self.last_cnt + child_fraction <= self.last_total:
327
self.child_fraction = child_fraction
328
if self.last_msg is None:
332
def update(self, msg, current_cnt=None, total_cnt=None,
334
"""Update and redraw progress bar."""
338
if total_cnt is None:
339
total_cnt = self.last_total
344
if current_cnt > total_cnt:
345
total_cnt = current_cnt
347
## # optional corner case optimisation
348
## # currently does not seem to fire so costs more than saved.
349
## # trivial optimal case:
350
## # NB if callers are doing a clear and restore with
351
## # the saved values, this will prevent that:
352
## # in that case add a restore method that calls
353
## # _do_update or some such
354
## if (self.last_msg == msg and
355
## self.last_cnt == current_cnt and
356
## self.last_total == total_cnt and
357
## self.child_fraction == child_fraction):
360
old_msg = self.last_msg
361
# save these for the tick() function
363
self.last_cnt = current_cnt
364
self.last_total = total_cnt
365
self.child_fraction = child_fraction
367
# each function call takes 20ms/4000 = 0.005 ms,
368
# but multiple that by 4000 calls -> starts to cost.
369
# so anything to make this function call faster
370
# will improve base 'diff' time by up to 0.1 seconds.
371
if self.throttle(old_msg):
374
if self.show_eta and self.start_time and self.last_total:
375
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
376
self.last_total, last_updates = self.last_updates)
377
eta_str = " " + str_tdelta(eta)
381
if self.show_spinner:
382
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
386
# always update this; it's also used for the bar
389
if self.show_pct and self.last_total and self.last_cnt:
390
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
391
pct_str = ' (%5.1f%%)' % pct
395
if not self.show_count:
397
elif self.last_cnt is None:
399
elif self.last_total is None:
400
count_str = ' %i' % (self.last_cnt)
402
# make both fields the same size
403
t = '%i' % (self.last_total)
404
c = '%*i' % (len(t), self.last_cnt)
405
count_str = ' ' + c + '/' + t
408
# progress bar, if present, soaks up all remaining space
409
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
410
- len(eta_str) - len(count_str) - 3
413
# number of markers highlighted in bar
414
markers = int(round(float(cols) *
415
(self.last_cnt + self.child_fraction) / self.last_total))
416
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
418
# don't know total, so can't show completion.
419
# so just show an expanded spinning thingy
420
m = self.spin_pos % cols
421
ms = (' ' * m + '*').ljust(cols)
423
bar_str = '[' + ms + '] '
429
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
430
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
431
self._have_output = True
432
#self.to_file.flush()
435
if self._have_output:
436
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
437
self._have_output = False
438
#self.to_file.flush()
441
_progress_bar_types['tty'] = TTYProgressBar
444
class ChildProgress(_BaseProgressBar):
445
"""A progress indicator that pushes its data to the parent"""
447
def __init__(self, _stack, **kwargs):
448
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
449
self.parent = _stack.top()
452
self.child_fraction = 0
455
def update(self, msg, current_cnt=None, total_cnt=None):
456
self.current = current_cnt
457
if total_cnt is not None:
458
self.total = total_cnt
460
self.child_fraction = 0
463
def child_update(self, message, current, total):
464
if current is None or total == 0:
465
self.child_fraction = 0
467
self.child_fraction = float(current) / total
471
if self.current is None:
474
count = self.current+self.child_fraction
475
if count > self.total:
477
mutter('clamping count of %d to %d' % (count, self.total))
479
self.parent.child_update(self.message, count, self.total)
484
def note(self, *args, **kwargs):
485
self.parent.note(*args, **kwargs)
488
class InstrumentedProgress(TTYProgressBar):
489
"""TTYProgress variant that tracks outcomes"""
491
def __init__(self, *args, **kwargs):
492
self.always_throttled = True
493
self.never_throttle = False
494
TTYProgressBar.__init__(self, *args, **kwargs)
496
def throttle(self, old_message):
497
if self.never_throttle:
500
result = TTYProgressBar.throttle(self, old_message)
502
self.always_throttled = False
258
505
def str_tdelta(delt):
added
removed
bzrlib/progress.py
