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.decorators import cleanup_method
34
from bzrlib.trace import mutter
35
from bzrlib.symbol_versioning import (
42
def _supports_progress(f):
43
"""Detect if we can use pretty progress bars on file F.
45
If this returns true we expect that a human may be looking at that
46
output, and that we can repaint a line to update it.
48
This doesn't check the policy for whether we *should* use them.
50
isatty = getattr(f, 'isatty', None)
55
# The following case also handles Win32 - on that platform $TERM is
56
# typically never set, so the case None is treated as a smart terminal,
57
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
58
# isatty methods that return true.
59
if os.environ.get('TERM') == 'dumb':
60
# e.g. emacs compile window
65
class ProgressTask(object):
66
"""Model component of a progress indicator.
68
Most code that needs to indicate progress should update one of these,
69
and it will in turn update the display, if one is present.
71
Code updating the task may also set fields as hints about how to display
72
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
73
will not necessarily respect all these fields.
75
:ivar update_latency: The interval (in seconds) at which the PB should be
76
updated. Setting this to zero suggests every update should be shown
79
:ivar show_transport_activity: If true (default), transport activity
80
will be shown when this task is drawn. Disable it if you're sure
81
that only irrelevant or uninteresting transport activity can occur
85
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
86
"""Construct a new progress task.
88
:param parent_task: Enclosing ProgressTask or None.
90
:param progress_view: ProgressView to display this ProgressTask.
92
:param ui_factory: The UI factory that will display updates;
93
deprecated in favor of passing progress_view directly.
95
Normally you should not call this directly but rather through
96
`ui_factory.nested_progress_bar`.
98
self._parent_task = parent_task
100
self.total_cnt = None
101
self.current_cnt = None
103
# TODO: deprecate passing ui_factory
104
self.ui_factory = ui_factory
105
self.progress_view = progress_view
106
self.show_pct = False
107
self.show_spinner = True
108
self.show_eta = False,
109
self.show_count = True
111
self.update_latency = 0.1
112
self.show_transport_activity = True
115
return '%s(%r/%r, msg=%r)' % (
116
self.__class__.__name__,
121
def update(self, msg, current_cnt=None, total_cnt=None):
123
self.current_cnt = current_cnt
125
self.total_cnt = total_cnt
126
if self.progress_view:
127
self.progress_view.show_progress(self)
129
self.ui_factory._progress_updated(self)
132
self.update(self.msg)
136
if self.progress_view:
137
self.progress_view.task_finished(self)
139
self.ui_factory._progress_finished(self)
141
def make_sub_task(self):
142
return ProgressTask(self, ui_factory=self.ui_factory,
143
progress_view=self.progress_view)
145
def _overall_completion_fraction(self, child_fraction=0.0):
146
"""Return fractional completion of this task and its parents
148
Returns None if no completion can be computed."""
149
if self.current_cnt is not None and self.total_cnt:
150
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
152
# if this task has no estimation, it just passes on directly
153
# whatever the child has measured...
154
own_fraction = child_fraction
155
if self._parent_task is None:
158
if own_fraction is None:
160
return self._parent_task._overall_completion_fraction(own_fraction)
162
@deprecated_method(deprecated_in((2, 1, 0)))
163
def note(self, fmt_string, *args):
164
"""Record a note without disrupting the progress bar.
166
Deprecated: use ui_factory.note() instead or bzrlib.trace. Note that
167
ui_factory.note takes just one string as the argument, not a format
168
string and arguments.
171
self.ui_factory.note(fmt_string % args)
173
self.ui_factory.note(fmt_string)
176
# TODO: deprecate this method; the model object shouldn't be concerned
177
# with whether it's shown or not. Most callers use this because they
178
# want to write some different non-progress output to the screen, but
179
# they should probably instead use a stream that's synchronized with
180
# the progress output. It may be there is a model-level use for
181
# saying "this task's not active at the moment" but I don't see it. --
183
if self.progress_view:
184
self.progress_view.clear()
186
self.ui_factory.clear_term()
189
@deprecated_function(deprecated_in((1, 16, 0)))
190
def ProgressBar(to_file=None, **kwargs):
191
"""Construct a progress bar.
193
Deprecated; ask the ui_factory for a progress task instead.
197
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
198
# An value of '' or not set reverts to standard processing
199
if requested_bar_type in (None, ''):
200
if _supports_progress(to_file):
201
return TTYProgressBar(to_file=to_file, **kwargs)
203
return DummyProgress(to_file=to_file, **kwargs)
205
# Minor sanitation to prevent spurious errors
206
requested_bar_type = requested_bar_type.lower().strip()
207
# TODO: jam 20060710 Arguably we shouldn't raise an exception
208
# but should instead just disable progress bars if we
209
# don't recognize the type
210
if requested_bar_type not in _progress_bar_types:
211
raise errors.InvalidProgressBarType(requested_bar_type,
212
_progress_bar_types.keys())
213
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
216
# NOTE: This is also deprecated; you should provide a ProgressView instead.
217
class _BaseProgressBar(object):
226
to_messages_file=None,
228
object.__init__(self)
231
if to_messages_file is None:
232
to_messages_file = sys.stdout
233
self.to_file = to_file
234
self.to_messages_file = to_messages_file
237
self.last_total = None
238
self.show_pct = show_pct
239
self.show_spinner = show_spinner
240
self.show_eta = show_eta
241
self.show_bar = show_bar
242
self.show_count = show_count
245
self.MIN_PAUSE = 0.1 # seconds
248
self.start_time = now
249
# next update should not throttle
250
self.last_update = now - self.MIN_PAUSE - 1
254
"""Return this bar to its progress stack."""
256
self._stack.return_pb(self)
258
def note(self, fmt_string, *args, **kwargs):
259
"""Record a note without disrupting the progress bar."""
261
self.to_messages_file.write(fmt_string % args)
262
self.to_messages_file.write('\n')
264
@deprecated_function(deprecated_in((1, 16, 0)))
265
def child_progress(self, **kwargs):
266
return ChildProgress(**kwargs)
269
class DummyProgress(_BaseProgressBar):
270
"""Progress-bar standin that does nothing.
272
This can be used as the default argument for methods that
273
take an optional progress indicator."""
278
def update(self, msg=None, current=None, total=None):
281
def child_update(self, message, current, total):
287
def note(self, fmt_string, *args, **kwargs):
288
"""See _BaseProgressBar.note()."""
290
def child_progress(self, **kwargs):
291
return DummyProgress(**kwargs)
294
class DotsProgressBar(_BaseProgressBar):
296
@deprecated_function(deprecated_in((1, 16, 0)))
297
def __init__(self, **kwargs):
298
_BaseProgressBar.__init__(self, **kwargs)
305
def update(self, msg=None, current_cnt=None, total_cnt=None):
306
if msg and msg != self.last_msg:
308
self.to_file.write('\n')
309
self.to_file.write(msg + ': ')
312
self.to_file.write('.')
316
self.to_file.write('\n')
319
def child_update(self, message, current, total):
323
class TTYProgressBar(_BaseProgressBar):
324
"""Progress bar display object.
326
Several options are available to control the display. These can
327
be passed as parameters to the constructor or assigned at any time:
330
Show percentage complete.
332
Show rotating baton. This ticks over on every update even
333
if the values don't change.
335
Show predicted time-to-completion.
339
Show numerical counts.
341
The output file should be in line-buffered or unbuffered mode.
345
@deprecated_function(deprecated_in((1, 16, 0)))
346
def __init__(self, **kwargs):
347
from bzrlib.osutils import terminal_width
348
_BaseProgressBar.__init__(self, **kwargs)
350
self.width = terminal_width()
351
self.last_updates = []
352
self._max_last_updates = 10
353
self.child_fraction = 0
354
self._have_output = False
356
def throttle(self, old_msg):
357
"""Return True if the bar was updated too recently"""
358
# time.time consistently takes 40/4000 ms = 0.01 ms.
359
# time.clock() is faster, but gives us CPU time, not wall-clock time
361
if self.start_time is not None and (now - self.start_time) < 1:
363
if old_msg != self.last_msg:
365
interval = now - self.last_update
367
if interval < self.MIN_PAUSE:
370
self.last_updates.append(now - self.last_update)
371
# Don't let the queue grow without bound
372
self.last_updates = self.last_updates[-self._max_last_updates:]
373
self.last_update = now
377
self.update(self.last_msg, self.last_cnt, self.last_total,
380
def child_update(self, message, current, total):
381
if current is not None and total != 0:
382
child_fraction = float(current) / total
383
if self.last_cnt is None:
385
elif self.last_cnt + child_fraction <= self.last_total:
386
self.child_fraction = child_fraction
387
if self.last_msg is None:
391
def update(self, msg, current_cnt=None, total_cnt=None,
393
"""Update and redraw progress bar.
398
if total_cnt is None:
399
total_cnt = self.last_total
404
if current_cnt > total_cnt:
405
total_cnt = current_cnt
407
## # optional corner case optimisation
408
## # currently does not seem to fire so costs more than saved.
409
## # trivial optimal case:
410
## # NB if callers are doing a clear and restore with
411
## # the saved values, this will prevent that:
412
## # in that case add a restore method that calls
413
## # _do_update or some such
414
## if (self.last_msg == msg and
415
## self.last_cnt == current_cnt and
416
## self.last_total == total_cnt and
417
## self.child_fraction == child_fraction):
423
old_msg = self.last_msg
424
# save these for the tick() function
426
self.last_cnt = current_cnt
427
self.last_total = total_cnt
428
self.child_fraction = child_fraction
430
# each function call takes 20ms/4000 = 0.005 ms,
431
# but multiple that by 4000 calls -> starts to cost.
432
# so anything to make this function call faster
433
# will improve base 'diff' time by up to 0.1 seconds.
434
if self.throttle(old_msg):
437
if self.show_eta and self.start_time and self.last_total:
438
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
439
self.last_total, last_updates = self.last_updates)
440
eta_str = " " + str_tdelta(eta)
444
if self.show_spinner:
445
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
449
# always update this; it's also used for the bar
452
if self.show_pct and self.last_total and self.last_cnt:
453
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
454
pct_str = ' (%5.1f%%)' % pct
458
if not self.show_count:
460
elif self.last_cnt is None:
462
elif self.last_total is None:
463
count_str = ' %i' % (self.last_cnt)
465
# make both fields the same size
466
t = '%i' % (self.last_total)
467
c = '%*i' % (len(t), self.last_cnt)
468
count_str = ' ' + c + '/' + t
471
# progress bar, if present, soaks up all remaining space
472
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
473
- len(eta_str) - len(count_str) - 3
476
# number of markers highlighted in bar
477
markers = int(round(float(cols) *
478
(self.last_cnt + self.child_fraction) / self.last_total))
479
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
481
# don't know total, so can't show completion.
482
# so just show an expanded spinning thingy
483
m = self.spin_pos % cols
484
ms = (' ' * m + '*').ljust(cols)
486
bar_str = '[' + ms + '] '
492
m = spin_str + bar_str + self.last_msg + count_str \
494
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
495
self._have_output = True
496
#self.to_file.flush()
499
if self._have_output:
500
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
501
self._have_output = False
502
#self.to_file.flush()
507
class ChildProgress(_BaseProgressBar):
508
"""A progress indicator that pushes its data to the parent"""
510
@deprecated_function(deprecated_in((1, 16, 0)))
511
def __init__(self, _stack, **kwargs):
512
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
513
self.parent = _stack.top()
516
self.child_fraction = 0
519
def update(self, msg, current_cnt=None, total_cnt=None):
520
self.current = current_cnt
521
if total_cnt is not None:
522
self.total = total_cnt
524
self.child_fraction = 0
527
def child_update(self, message, current, total):
528
if current is None or total == 0:
529
self.child_fraction = 0
531
self.child_fraction = float(current) / total
535
if self.current is None:
538
count = self.current+self.child_fraction
539
if count > self.total:
541
mutter('clamping count of %d to %d' % (count, self.total))
543
self.parent.child_update(self.message, count, self.total)
548
def note(self, *args, **kwargs):
549
self.parent.note(*args, **kwargs)
552
def str_tdelta(delt):
555
delt = int(round(delt))
556
return '%d:%02d:%02d' % (delt/3600,
561
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
562
if start_time is None:
568
if current < enough_samples:
574
elapsed = time.time() - start_time
576
if elapsed < 2.0: # not enough time to estimate
579
total_duration = float(elapsed) * float(total) / float(current)
581
if last_updates and len(last_updates) >= n_recent:
582
avg = sum(last_updates) / float(len(last_updates))
583
time_left = avg * (total - current)
585
old_time_left = total_duration - elapsed
587
# We could return the average, or some other value here
588
return (time_left + old_time_left) / 2
590
return total_duration - elapsed
593
class ProgressPhase(object):
594
"""Update progress object with the current phase"""
595
def __init__(self, message, total, pb):
596
object.__init__(self)
598
self.message = message
600
self.cur_phase = None
602
def next_phase(self):
603
if self.cur_phase is None:
607
self.pb.update(self.message, self.cur_phase, self.total)
610
_progress_bar_types = {}
611
_progress_bar_types['dummy'] = DummyProgress
612
_progress_bar_types['none'] = DummyProgress
613
_progress_bar_types['tty'] = TTYProgressBar
614
_progress_bar_types['dots'] = DotsProgressBar
added
removed
bzrlib/progress.py
