152
156
own_fraction = 0.0
153
157
return self._parent_task._overall_completion_fraction(own_fraction)
155
@deprecated_method(deprecated_in((2, 1, 0)))
156
159
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.
160
"""Record a note without disrupting the progress bar."""
161
# XXX: shouldn't be here; put it in mutter or the ui instead
164
163
self.ui_factory.note(fmt_string % args)
166
165
self.ui_factory.note(fmt_string)
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. --
168
# XXX: shouldn't be here; put it in mutter or the ui instead
176
169
if self.progress_view:
177
170
self.progress_view.clear()
179
172
self.ui_factory.clear_term()
175
@deprecated_function(deprecated_in((1, 16, 0)))
176
def ProgressBar(to_file=None, **kwargs):
177
"""Abstract factory"""
180
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
181
# An value of '' or not set reverts to standard processing
182
if requested_bar_type in (None, ''):
183
if _supports_progress(to_file):
184
return TTYProgressBar(to_file=to_file, **kwargs)
186
return DummyProgress(to_file=to_file, **kwargs)
188
# Minor sanitation to prevent spurious errors
189
requested_bar_type = requested_bar_type.lower().strip()
190
# TODO: jam 20060710 Arguably we shouldn't raise an exception
191
# but should instead just disable progress bars if we
192
# don't recognize the type
193
if requested_bar_type not in _progress_bar_types:
194
raise errors.InvalidProgressBarType(requested_bar_type,
195
_progress_bar_types.keys())
196
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
182
199
# NOTE: This is also deprecated; you should provide a ProgressView instead.
183
200
class _BaseProgressBar(object):
255
273
return DummyProgress(**kwargs)
276
class DotsProgressBar(_BaseProgressBar):
278
@deprecated_function(deprecated_in((1, 16, 0)))
279
def __init__(self, **kwargs):
280
_BaseProgressBar.__init__(self, **kwargs)
287
def update(self, msg=None, current_cnt=None, total_cnt=None):
288
if msg and msg != self.last_msg:
290
self.to_file.write('\n')
291
self.to_file.write(msg + ': ')
294
self.to_file.write('.')
298
self.to_file.write('\n')
301
def child_update(self, message, current, total):
305
class TTYProgressBar(_BaseProgressBar):
306
"""Progress bar display object.
308
Several options are available to control the display. These can
309
be passed as parameters to the constructor or assigned at any time:
312
Show percentage complete.
314
Show rotating baton. This ticks over on every update even
315
if the values don't change.
317
Show predicted time-to-completion.
321
Show numerical counts.
323
The output file should be in line-buffered or unbuffered mode.
327
@deprecated_function(deprecated_in((1, 16, 0)))
328
def __init__(self, **kwargs):
329
from bzrlib.osutils import terminal_width
330
_BaseProgressBar.__init__(self, **kwargs)
332
self.width = terminal_width()
333
self.last_updates = []
334
self._max_last_updates = 10
335
self.child_fraction = 0
336
self._have_output = False
338
def throttle(self, old_msg):
339
"""Return True if the bar was updated too recently"""
340
# time.time consistently takes 40/4000 ms = 0.01 ms.
341
# time.clock() is faster, but gives us CPU time, not wall-clock time
343
if self.start_time is not None and (now - self.start_time) < 1:
345
if old_msg != self.last_msg:
347
interval = now - self.last_update
349
if interval < self.MIN_PAUSE:
352
self.last_updates.append(now - self.last_update)
353
# Don't let the queue grow without bound
354
self.last_updates = self.last_updates[-self._max_last_updates:]
355
self.last_update = now
359
self.update(self.last_msg, self.last_cnt, self.last_total,
362
def child_update(self, message, current, total):
363
if current is not None and total != 0:
364
child_fraction = float(current) / total
365
if self.last_cnt is None:
367
elif self.last_cnt + child_fraction <= self.last_total:
368
self.child_fraction = child_fraction
369
if self.last_msg is None:
373
def update(self, msg, current_cnt=None, total_cnt=None,
375
"""Update and redraw progress bar.
380
if total_cnt is None:
381
total_cnt = self.last_total
386
if current_cnt > total_cnt:
387
total_cnt = current_cnt
389
## # optional corner case optimisation
390
## # currently does not seem to fire so costs more than saved.
391
## # trivial optimal case:
392
## # NB if callers are doing a clear and restore with
393
## # the saved values, this will prevent that:
394
## # in that case add a restore method that calls
395
## # _do_update or some such
396
## if (self.last_msg == msg and
397
## self.last_cnt == current_cnt and
398
## self.last_total == total_cnt and
399
## self.child_fraction == child_fraction):
405
old_msg = self.last_msg
406
# save these for the tick() function
408
self.last_cnt = current_cnt
409
self.last_total = total_cnt
410
self.child_fraction = child_fraction
412
# each function call takes 20ms/4000 = 0.005 ms,
413
# but multiple that by 4000 calls -> starts to cost.
414
# so anything to make this function call faster
415
# will improve base 'diff' time by up to 0.1 seconds.
416
if self.throttle(old_msg):
419
if self.show_eta and self.start_time and self.last_total:
420
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
421
self.last_total, last_updates = self.last_updates)
422
eta_str = " " + str_tdelta(eta)
426
if self.show_spinner:
427
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
431
# always update this; it's also used for the bar
434
if self.show_pct and self.last_total and self.last_cnt:
435
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
436
pct_str = ' (%5.1f%%)' % pct
440
if not self.show_count:
442
elif self.last_cnt is None:
444
elif self.last_total is None:
445
count_str = ' %i' % (self.last_cnt)
447
# make both fields the same size
448
t = '%i' % (self.last_total)
449
c = '%*i' % (len(t), self.last_cnt)
450
count_str = ' ' + c + '/' + t
453
# progress bar, if present, soaks up all remaining space
454
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
455
- len(eta_str) - len(count_str) - 3
458
# number of markers highlighted in bar
459
markers = int(round(float(cols) *
460
(self.last_cnt + self.child_fraction) / self.last_total))
461
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
463
# don't know total, so can't show completion.
464
# so just show an expanded spinning thingy
465
m = self.spin_pos % cols
466
ms = (' ' * m + '*').ljust(cols)
468
bar_str = '[' + ms + '] '
474
m = spin_str + bar_str + self.last_msg + count_str \
476
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
477
self._have_output = True
478
#self.to_file.flush()
481
if self._have_output:
482
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
483
self._have_output = False
484
#self.to_file.flush()
489
class ChildProgress(_BaseProgressBar):
490
"""A progress indicator that pushes its data to the parent"""
492
@deprecated_function(deprecated_in((1, 16, 0)))
493
def __init__(self, _stack, **kwargs):
494
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
495
self.parent = _stack.top()
498
self.child_fraction = 0
501
def update(self, msg, current_cnt=None, total_cnt=None):
502
self.current = current_cnt
503
if total_cnt is not None:
504
self.total = total_cnt
506
self.child_fraction = 0
509
def child_update(self, message, current, total):
510
if current is None or total == 0:
511
self.child_fraction = 0
513
self.child_fraction = float(current) / total
517
if self.current is None:
520
count = self.current+self.child_fraction
521
if count > self.total:
523
mutter('clamping count of %d to %d' % (count, self.total))
525
self.parent.child_update(self.message, count, self.total)
530
def note(self, *args, **kwargs):
531
self.parent.note(*args, **kwargs)
258
534
def str_tdelta(delt):
added
removed
bzrlib/progress.py
