1
# Copyright (C) 2005, 2006, 2008, 2009 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.
33
from bzrlib.trace import mutter
34
from bzrlib.symbol_versioning import (
40
def _supports_progress(f):
41
"""Detect if we can use pretty progress bars on file F.
43
If this returns true we expect that a human may be looking at that
44
output, and that we can repaint a line to update it.
46
This doesn't check the policy for whether we *should* use them.
48
isatty = getattr(f, 'isatty', None)
53
# The following case also handles Win32 - on that platform $TERM is
54
# typically never set, so the case None is treated as a smart terminal,
55
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
56
# isatty methods that return true.
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.
73
:ivar update_latency: The interval (in seconds) at which the PB should be
74
updated. Setting this to zero suggests every update should be shown
77
:ivar show_transport_activity: If true (default), transport activity
78
will be shown when this task is drawn. Disable it if you're sure
79
that only irrelevant or uninteresting transport activity can occur
83
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
84
"""Construct a new progress task.
86
:param parent_task: Enclosing ProgressTask or None.
88
:param progress_view: ProgressView to display this ProgressTask.
90
:param ui_factory: The UI factory that will display updates;
91
deprecated in favor of passing progress_view directly.
93
Normally you should not call this directly but rather through
94
`ui_factory.nested_progress_bar`.
96
self._parent_task = parent_task
99
self.current_cnt = None
101
# TODO: deprecate passing ui_factory
102
self.ui_factory = ui_factory
103
self.progress_view = progress_view
104
self.show_pct = False
105
self.show_spinner = True
106
self.show_eta = False,
107
self.show_count = True
109
self.update_latency = 0.1
110
self.show_transport_activity = True
113
return '%s(%r/%r, msg=%r)' % (
114
self.__class__.__name__,
119
def update(self, msg, current_cnt=None, total_cnt=None):
121
self.current_cnt = current_cnt
123
self.total_cnt = total_cnt
124
if self.progress_view:
125
self.progress_view.show_progress(self)
127
self.ui_factory._progress_updated(self)
130
self.update(self.msg)
133
if self.progress_view:
134
self.progress_view.task_finished(self)
136
self.ui_factory._progress_finished(self)
138
def make_sub_task(self):
139
return ProgressTask(self, ui_factory=self.ui_factory,
140
progress_view=self.progress_view)
142
def _overall_completion_fraction(self, child_fraction=0.0):
143
"""Return fractional completion of this task and its parents
145
Returns None if no completion can be computed."""
146
if self.current_cnt is not None and self.total_cnt:
147
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
149
# if this task has no estimation, it just passes on directly
150
# whatever the child has measured...
151
own_fraction = child_fraction
152
if self._parent_task is None:
155
if own_fraction is None:
157
return self._parent_task._overall_completion_fraction(own_fraction)
159
def note(self, fmt_string, *args):
160
"""Record a note without disrupting the progress bar."""
161
# XXX: shouldn't be here; put it in mutter or the ui instead
163
self.ui_factory.note(fmt_string % args)
165
self.ui_factory.note(fmt_string)
168
# XXX: shouldn't be here; put it in mutter or the ui instead
169
if self.progress_view:
170
self.progress_view.clear()
172
self.ui_factory.clear_term()
175
@deprecated_function(deprecated_in((1, 16, 0)))
176
def ProgressBar(to_file=None, **kwargs):
177
"""Construct a progress bar.
179
Deprecated; ask the ui_factory for a progress task instead.
183
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
184
# An value of '' or not set reverts to standard processing
185
if requested_bar_type in (None, ''):
186
if _supports_progress(to_file):
187
return TTYProgressBar(to_file=to_file, **kwargs)
189
return DummyProgress(to_file=to_file, **kwargs)
191
# Minor sanitation to prevent spurious errors
192
requested_bar_type = requested_bar_type.lower().strip()
193
# TODO: jam 20060710 Arguably we shouldn't raise an exception
194
# but should instead just disable progress bars if we
195
# don't recognize the type
196
if requested_bar_type not in _progress_bar_types:
197
raise errors.InvalidProgressBarType(requested_bar_type,
198
_progress_bar_types.keys())
199
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
202
# NOTE: This is also deprecated; you should provide a ProgressView instead.
203
class _BaseProgressBar(object):
212
to_messages_file=None,
214
object.__init__(self)
217
if to_messages_file is None:
218
to_messages_file = sys.stdout
219
self.to_file = to_file
220
self.to_messages_file = to_messages_file
223
self.last_total = None
224
self.show_pct = show_pct
225
self.show_spinner = show_spinner
226
self.show_eta = show_eta
227
self.show_bar = show_bar
228
self.show_count = show_count
231
self.MIN_PAUSE = 0.1 # seconds
234
self.start_time = now
235
# next update should not throttle
236
self.last_update = now - self.MIN_PAUSE - 1
239
"""Return this bar to its progress stack."""
241
self._stack.return_pb(self)
243
def note(self, fmt_string, *args, **kwargs):
244
"""Record a note without disrupting the progress bar."""
246
self.to_messages_file.write(fmt_string % args)
247
self.to_messages_file.write('\n')
249
@deprecated_function(deprecated_in((1, 16, 0)))
250
def child_progress(self, **kwargs):
251
return ChildProgress(**kwargs)
254
class DummyProgress(_BaseProgressBar):
255
"""Progress-bar standin that does nothing.
257
This can be used as the default argument for methods that
258
take an optional progress indicator."""
263
def update(self, msg=None, current=None, total=None):
266
def child_update(self, message, current, total):
272
def note(self, fmt_string, *args, **kwargs):
273
"""See _BaseProgressBar.note()."""
275
def child_progress(self, **kwargs):
276
return DummyProgress(**kwargs)
279
class DotsProgressBar(_BaseProgressBar):
281
@deprecated_function(deprecated_in((1, 16, 0)))
282
def __init__(self, **kwargs):
283
_BaseProgressBar.__init__(self, **kwargs)
290
def update(self, msg=None, current_cnt=None, total_cnt=None):
291
if msg and msg != self.last_msg:
293
self.to_file.write('\n')
294
self.to_file.write(msg + ': ')
297
self.to_file.write('.')
301
self.to_file.write('\n')
304
def child_update(self, message, current, total):
308
class TTYProgressBar(_BaseProgressBar):
309
"""Progress bar display object.
311
Several options are available to control the display. These can
312
be passed as parameters to the constructor or assigned at any time:
315
Show percentage complete.
317
Show rotating baton. This ticks over on every update even
318
if the values don't change.
320
Show predicted time-to-completion.
324
Show numerical counts.
326
The output file should be in line-buffered or unbuffered mode.
330
@deprecated_function(deprecated_in((1, 16, 0)))
331
def __init__(self, **kwargs):
332
from bzrlib.osutils import terminal_width
333
_BaseProgressBar.__init__(self, **kwargs)
335
self.width = terminal_width()
336
self.last_updates = []
337
self._max_last_updates = 10
338
self.child_fraction = 0
339
self._have_output = False
341
def throttle(self, old_msg):
342
"""Return True if the bar was updated too recently"""
343
# time.time consistently takes 40/4000 ms = 0.01 ms.
344
# time.clock() is faster, but gives us CPU time, not wall-clock time
346
if self.start_time is not None and (now - self.start_time) < 1:
348
if old_msg != self.last_msg:
350
interval = now - self.last_update
352
if interval < self.MIN_PAUSE:
355
self.last_updates.append(now - self.last_update)
356
# Don't let the queue grow without bound
357
self.last_updates = self.last_updates[-self._max_last_updates:]
358
self.last_update = now
362
self.update(self.last_msg, self.last_cnt, self.last_total,
365
def child_update(self, message, current, total):
366
if current is not None and total != 0:
367
child_fraction = float(current) / total
368
if self.last_cnt is None:
370
elif self.last_cnt + child_fraction <= self.last_total:
371
self.child_fraction = child_fraction
372
if self.last_msg is None:
376
def update(self, msg, current_cnt=None, total_cnt=None,
378
"""Update and redraw progress bar.
383
if total_cnt is None:
384
total_cnt = self.last_total
389
if current_cnt > total_cnt:
390
total_cnt = current_cnt
392
## # optional corner case optimisation
393
## # currently does not seem to fire so costs more than saved.
394
## # trivial optimal case:
395
## # NB if callers are doing a clear and restore with
396
## # the saved values, this will prevent that:
397
## # in that case add a restore method that calls
398
## # _do_update or some such
399
## if (self.last_msg == msg and
400
## self.last_cnt == current_cnt and
401
## self.last_total == total_cnt and
402
## self.child_fraction == child_fraction):
408
old_msg = self.last_msg
409
# save these for the tick() function
411
self.last_cnt = current_cnt
412
self.last_total = total_cnt
413
self.child_fraction = child_fraction
415
# each function call takes 20ms/4000 = 0.005 ms,
416
# but multiple that by 4000 calls -> starts to cost.
417
# so anything to make this function call faster
418
# will improve base 'diff' time by up to 0.1 seconds.
419
if self.throttle(old_msg):
422
if self.show_eta and self.start_time and self.last_total:
423
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
424
self.last_total, last_updates = self.last_updates)
425
eta_str = " " + str_tdelta(eta)
429
if self.show_spinner:
430
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
434
# always update this; it's also used for the bar
437
if self.show_pct and self.last_total and self.last_cnt:
438
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
439
pct_str = ' (%5.1f%%)' % pct
443
if not self.show_count:
445
elif self.last_cnt is None:
447
elif self.last_total is None:
448
count_str = ' %i' % (self.last_cnt)
450
# make both fields the same size
451
t = '%i' % (self.last_total)
452
c = '%*i' % (len(t), self.last_cnt)
453
count_str = ' ' + c + '/' + t
456
# progress bar, if present, soaks up all remaining space
457
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
458
- len(eta_str) - len(count_str) - 3
461
# number of markers highlighted in bar
462
markers = int(round(float(cols) *
463
(self.last_cnt + self.child_fraction) / self.last_total))
464
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
466
# don't know total, so can't show completion.
467
# so just show an expanded spinning thingy
468
m = self.spin_pos % cols
469
ms = (' ' * m + '*').ljust(cols)
471
bar_str = '[' + ms + '] '
477
m = spin_str + bar_str + self.last_msg + count_str \
479
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
480
self._have_output = True
481
#self.to_file.flush()
484
if self._have_output:
485
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
486
self._have_output = False
487
#self.to_file.flush()
492
class ChildProgress(_BaseProgressBar):
493
"""A progress indicator that pushes its data to the parent"""
495
@deprecated_function(deprecated_in((1, 16, 0)))
496
def __init__(self, _stack, **kwargs):
497
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
498
self.parent = _stack.top()
501
self.child_fraction = 0
504
def update(self, msg, current_cnt=None, total_cnt=None):
505
self.current = current_cnt
506
if total_cnt is not None:
507
self.total = total_cnt
509
self.child_fraction = 0
512
def child_update(self, message, current, total):
513
if current is None or total == 0:
514
self.child_fraction = 0
516
self.child_fraction = float(current) / total
520
if self.current is None:
523
count = self.current+self.child_fraction
524
if count > self.total:
526
mutter('clamping count of %d to %d' % (count, self.total))
528
self.parent.child_update(self.message, count, self.total)
533
def note(self, *args, **kwargs):
534
self.parent.note(*args, **kwargs)
537
def str_tdelta(delt):
540
delt = int(round(delt))
541
return '%d:%02d:%02d' % (delt/3600,
546
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
547
if start_time is None:
553
if current < enough_samples:
559
elapsed = time.time() - start_time
561
if elapsed < 2.0: # not enough time to estimate
564
total_duration = float(elapsed) * float(total) / float(current)
566
if last_updates and len(last_updates) >= n_recent:
567
avg = sum(last_updates) / float(len(last_updates))
568
time_left = avg * (total - current)
570
old_time_left = total_duration - elapsed
572
# We could return the average, or some other value here
573
return (time_left + old_time_left) / 2
575
return total_duration - elapsed
578
class ProgressPhase(object):
579
"""Update progress object with the current phase"""
580
def __init__(self, message, total, pb):
581
object.__init__(self)
583
self.message = message
585
self.cur_phase = None
587
def next_phase(self):
588
if self.cur_phase is None:
592
self.pb.update(self.message, self.cur_phase, self.total)
595
_progress_bar_types = {}
596
_progress_bar_types['dummy'] = DummyProgress
597
_progress_bar_types['none'] = DummyProgress
598
_progress_bar_types['tty'] = TTYProgressBar
599
_progress_bar_types['dots'] = DotsProgressBar
added
removed
bzrlib/progress.py
