1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 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
19
"""Simple text-mode progress indicator.
21
To display an indicator, create a ProgressBar object. Call it,
22
passing Progress objects indicating the current state. When done,
25
Progress is suppressed when output is not sent to a terminal, so as
26
not to clutter log files.
1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Progress indicators.
20
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.
29
# TODO: should be a global option e.g. --silent that disables progress
30
# indicators, preferably without needing to adjust all code that
31
# potentially calls them.
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
# when the rate is unpredictable
43
import bzrlib.errors as errors
44
from bzrlib.trace import mutter
30
from bzrlib.symbol_versioning import (
47
36
def _supports_progress(f):
37
"""Detect if we can use pretty progress bars on file F.
39
If this returns true we expect that a human may be looking at that
40
output, and that we can repaint a line to update it.
42
This doesn't check the policy for whether we *should* use them.
48
44
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
53
if os.environ.get('TERM') == 'dumb':
54
54
# e.g. emacs compile window
59
_progress_bar_types = {}
62
def ProgressBar(to_file=None, **kwargs):
63
"""Abstract factory"""
66
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
67
# An value of '' or not set reverts to standard processing
68
if requested_bar_type in (None, ''):
69
if _supports_progress(to_file):
70
return TTYProgressBar(to_file=to_file, **kwargs)
72
return DotsProgressBar(to_file=to_file, **kwargs)
74
# Minor sanitation to prevent spurious errors
75
requested_bar_type = requested_bar_type.lower().strip()
76
# TODO: jam 20060710 Arguably we shouldn't raise an exception
77
# but should instead just disable progress bars if we
78
# don't recognize the type
79
if requested_bar_type not in _progress_bar_types:
80
raise errors.InvalidProgressBarType(requested_bar_type,
81
_progress_bar_types.keys())
82
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
85
class ProgressBarStack(object):
86
"""A stack of progress bars."""
95
to_messages_file=None,
97
"""Setup the stack with the parameters the progress bars should have."""
100
if to_messages_file is None:
101
to_messages_file = sys.stdout
102
self._to_file = to_file
103
self._show_pct = show_pct
104
self._show_spinner = show_spinner
105
self._show_eta = show_eta
106
self._show_bar = show_bar
107
self._show_count = show_count
108
self._to_messages_file = to_messages_file
110
self._klass = klass or ProgressBar
113
if len(self._stack) != 0:
114
return self._stack[-1]
119
if len(self._stack) != 0:
120
return self._stack[0]
124
def get_nested(self):
125
"""Return a nested progress bar."""
126
if len(self._stack) == 0:
129
func = self.top().child_progress
130
new_bar = func(to_file=self._to_file,
131
show_pct=self._show_pct,
132
show_spinner=self._show_spinner,
133
show_eta=self._show_eta,
134
show_bar=self._show_bar,
135
show_count=self._show_count,
136
to_messages_file=self._to_messages_file,
138
self._stack.append(new_bar)
141
def return_pb(self, bar):
142
"""Return bar after its been used."""
143
if bar is not self._stack[-1]:
144
raise errors.MissingProgressBarFinish()
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.
148
183
class _BaseProgressBar(object):
150
185
def __init__(self,
220
255
return DummyProgress(**kwargs)
223
_progress_bar_types['dummy'] = DummyProgress
224
_progress_bar_types['none'] = DummyProgress
227
class DotsProgressBar(_BaseProgressBar):
229
def __init__(self, **kwargs):
230
_BaseProgressBar.__init__(self, **kwargs)
237
def update(self, msg=None, current_cnt=None, total_cnt=None):
238
if msg and msg != self.last_msg:
240
self.to_file.write('\n')
241
self.to_file.write(msg + ': ')
244
self.to_file.write('.')
248
self.to_file.write('\n')
251
def child_update(self, message, current, total):
255
_progress_bar_types['dots'] = DotsProgressBar
258
class TTYProgressBar(_BaseProgressBar):
259
"""Progress bar display object.
261
Several options are available to control the display. These can
262
be passed as parameters to the constructor or assigned at any time:
265
Show percentage complete.
267
Show rotating baton. This ticks over on every update even
268
if the values don't change.
270
Show predicted time-to-completion.
274
Show numerical counts.
276
The output file should be in line-buffered or unbuffered mode.
281
def __init__(self, **kwargs):
282
from bzrlib.osutils import terminal_width
283
_BaseProgressBar.__init__(self, **kwargs)
285
self.width = terminal_width()
286
self.last_updates = []
287
self._max_last_updates = 10
288
self.child_fraction = 0
289
self._have_output = False
292
def throttle(self, old_msg):
293
"""Return True if the bar was updated too recently"""
294
# time.time consistently takes 40/4000 ms = 0.01 ms.
295
# but every single update to the pb invokes it.
296
# so we use time.clock which takes 20/4000 ms = 0.005ms
297
# on the downside, time.clock() appears to have approximately
298
# 10ms granularity, so we treat a zero-time change as 'throttled.'
300
if self.start_time is not None and (now - self.start_time) < 1:
302
if old_msg != self.last_msg:
304
interval = now - self.last_update
306
if interval < self.MIN_PAUSE:
309
self.last_updates.append(now - self.last_update)
310
# Don't let the queue grow without bound
311
self.last_updates = self.last_updates[-self._max_last_updates:]
312
self.last_update = now
316
self.update(self.last_msg, self.last_cnt, self.last_total,
319
def child_update(self, message, current, total):
320
if current is not None and total != 0:
321
child_fraction = float(current) / total
322
if self.last_cnt is None:
324
elif self.last_cnt + child_fraction <= self.last_total:
325
self.child_fraction = child_fraction
327
mutter('not updating 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
431
assert len(m) < self.width
432
self.to_file.write('\r' + m.ljust(self.width - 1))
433
self._have_output = True
434
#self.to_file.flush()
437
if self._have_output:
438
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
439
self._have_output = False
440
#self.to_file.flush()
443
_progress_bar_types['tty'] = TTYProgressBar
446
class ChildProgress(_BaseProgressBar):
447
"""A progress indicator that pushes its data to the parent"""
449
def __init__(self, _stack, **kwargs):
450
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
451
self.parent = _stack.top()
454
self.child_fraction = 0
457
def update(self, msg, current_cnt=None, total_cnt=None):
458
self.current = current_cnt
459
self.total = total_cnt
461
self.child_fraction = 0
464
def child_update(self, message, current, total):
465
if current is None or total == 0:
466
self.child_fraction = 0
468
self.child_fraction = float(current) / total
472
if self.current is None:
475
count = self.current+self.child_fraction
476
if count > self.total:
478
mutter('clamping count of %d to %d' % (count, self.total))
480
self.parent.child_update(self.message, count, self.total)
485
def note(self, *args, **kwargs):
486
self.parent.note(*args, **kwargs)
489
258
def str_tdelta(delt):
added
removed
bzrlib/progress.py
