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
17
"""Progress indicators.
21
19
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.
20
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
23
from __future__ import absolute_import
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
45
from bzrlib.trace import mutter
48
29
def _supports_progress(f):
49
"""Detect if we can use pretty progress bars on the output stream f.
30
"""Detect if we can use pretty progress bars on file F.
51
If this returns true we expect that a human may be looking at that
32
If this returns true we expect that a human may be looking at that
52
33
output, and that we can repaint a line to update it.
35
This doesn't check the policy for whether we *should* use them.
54
37
isatty = getattr(f, 'isatty', None)
42
# The following case also handles Win32 - on that platform $TERM is
43
# typically never set, so the case None is treated as a smart terminal,
44
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
45
# isatty methods that return true.
59
46
if os.environ.get('TERM') == 'dumb':
60
47
# e.g. emacs compile window
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()
154
class _BaseProgressBar(object):
163
to_messages_file=None,
165
object.__init__(self)
168
if to_messages_file is None:
169
to_messages_file = sys.stdout
170
self.to_file = to_file
171
self.to_messages_file = to_messages_file
174
self.last_total = None
175
self.show_pct = show_pct
176
self.show_spinner = show_spinner
177
self.show_eta = show_eta
178
self.show_bar = show_bar
179
self.show_count = show_count
182
self.MIN_PAUSE = 0.1 # seconds
185
self.start_time = now
186
# next update should not throttle
187
self.last_update = now - self.MIN_PAUSE - 1
52
class ProgressTask(object):
53
"""Model component of a progress indicator.
55
Most code that needs to indicate progress should update one of these,
56
and it will in turn update the display, if one is present.
58
Code updating the task may also set fields as hints about how to display
59
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
60
will not necessarily respect all these fields.
62
The message given when updating a task must be unicode, not bytes.
64
:ivar update_latency: The interval (in seconds) at which the PB should be
65
updated. Setting this to zero suggests every update should be shown
68
:ivar show_transport_activity: If true (default), transport activity
69
will be shown when this task is drawn. Disable it if you're sure
70
that only irrelevant or uninteresting transport activity can occur
74
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
75
"""Construct a new progress task.
77
:param parent_task: Enclosing ProgressTask or None.
79
:param progress_view: ProgressView to display this ProgressTask.
81
:param ui_factory: The UI factory that will display updates;
82
deprecated in favor of passing progress_view directly.
84
Normally you should not call this directly but rather through
85
`ui_factory.nested_progress_bar`.
87
self._parent_task = parent_task
90
self.current_cnt = None
92
# TODO: deprecate passing ui_factory
93
self.ui_factory = ui_factory
94
self.progress_view = progress_view
96
self.show_spinner = True
97
self.show_eta = False,
98
self.show_count = True
100
self.update_latency = 0.1
101
self.show_transport_activity = True
104
return '%s(%r/%r, msg=%r)' % (
105
self.__class__.__name__,
110
def update(self, msg, current_cnt=None, total_cnt=None):
111
"""Report updated task message and if relevent progress counters
113
The message given must be unicode, not a byte string.
116
self.current_cnt = current_cnt
118
self.total_cnt = total_cnt
119
if self.progress_view:
120
self.progress_view.show_progress(self)
122
self.ui_factory._progress_updated(self)
125
self.update(self.msg)
189
127
def finished(self):
190
"""Return this bar to its progress stack."""
192
self._stack.return_pb(self)
194
def note(self, fmt_string, *args, **kwargs):
195
"""Record a note without disrupting the progress bar."""
197
self.to_messages_file.write(fmt_string % args)
198
self.to_messages_file.write('\n')
200
def child_progress(self, **kwargs):
201
return ChildProgress(**kwargs)
204
class DummyProgress(_BaseProgressBar):
128
if self.progress_view:
129
self.progress_view.task_finished(self)
131
self.ui_factory._progress_finished(self)
133
def make_sub_task(self):
134
return ProgressTask(self, ui_factory=self.ui_factory,
135
progress_view=self.progress_view)
137
def _overall_completion_fraction(self, child_fraction=0.0):
138
"""Return fractional completion of this task and its parents
140
Returns None if no completion can be computed."""
141
if self.current_cnt is not None and self.total_cnt:
142
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
144
# if this task has no estimation, it just passes on directly
145
# whatever the child has measured...
146
own_fraction = child_fraction
147
if self._parent_task is None:
150
if own_fraction is None:
152
return self._parent_task._overall_completion_fraction(own_fraction)
155
# TODO: deprecate this method; the model object shouldn't be concerned
156
# with whether it's shown or not. Most callers use this because they
157
# want to write some different non-progress output to the screen, but
158
# they should probably instead use a stream that's synchronized with
159
# the progress output. It may be there is a model-level use for
160
# saying "this task's not active at the moment" but I don't see it. --
162
if self.progress_view:
163
self.progress_view.clear()
165
self.ui_factory.clear_term()
168
class DummyProgress(object):
205
169
"""Progress-bar standin that does nothing.
207
This can be used as the default argument for methods that
208
take an optional progress indicator."""
171
This was previously often constructed by application code if no progress
172
bar was explicitly passed in. That's no longer recommended: instead, just
173
create a progress task from the ui_factory. This class can be used in
174
test code that needs to fake a progress task for some reason.
221
def note(self, fmt_string, *args, **kwargs):
222
"""See _BaseProgressBar.note()."""
224
189
def child_progress(self, **kwargs):
225
190
return DummyProgress(**kwargs)
228
_progress_bar_types['dummy'] = DummyProgress
229
_progress_bar_types['none'] = DummyProgress
232
class DotsProgressBar(_BaseProgressBar):
234
def __init__(self, **kwargs):
235
_BaseProgressBar.__init__(self, **kwargs)
242
def update(self, msg=None, current_cnt=None, total_cnt=None):
243
if msg and msg != self.last_msg:
245
self.to_file.write('\n')
246
self.to_file.write(msg + ': ')
249
self.to_file.write('.')
253
self.to_file.write('\n')
256
def child_update(self, message, current, total):
260
_progress_bar_types['dots'] = DotsProgressBar
263
class TTYProgressBar(_BaseProgressBar):
264
"""Progress bar display object.
266
Several options are available to control the display. These can
267
be passed as parameters to the constructor or assigned at any time:
270
Show percentage complete.
272
Show rotating baton. This ticks over on every update even
273
if the values don't change.
275
Show predicted time-to-completion.
279
Show numerical counts.
281
The output file should be in line-buffered or unbuffered mode.
286
def __init__(self, **kwargs):
287
from bzrlib.osutils import terminal_width
288
_BaseProgressBar.__init__(self, **kwargs)
290
self.width = terminal_width()
291
self.last_updates = []
292
self._max_last_updates = 10
293
self.child_fraction = 0
294
self._have_output = False
296
def throttle(self, old_msg):
297
"""Return True if the bar was updated too recently"""
298
# time.time consistently takes 40/4000 ms = 0.01 ms.
299
# time.clock() is faster, but gives us CPU time, not wall-clock time
301
if self.start_time is not None and (now - self.start_time) < 1:
303
if old_msg != self.last_msg:
305
interval = now - self.last_update
307
if interval < self.MIN_PAUSE:
310
self.last_updates.append(now - self.last_update)
311
# Don't let the queue grow without bound
312
self.last_updates = self.last_updates[-self._max_last_updates:]
313
self.last_update = now
317
self.update(self.last_msg, self.last_cnt, self.last_total,
320
def child_update(self, message, current, total):
321
if current is not None and total != 0:
322
child_fraction = float(current) / total
323
if self.last_cnt is None:
325
elif self.last_cnt + child_fraction <= self.last_total:
326
self.child_fraction = child_fraction
327
if self.last_msg is None:
331
def update(self, msg, current_cnt=None, total_cnt=None,
333
"""Update and redraw progress bar."""
337
if total_cnt is None:
338
total_cnt = self.last_total
343
if current_cnt > total_cnt:
344
total_cnt = current_cnt
346
## # optional corner case optimisation
347
## # currently does not seem to fire so costs more than saved.
348
## # trivial optimal case:
349
## # NB if callers are doing a clear and restore with
350
## # the saved values, this will prevent that:
351
## # in that case add a restore method that calls
352
## # _do_update or some such
353
## if (self.last_msg == msg and
354
## self.last_cnt == current_cnt and
355
## self.last_total == total_cnt and
356
## self.child_fraction == child_fraction):
359
old_msg = self.last_msg
360
# save these for the tick() function
362
self.last_cnt = current_cnt
363
self.last_total = total_cnt
364
self.child_fraction = child_fraction
366
# each function call takes 20ms/4000 = 0.005 ms,
367
# but multiple that by 4000 calls -> starts to cost.
368
# so anything to make this function call faster
369
# will improve base 'diff' time by up to 0.1 seconds.
370
if self.throttle(old_msg):
373
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,
375
self.last_total, last_updates = self.last_updates)
376
eta_str = " " + str_tdelta(eta)
380
if self.show_spinner:
381
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
385
# always update this; it's also used for the bar
388
if self.show_pct and self.last_total and self.last_cnt:
389
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
390
pct_str = ' (%5.1f%%)' % pct
394
if not self.show_count:
396
elif self.last_cnt is None:
398
elif self.last_total is None:
399
count_str = ' %i' % (self.last_cnt)
401
# make both fields the same size
402
t = '%i' % (self.last_total)
403
c = '%*i' % (len(t), self.last_cnt)
404
count_str = ' ' + c + '/' + t
407
# progress bar, if present, soaks up all remaining space
408
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
409
- len(eta_str) - len(count_str) - 3
412
# number of markers highlighted in bar
413
markers = int(round(float(cols) *
414
(self.last_cnt + self.child_fraction) / self.last_total))
415
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
417
# don't know total, so can't show completion.
418
# so just show an expanded spinning thingy
419
m = self.spin_pos % cols
420
ms = (' ' * m + '*').ljust(cols)
422
bar_str = '[' + ms + '] '
428
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
429
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
430
self._have_output = True
431
#self.to_file.flush()
434
if self._have_output:
435
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
436
self._have_output = False
437
#self.to_file.flush()
440
_progress_bar_types['tty'] = TTYProgressBar
443
class ChildProgress(_BaseProgressBar):
444
"""A progress indicator that pushes its data to the parent"""
446
def __init__(self, _stack, **kwargs):
447
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
448
self.parent = _stack.top()
451
self.child_fraction = 0
454
def update(self, msg, current_cnt=None, total_cnt=None):
455
self.current = current_cnt
456
if total_cnt is not None:
457
self.total = total_cnt
459
self.child_fraction = 0
462
def child_update(self, message, current, total):
463
if current is None or total == 0:
464
self.child_fraction = 0
466
self.child_fraction = float(current) / total
470
if self.current is None:
473
count = self.current+self.child_fraction
474
if count > self.total:
476
mutter('clamping count of %d to %d' % (count, self.total))
478
self.parent.child_update(self.message, count, self.total)
483
def note(self, *args, **kwargs):
484
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
193
def str_tdelta(delt):
added
removed
bzrlib/progress.py
