13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
"""Progress indicators.
20
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.
21
will maintain a ProgressBarStack for you.
23
For direct use, the factory ProgressBar will return an auto-detected progress
24
bar that should match your terminal type. You can manually create a
25
ProgressBarStack too if you need multiple levels of cooperating progress bars.
26
Note that bzrlib's internal functions use the ui module, so if you are using
27
bzrlib it really is best to use bzrlib.ui.ui_factory.
30
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter
36
46
def _supports_progress(f):
37
"""Detect if we can use pretty progress bars on file F.
47
"""Detect if we can use pretty progress bars on the output stream f.
39
49
If this returns true we expect that a human may be looking at that
40
50
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
52
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
57
if os.environ.get('TERM') == 'dumb':
54
58
# e.g. emacs compile window
65
69
Code updating the task may also set fields as hints about how to display
66
70
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
67
71
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`.
74
def __init__(self, parent_task=None, ui_factory=None):
92
75
self._parent_task = parent_task
93
76
self._last_update = 0
94
77
self.total_cnt = None
95
78
self.current_cnt = None
97
# TODO: deprecate passing ui_factory
98
80
self.ui_factory = ui_factory
99
self.progress_view = progress_view
100
81
self.show_pct = False
101
82
self.show_spinner = True
102
83
self.show_eta = False,
103
84
self.show_count = True
104
85
self.show_bar = 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
87
def update(self, msg, current_cnt=None, total_cnt=None):
117
89
self.current_cnt = current_cnt
119
91
self.total_cnt = total_cnt
120
if self.progress_view:
121
self.progress_view.show_progress(self)
123
self.ui_factory._progress_updated(self)
92
self.ui_factory.show_progress(self)
126
95
self.update(self.msg)
128
97
def finished(self):
129
if self.progress_view:
130
self.progress_view.task_finished(self)
132
self.ui_factory._progress_finished(self)
98
self.ui_factory.progress_finished(self)
134
100
def make_sub_task(self):
135
return ProgressTask(self, ui_factory=self.ui_factory,
136
progress_view=self.progress_view)
101
return ProgressTask(self, self.ui_factory)
138
103
def _overall_completion_fraction(self, child_fraction=0.0):
139
104
"""Return fractional completion of this task and its parents
141
106
Returns None if no completion can be computed."""
142
if self.current_cnt is not None and self.total_cnt:
143
108
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
111
if self._parent_task is None:
149
112
return own_fraction
152
115
own_fraction = 0.0
153
116
return self._parent_task._overall_completion_fraction(own_fraction)
155
@deprecated_method(deprecated_in((2, 1, 0)))
156
118
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)
119
"""Record a note without disrupting the progress bar."""
120
# XXX: shouldn't be here; put it in mutter or the ui instead
121
self.ui_factory.note(fmt_string % args)
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.
124
# XXX: shouldn't be here; put it in mutter or the ui instead
125
self.ui_factory.clear_term()
128
def ProgressBar(to_file=None, **kwargs):
129
"""Abstract factory"""
132
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
133
# An value of '' or not set reverts to standard processing
134
if requested_bar_type in (None, ''):
135
if _supports_progress(to_file):
136
return TTYProgressBar(to_file=to_file, **kwargs)
138
return DummyProgress(to_file=to_file, **kwargs)
140
# Minor sanitation to prevent spurious errors
141
requested_bar_type = requested_bar_type.lower().strip()
142
# TODO: jam 20060710 Arguably we shouldn't raise an exception
143
# but should instead just disable progress bars if we
144
# don't recognize the type
145
if requested_bar_type not in _progress_bar_types:
146
raise errors.InvalidProgressBarType(requested_bar_type,
147
_progress_bar_types.keys())
148
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
151
class ProgressBarStack(object):
152
"""A stack of progress bars."""
161
to_messages_file=None,
163
"""Setup the stack with the parameters the progress bars should have."""
166
if to_messages_file is None:
167
to_messages_file = sys.stdout
168
self._to_file = to_file
169
self._show_pct = show_pct
170
self._show_spinner = show_spinner
171
self._show_eta = show_eta
172
self._show_bar = show_bar
173
self._show_count = show_count
174
self._to_messages_file = to_messages_file
176
self._klass = klass or ProgressBar
179
if len(self._stack) != 0:
180
return self._stack[-1]
185
if len(self._stack) != 0:
186
return self._stack[0]
190
def get_nested(self):
191
"""Return a nested progress bar."""
192
if len(self._stack) == 0:
195
func = self.top().child_progress
196
new_bar = func(to_file=self._to_file,
197
show_pct=self._show_pct,
198
show_spinner=self._show_spinner,
199
show_eta=self._show_eta,
200
show_bar=self._show_bar,
201
show_count=self._show_count,
202
to_messages_file=self._to_messages_file,
204
self._stack.append(new_bar)
207
def return_pb(self, bar):
208
"""Return bar after its been used."""
209
if bar is not self._stack[-1]:
210
warnings.warn("%r is not currently active" % (bar,))
183
215
class _BaseProgressBar(object):
185
217
def __init__(self,
255
287
return DummyProgress(**kwargs)
290
class DotsProgressBar(_BaseProgressBar):
292
def __init__(self, **kwargs):
293
_BaseProgressBar.__init__(self, **kwargs)
300
def update(self, msg=None, current_cnt=None, total_cnt=None):
301
if msg and msg != self.last_msg:
303
self.to_file.write('\n')
304
self.to_file.write(msg + ': ')
307
self.to_file.write('.')
311
self.to_file.write('\n')
314
def child_update(self, message, current, total):
320
class TTYProgressBar(_BaseProgressBar):
321
"""Progress bar display object.
323
Several options are available to control the display. These can
324
be passed as parameters to the constructor or assigned at any time:
327
Show percentage complete.
329
Show rotating baton. This ticks over on every update even
330
if the values don't change.
332
Show predicted time-to-completion.
336
Show numerical counts.
338
The output file should be in line-buffered or unbuffered mode.
343
def __init__(self, **kwargs):
344
from bzrlib.osutils import terminal_width
345
_BaseProgressBar.__init__(self, **kwargs)
347
self.width = terminal_width()
348
self.last_updates = []
349
self._max_last_updates = 10
350
self.child_fraction = 0
351
self._have_output = False
353
def throttle(self, old_msg):
354
"""Return True if the bar was updated too recently"""
355
# time.time consistently takes 40/4000 ms = 0.01 ms.
356
# time.clock() is faster, but gives us CPU time, not wall-clock time
358
if self.start_time is not None and (now - self.start_time) < 1:
360
if old_msg != self.last_msg:
362
interval = now - self.last_update
364
if interval < self.MIN_PAUSE:
367
self.last_updates.append(now - self.last_update)
368
# Don't let the queue grow without bound
369
self.last_updates = self.last_updates[-self._max_last_updates:]
370
self.last_update = now
374
self.update(self.last_msg, self.last_cnt, self.last_total,
377
def child_update(self, message, current, total):
378
if current is not None and total != 0:
379
child_fraction = float(current) / total
380
if self.last_cnt is None:
382
elif self.last_cnt + child_fraction <= self.last_total:
383
self.child_fraction = child_fraction
384
if self.last_msg is None:
388
def update(self, msg, current_cnt=None, total_cnt=None,
390
"""Update and redraw progress bar.
395
if total_cnt is None:
396
total_cnt = self.last_total
401
if current_cnt > total_cnt:
402
total_cnt = current_cnt
404
## # optional corner case optimisation
405
## # currently does not seem to fire so costs more than saved.
406
## # trivial optimal case:
407
## # NB if callers are doing a clear and restore with
408
## # the saved values, this will prevent that:
409
## # in that case add a restore method that calls
410
## # _do_update or some such
411
## if (self.last_msg == msg and
412
## self.last_cnt == current_cnt and
413
## self.last_total == total_cnt and
414
## self.child_fraction == child_fraction):
420
old_msg = self.last_msg
421
# save these for the tick() function
423
self.last_cnt = current_cnt
424
self.last_total = total_cnt
425
self.child_fraction = child_fraction
427
# each function call takes 20ms/4000 = 0.005 ms,
428
# but multiple that by 4000 calls -> starts to cost.
429
# so anything to make this function call faster
430
# will improve base 'diff' time by up to 0.1 seconds.
431
if self.throttle(old_msg):
434
if self.show_eta and self.start_time and self.last_total:
435
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
436
self.last_total, last_updates = self.last_updates)
437
eta_str = " " + str_tdelta(eta)
441
if self.show_spinner:
442
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
446
# always update this; it's also used for the bar
449
if self.show_pct and self.last_total and self.last_cnt:
450
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
451
pct_str = ' (%5.1f%%)' % pct
455
if not self.show_count:
457
elif self.last_cnt is None:
459
elif self.last_total is None:
460
count_str = ' %i' % (self.last_cnt)
462
# make both fields the same size
463
t = '%i' % (self.last_total)
464
c = '%*i' % (len(t), self.last_cnt)
465
count_str = ' ' + c + '/' + t
468
# progress bar, if present, soaks up all remaining space
469
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
470
- len(eta_str) - len(count_str) - 3
473
# number of markers highlighted in bar
474
markers = int(round(float(cols) *
475
(self.last_cnt + self.child_fraction) / self.last_total))
476
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
478
# don't know total, so can't show completion.
479
# so just show an expanded spinning thingy
480
m = self.spin_pos % cols
481
ms = (' ' * m + '*').ljust(cols)
483
bar_str = '[' + ms + '] '
489
m = spin_str + bar_str + self.last_msg + count_str \
491
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
492
self._have_output = True
493
#self.to_file.flush()
496
if self._have_output:
497
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
498
self._have_output = False
499
#self.to_file.flush()
504
class ChildProgress(_BaseProgressBar):
505
"""A progress indicator that pushes its data to the parent"""
507
def __init__(self, _stack, **kwargs):
508
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
509
self.parent = _stack.top()
512
self.child_fraction = 0
515
def update(self, msg, current_cnt=None, total_cnt=None):
516
self.current = current_cnt
517
if total_cnt is not None:
518
self.total = total_cnt
520
self.child_fraction = 0
523
def child_update(self, message, current, total):
524
if current is None or total == 0:
525
self.child_fraction = 0
527
self.child_fraction = float(current) / total
531
if self.current is None:
534
count = self.current+self.child_fraction
535
if count > self.total:
537
mutter('clamping count of %d to %d' % (count, self.total))
539
self.parent.child_update(self.message, count, self.total)
544
def note(self, *args, **kwargs):
545
self.parent.note(*args, **kwargs)
548
class InstrumentedProgress(TTYProgressBar):
549
"""TTYProgress variant that tracks outcomes"""
551
def __init__(self, *args, **kwargs):
552
self.always_throttled = True
553
self.never_throttle = False
554
TTYProgressBar.__init__(self, *args, **kwargs)
556
def throttle(self, old_message):
557
if self.never_throttle:
560
result = TTYProgressBar.throttle(self, old_message)
562
self.always_throttled = False
258
565
def str_tdelta(delt):
added
removed
bzrlib/progress.py
