179
183
self.ui_factory.clear_term()
186
@deprecated_function(deprecated_in((1, 16, 0)))
187
def ProgressBar(to_file=None, **kwargs):
188
"""Construct a progress bar.
190
Deprecated; ask the ui_factory for a progress task instead.
194
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
195
# An value of '' or not set reverts to standard processing
196
if requested_bar_type in (None, ''):
197
if _supports_progress(to_file):
198
return TTYProgressBar(to_file=to_file, **kwargs)
200
return DummyProgress(to_file=to_file, **kwargs)
202
# Minor sanitation to prevent spurious errors
203
requested_bar_type = requested_bar_type.lower().strip()
204
# TODO: jam 20060710 Arguably we shouldn't raise an exception
205
# but should instead just disable progress bars if we
206
# don't recognize the type
207
if requested_bar_type not in _progress_bar_types:
208
raise errors.InvalidProgressBarType(requested_bar_type,
209
_progress_bar_types.keys())
210
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
182
213
# NOTE: This is also deprecated; you should provide a ProgressView instead.
183
214
class _BaseProgressBar(object):
255
287
return DummyProgress(**kwargs)
290
class DotsProgressBar(_BaseProgressBar):
292
@deprecated_function(deprecated_in((1, 16, 0)))
293
def __init__(self, **kwargs):
294
_BaseProgressBar.__init__(self, **kwargs)
301
def update(self, msg=None, current_cnt=None, total_cnt=None):
302
if msg and msg != self.last_msg:
304
self.to_file.write('\n')
305
self.to_file.write(msg + ': ')
308
self.to_file.write('.')
312
self.to_file.write('\n')
315
def child_update(self, message, current, total):
319
class TTYProgressBar(_BaseProgressBar):
320
"""Progress bar display object.
322
Several options are available to control the display. These can
323
be passed as parameters to the constructor or assigned at any time:
326
Show percentage complete.
328
Show rotating baton. This ticks over on every update even
329
if the values don't change.
331
Show predicted time-to-completion.
335
Show numerical counts.
337
The output file should be in line-buffered or unbuffered mode.
341
@deprecated_function(deprecated_in((1, 16, 0)))
342
def __init__(self, **kwargs):
343
from bzrlib.osutils import terminal_width
344
_BaseProgressBar.__init__(self, **kwargs)
346
self.width = terminal_width()
347
self.last_updates = []
348
self._max_last_updates = 10
349
self.child_fraction = 0
350
self._have_output = False
352
def throttle(self, old_msg):
353
"""Return True if the bar was updated too recently"""
354
# time.time consistently takes 40/4000 ms = 0.01 ms.
355
# time.clock() is faster, but gives us CPU time, not wall-clock time
357
if self.start_time is not None and (now - self.start_time) < 1:
359
if old_msg != self.last_msg:
361
interval = now - self.last_update
363
if interval < self.MIN_PAUSE:
366
self.last_updates.append(now - self.last_update)
367
# Don't let the queue grow without bound
368
self.last_updates = self.last_updates[-self._max_last_updates:]
369
self.last_update = now
373
self.update(self.last_msg, self.last_cnt, self.last_total,
376
def child_update(self, message, current, total):
377
if current is not None and total != 0:
378
child_fraction = float(current) / total
379
if self.last_cnt is None:
381
elif self.last_cnt + child_fraction <= self.last_total:
382
self.child_fraction = child_fraction
383
if self.last_msg is None:
387
def update(self, msg, current_cnt=None, total_cnt=None,
389
"""Update and redraw progress bar.
394
if total_cnt is None:
395
total_cnt = self.last_total
400
if current_cnt > total_cnt:
401
total_cnt = current_cnt
403
## # optional corner case optimisation
404
## # currently does not seem to fire so costs more than saved.
405
## # trivial optimal case:
406
## # NB if callers are doing a clear and restore with
407
## # the saved values, this will prevent that:
408
## # in that case add a restore method that calls
409
## # _do_update or some such
410
## if (self.last_msg == msg and
411
## self.last_cnt == current_cnt and
412
## self.last_total == total_cnt and
413
## self.child_fraction == child_fraction):
419
old_msg = self.last_msg
420
# save these for the tick() function
422
self.last_cnt = current_cnt
423
self.last_total = total_cnt
424
self.child_fraction = child_fraction
426
# each function call takes 20ms/4000 = 0.005 ms,
427
# but multiple that by 4000 calls -> starts to cost.
428
# so anything to make this function call faster
429
# will improve base 'diff' time by up to 0.1 seconds.
430
if self.throttle(old_msg):
433
if self.show_eta and self.start_time and self.last_total:
434
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
435
self.last_total, last_updates = self.last_updates)
436
eta_str = " " + str_tdelta(eta)
440
if self.show_spinner:
441
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
445
# always update this; it's also used for the bar
448
if self.show_pct and self.last_total and self.last_cnt:
449
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
450
pct_str = ' (%5.1f%%)' % pct
454
if not self.show_count:
456
elif self.last_cnt is None:
458
elif self.last_total is None:
459
count_str = ' %i' % (self.last_cnt)
461
# make both fields the same size
462
t = '%i' % (self.last_total)
463
c = '%*i' % (len(t), self.last_cnt)
464
count_str = ' ' + c + '/' + t
467
# progress bar, if present, soaks up all remaining space
468
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
469
- len(eta_str) - len(count_str) - 3
472
# number of markers highlighted in bar
473
markers = int(round(float(cols) *
474
(self.last_cnt + self.child_fraction) / self.last_total))
475
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
477
# don't know total, so can't show completion.
478
# so just show an expanded spinning thingy
479
m = self.spin_pos % cols
480
ms = (' ' * m + '*').ljust(cols)
482
bar_str = '[' + ms + '] '
488
m = spin_str + bar_str + self.last_msg + count_str \
490
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
491
self._have_output = True
492
#self.to_file.flush()
495
if self._have_output:
496
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
497
self._have_output = False
498
#self.to_file.flush()
503
class ChildProgress(_BaseProgressBar):
504
"""A progress indicator that pushes its data to the parent"""
506
@deprecated_function(deprecated_in((1, 16, 0)))
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)
258
548
def str_tdelta(delt):
added
removed
bzrlib/progress.py
