152
145
own_fraction = 0.0
153
146
return self._parent_task._overall_completion_fraction(own_fraction)
148
def note(self, fmt_string, *args):
149
"""Record a note without disrupting the progress bar."""
150
# XXX: shouldn't be here; put it in mutter or the ui instead
152
self.ui_factory.note(fmt_string % args)
154
self.ui_factory.note(fmt_string)
156
# TODO: deprecate this method; the model object shouldn't be concerned
157
# with whether it's shown or not. Most callers use this because they
158
# want to write some different non-progress output to the screen, but
159
# they should probably instead use a stream that's synchronized with
160
# the progress output. It may be there is a model-level use for
161
# saying "this task's not active at the moment" but I don't see it. --
157
# XXX: shouldn't be here; put it in mutter or the ui instead
163
158
if self.progress_view:
164
159
self.progress_view.clear()
166
161
self.ui_factory.clear_term()
164
@deprecated_function(deprecated_in((1, 16, 0)))
165
def ProgressBar(to_file=None, **kwargs):
166
"""Abstract factory"""
169
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
170
# An value of '' or not set reverts to standard processing
171
if requested_bar_type in (None, ''):
172
if _supports_progress(to_file):
173
return TTYProgressBar(to_file=to_file, **kwargs)
175
return DummyProgress(to_file=to_file, **kwargs)
177
# Minor sanitation to prevent spurious errors
178
requested_bar_type = requested_bar_type.lower().strip()
179
# TODO: jam 20060710 Arguably we shouldn't raise an exception
180
# but should instead just disable progress bars if we
181
# don't recognize the type
182
if requested_bar_type not in _progress_bar_types:
183
raise errors.InvalidProgressBarType(requested_bar_type,
184
_progress_bar_types.keys())
185
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
169
188
# NOTE: This is also deprecated; you should provide a ProgressView instead.
170
189
class _BaseProgressBar(object):
258
def note(self, fmt_string, *args, **kwargs):
259
"""See _BaseProgressBar.note()."""
232
261
def child_progress(self, **kwargs):
233
262
return DummyProgress(**kwargs)
265
class DotsProgressBar(_BaseProgressBar):
267
@deprecated_function(deprecated_in((1, 16, 0)))
268
def __init__(self, **kwargs):
269
_BaseProgressBar.__init__(self, **kwargs)
276
def update(self, msg=None, current_cnt=None, total_cnt=None):
277
if msg and msg != self.last_msg:
279
self.to_file.write('\n')
280
self.to_file.write(msg + ': ')
283
self.to_file.write('.')
287
self.to_file.write('\n')
290
def child_update(self, message, current, total):
294
class TTYProgressBar(_BaseProgressBar):
295
"""Progress bar display object.
297
Several options are available to control the display. These can
298
be passed as parameters to the constructor or assigned at any time:
301
Show percentage complete.
303
Show rotating baton. This ticks over on every update even
304
if the values don't change.
306
Show predicted time-to-completion.
310
Show numerical counts.
312
The output file should be in line-buffered or unbuffered mode.
316
@deprecated_function(deprecated_in((1, 16, 0)))
317
def __init__(self, **kwargs):
318
from bzrlib.osutils import terminal_width
319
_BaseProgressBar.__init__(self, **kwargs)
321
self.width = terminal_width()
322
self.last_updates = []
323
self._max_last_updates = 10
324
self.child_fraction = 0
325
self._have_output = False
327
def throttle(self, old_msg):
328
"""Return True if the bar was updated too recently"""
329
# time.time consistently takes 40/4000 ms = 0.01 ms.
330
# time.clock() is faster, but gives us CPU time, not wall-clock time
332
if self.start_time is not None and (now - self.start_time) < 1:
334
if old_msg != self.last_msg:
336
interval = now - self.last_update
338
if interval < self.MIN_PAUSE:
341
self.last_updates.append(now - self.last_update)
342
# Don't let the queue grow without bound
343
self.last_updates = self.last_updates[-self._max_last_updates:]
344
self.last_update = now
348
self.update(self.last_msg, self.last_cnt, self.last_total,
351
def child_update(self, message, current, total):
352
if current is not None and total != 0:
353
child_fraction = float(current) / total
354
if self.last_cnt is None:
356
elif self.last_cnt + child_fraction <= self.last_total:
357
self.child_fraction = child_fraction
358
if self.last_msg is None:
362
def update(self, msg, current_cnt=None, total_cnt=None,
364
"""Update and redraw progress bar.
369
if total_cnt is None:
370
total_cnt = self.last_total
375
if current_cnt > total_cnt:
376
total_cnt = current_cnt
378
## # optional corner case optimisation
379
## # currently does not seem to fire so costs more than saved.
380
## # trivial optimal case:
381
## # NB if callers are doing a clear and restore with
382
## # the saved values, this will prevent that:
383
## # in that case add a restore method that calls
384
## # _do_update or some such
385
## if (self.last_msg == msg and
386
## self.last_cnt == current_cnt and
387
## self.last_total == total_cnt and
388
## self.child_fraction == child_fraction):
394
old_msg = self.last_msg
395
# save these for the tick() function
397
self.last_cnt = current_cnt
398
self.last_total = total_cnt
399
self.child_fraction = child_fraction
401
# each function call takes 20ms/4000 = 0.005 ms,
402
# but multiple that by 4000 calls -> starts to cost.
403
# so anything to make this function call faster
404
# will improve base 'diff' time by up to 0.1 seconds.
405
if self.throttle(old_msg):
408
if self.show_eta and self.start_time and self.last_total:
409
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
410
self.last_total, last_updates = self.last_updates)
411
eta_str = " " + str_tdelta(eta)
415
if self.show_spinner:
416
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
420
# always update this; it's also used for the bar
423
if self.show_pct and self.last_total and self.last_cnt:
424
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
425
pct_str = ' (%5.1f%%)' % pct
429
if not self.show_count:
431
elif self.last_cnt is None:
433
elif self.last_total is None:
434
count_str = ' %i' % (self.last_cnt)
436
# make both fields the same size
437
t = '%i' % (self.last_total)
438
c = '%*i' % (len(t), self.last_cnt)
439
count_str = ' ' + c + '/' + t
442
# progress bar, if present, soaks up all remaining space
443
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
444
- len(eta_str) - len(count_str) - 3
447
# number of markers highlighted in bar
448
markers = int(round(float(cols) *
449
(self.last_cnt + self.child_fraction) / self.last_total))
450
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
452
# don't know total, so can't show completion.
453
# so just show an expanded spinning thingy
454
m = self.spin_pos % cols
455
ms = (' ' * m + '*').ljust(cols)
457
bar_str = '[' + ms + '] '
463
m = spin_str + bar_str + self.last_msg + count_str \
465
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
466
self._have_output = True
467
#self.to_file.flush()
470
if self._have_output:
471
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
472
self._have_output = False
473
#self.to_file.flush()
478
class ChildProgress(_BaseProgressBar):
479
"""A progress indicator that pushes its data to the parent"""
481
@deprecated_function(deprecated_in((1, 16, 0)))
482
def __init__(self, _stack, **kwargs):
483
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
484
self.parent = _stack.top()
487
self.child_fraction = 0
490
def update(self, msg, current_cnt=None, total_cnt=None):
491
self.current = current_cnt
492
if total_cnt is not None:
493
self.total = total_cnt
495
self.child_fraction = 0
498
def child_update(self, message, current, total):
499
if current is None or total == 0:
500
self.child_fraction = 0
502
self.child_fraction = float(current) / total
506
if self.current is None:
509
count = self.current+self.child_fraction
510
if count > self.total:
512
mutter('clamping count of %d to %d' % (count, self.total))
514
self.parent.child_update(self.message, count, self.total)
519
def note(self, *args, **kwargs):
520
self.parent.note(*args, **kwargs)
236
523
def str_tdelta(delt):
added
removed
bzrlib/progress.py
