127
157
own_fraction = 0.0
128
158
return self._parent_task._overall_completion_fraction(own_fraction)
160
@deprecated_method(deprecated_in((2, 1, 0)))
130
161
def note(self, fmt_string, *args):
131
"""Record a note without disrupting the progress bar."""
132
# XXX: shouldn't be here; put it in mutter or the ui instead
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.
134
169
self.ui_factory.note(fmt_string % args)
136
171
self.ui_factory.note(fmt_string)
139
# XXX: shouldn't be here; put it in mutter or the ui instead
140
self.ui_factory.clear_term()
143
def ProgressBar(to_file=None, **kwargs):
144
"""Abstract factory"""
147
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
148
# An value of '' or not set reverts to standard processing
149
if requested_bar_type in (None, ''):
150
if _supports_progress(to_file):
151
return TTYProgressBar(to_file=to_file, **kwargs)
153
return DummyProgress(to_file=to_file, **kwargs)
155
# Minor sanitation to prevent spurious errors
156
requested_bar_type = requested_bar_type.lower().strip()
157
# TODO: jam 20060710 Arguably we shouldn't raise an exception
158
# but should instead just disable progress bars if we
159
# don't recognize the type
160
if requested_bar_type not in _progress_bar_types:
161
raise errors.InvalidProgressBarType(requested_bar_type,
162
_progress_bar_types.keys())
163
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
166
class ProgressBarStack(object):
167
"""A stack of progress bars.
169
This class is deprecated: instead, ask the ui factory for a new progress
170
task and finish it when it's done.
173
@deprecated_method(deprecated_in((1, 12, 0)))
181
to_messages_file=None,
183
"""Setup the stack with the parameters the progress bars should have."""
186
if to_messages_file is None:
187
to_messages_file = sys.stdout
188
self._to_file = to_file
189
self._show_pct = show_pct
190
self._show_spinner = show_spinner
191
self._show_eta = show_eta
192
self._show_bar = show_bar
193
self._show_count = show_count
194
self._to_messages_file = to_messages_file
196
self._klass = klass or ProgressBar
199
if len(self._stack) != 0:
200
return self._stack[-1]
205
if len(self._stack) != 0:
206
return self._stack[0]
210
def get_nested(self):
211
"""Return a nested progress bar."""
212
if len(self._stack) == 0:
215
func = self.top().child_progress
216
new_bar = func(to_file=self._to_file,
217
show_pct=self._show_pct,
218
show_spinner=self._show_spinner,
219
show_eta=self._show_eta,
220
show_bar=self._show_bar,
221
show_count=self._show_count,
222
to_messages_file=self._to_messages_file,
224
self._stack.append(new_bar)
227
def return_pb(self, bar):
228
"""Return bar after its been used."""
229
if bar is not self._stack[-1]:
230
warnings.warn("%r is not currently active" % (bar,))
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. --
181
if self.progress_view:
182
self.progress_view.clear()
184
self.ui_factory.clear_term()
187
# NOTE: This is also deprecated; you should provide a ProgressView instead.
235
188
class _BaseProgressBar(object):
237
190
def __init__(self,
307
260
return DummyProgress(**kwargs)
310
class DotsProgressBar(_BaseProgressBar):
312
def __init__(self, **kwargs):
313
_BaseProgressBar.__init__(self, **kwargs)
320
def update(self, msg=None, current_cnt=None, total_cnt=None):
321
if msg and msg != self.last_msg:
323
self.to_file.write('\n')
324
self.to_file.write(msg + ': ')
327
self.to_file.write('.')
331
self.to_file.write('\n')
334
def child_update(self, message, current, total):
340
class TTYProgressBar(_BaseProgressBar):
341
"""Progress bar display object.
343
Several options are available to control the display. These can
344
be passed as parameters to the constructor or assigned at any time:
347
Show percentage complete.
349
Show rotating baton. This ticks over on every update even
350
if the values don't change.
352
Show predicted time-to-completion.
356
Show numerical counts.
358
The output file should be in line-buffered or unbuffered mode.
363
def __init__(self, **kwargs):
364
from bzrlib.osutils import terminal_width
365
_BaseProgressBar.__init__(self, **kwargs)
367
self.width = terminal_width()
368
self.last_updates = []
369
self._max_last_updates = 10
370
self.child_fraction = 0
371
self._have_output = False
373
def throttle(self, old_msg):
374
"""Return True if the bar was updated too recently"""
375
# time.time consistently takes 40/4000 ms = 0.01 ms.
376
# time.clock() is faster, but gives us CPU time, not wall-clock time
378
if self.start_time is not None and (now - self.start_time) < 1:
380
if old_msg != self.last_msg:
382
interval = now - self.last_update
384
if interval < self.MIN_PAUSE:
387
self.last_updates.append(now - self.last_update)
388
# Don't let the queue grow without bound
389
self.last_updates = self.last_updates[-self._max_last_updates:]
390
self.last_update = now
394
self.update(self.last_msg, self.last_cnt, self.last_total,
397
def child_update(self, message, current, total):
398
if current is not None and total != 0:
399
child_fraction = float(current) / total
400
if self.last_cnt is None:
402
elif self.last_cnt + child_fraction <= self.last_total:
403
self.child_fraction = child_fraction
404
if self.last_msg is None:
408
def update(self, msg, current_cnt=None, total_cnt=None,
410
"""Update and redraw progress bar.
415
if total_cnt is None:
416
total_cnt = self.last_total
421
if current_cnt > total_cnt:
422
total_cnt = current_cnt
424
## # optional corner case optimisation
425
## # currently does not seem to fire so costs more than saved.
426
## # trivial optimal case:
427
## # NB if callers are doing a clear and restore with
428
## # the saved values, this will prevent that:
429
## # in that case add a restore method that calls
430
## # _do_update or some such
431
## if (self.last_msg == msg and
432
## self.last_cnt == current_cnt and
433
## self.last_total == total_cnt and
434
## self.child_fraction == child_fraction):
440
old_msg = self.last_msg
441
# save these for the tick() function
443
self.last_cnt = current_cnt
444
self.last_total = total_cnt
445
self.child_fraction = child_fraction
447
# each function call takes 20ms/4000 = 0.005 ms,
448
# but multiple that by 4000 calls -> starts to cost.
449
# so anything to make this function call faster
450
# will improve base 'diff' time by up to 0.1 seconds.
451
if self.throttle(old_msg):
454
if self.show_eta and self.start_time and self.last_total:
455
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
456
self.last_total, last_updates = self.last_updates)
457
eta_str = " " + str_tdelta(eta)
461
if self.show_spinner:
462
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
466
# always update this; it's also used for the bar
469
if self.show_pct and self.last_total and self.last_cnt:
470
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
471
pct_str = ' (%5.1f%%)' % pct
475
if not self.show_count:
477
elif self.last_cnt is None:
479
elif self.last_total is None:
480
count_str = ' %i' % (self.last_cnt)
482
# make both fields the same size
483
t = '%i' % (self.last_total)
484
c = '%*i' % (len(t), self.last_cnt)
485
count_str = ' ' + c + '/' + t
488
# progress bar, if present, soaks up all remaining space
489
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
490
- len(eta_str) - len(count_str) - 3
493
# number of markers highlighted in bar
494
markers = int(round(float(cols) *
495
(self.last_cnt + self.child_fraction) / self.last_total))
496
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
498
# don't know total, so can't show completion.
499
# so just show an expanded spinning thingy
500
m = self.spin_pos % cols
501
ms = (' ' * m + '*').ljust(cols)
503
bar_str = '[' + ms + '] '
509
m = spin_str + bar_str + self.last_msg + count_str \
511
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
512
self._have_output = True
513
#self.to_file.flush()
516
if self._have_output:
517
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
518
self._have_output = False
519
#self.to_file.flush()
524
class ChildProgress(_BaseProgressBar):
525
"""A progress indicator that pushes its data to the parent"""
527
def __init__(self, _stack, **kwargs):
528
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
529
self.parent = _stack.top()
532
self.child_fraction = 0
535
def update(self, msg, current_cnt=None, total_cnt=None):
536
self.current = current_cnt
537
if total_cnt is not None:
538
self.total = total_cnt
540
self.child_fraction = 0
543
def child_update(self, message, current, total):
544
if current is None or total == 0:
545
self.child_fraction = 0
547
self.child_fraction = float(current) / total
551
if self.current is None:
554
count = self.current+self.child_fraction
555
if count > self.total:
557
mutter('clamping count of %d to %d' % (count, self.total))
559
self.parent.child_update(self.message, count, self.total)
564
def note(self, *args, **kwargs):
565
self.parent.note(*args, **kwargs)
568
class InstrumentedProgress(TTYProgressBar):
569
"""TTYProgress variant that tracks outcomes"""
571
def __init__(self, *args, **kwargs):
572
self.always_throttled = True
573
self.never_throttle = False
574
TTYProgressBar.__init__(self, *args, **kwargs)
576
def throttle(self, old_message):
577
if self.never_throttle:
580
result = TTYProgressBar.throttle(self, old_message)
582
self.always_throttled = False
585
263
def str_tdelta(delt):
added
removed
bzrlib/progress.py
