157
156
own_fraction = 0.0
158
157
return self._parent_task._overall_completion_fraction(own_fraction)
160
@deprecated_method(deprecated_in((2, 1, 0)))
161
159
def note(self, fmt_string, *args):
162
"""Record a note without disrupting the progress bar.
164
Deprecated: use ui_factory.note() instead or bzrlib.trace. Note that
165
ui_factory.note takes just one string as the argument, not a format
166
string and arguments.
160
"""Record a note without disrupting the progress bar."""
161
# XXX: shouldn't be here; put it in mutter or the ui instead
169
163
self.ui_factory.note(fmt_string % args)
171
165
self.ui_factory.note(fmt_string)
174
# TODO: deprecate this method; the model object shouldn't be concerned
175
# with whether it's shown or not. Most callers use this because they
176
# want to write some different non-progress output to the screen, but
177
# they should probably instead use a stream that's synchronized with
178
# the progress output. It may be there is a model-level use for
179
# saying "this task's not active at the moment" but I don't see it. --
168
# XXX: shouldn't be here; put it in mutter or the ui instead
181
169
if self.progress_view:
182
170
self.progress_view.clear()
184
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)
187
202
# NOTE: This is also deprecated; you should provide a ProgressView instead.
188
203
class _BaseProgressBar(object):
260
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)
263
537
def str_tdelta(delt):
added
removed
bzrlib/progress.py
