70
def ProgressBar(to_file=sys.stderr, **kwargs):
61
def ProgressBar(to_file=None, **kwargs):
71
62
"""Abstract factory"""
72
65
if _supports_progress(to_file):
73
66
return TTYProgressBar(to_file=to_file, **kwargs)
75
68
return DotsProgressBar(to_file=to_file, **kwargs)
71
class ProgressBarStack(object):
72
"""A stack of progress bars."""
81
to_messages_file=None,
83
"""Setup the stack with the parameters the progress bars should have."""
86
if to_messages_file is None:
87
to_messages_file = sys.stdout
88
self._to_file = to_file
89
self._show_pct = show_pct
90
self._show_spinner = show_spinner
91
self._show_eta = show_eta
92
self._show_bar = show_bar
93
self._show_count = show_count
94
self._to_messages_file = to_messages_file
96
self._klass = klass or TTYProgressBar
99
if len(self._stack) != 0:
100
return self._stack[-1]
105
if len(self._stack) != 0:
106
return self._stack[0]
110
def get_nested(self):
111
"""Return a nested progress bar."""
112
if len(self._stack) == 0:
115
func = self.top().child_progress
116
new_bar = func(to_file=self._to_file,
117
show_pct=self._show_pct,
118
show_spinner=self._show_spinner,
119
show_eta=self._show_eta,
120
show_bar=self._show_bar,
121
show_count=self._show_count,
122
to_messages_file=self._to_messages_file,
124
self._stack.append(new_bar)
127
def return_pb(self, bar):
128
"""Return bar after its been used."""
129
if bar is not self._stack[-1]:
130
raise errors.MissingProgressBarFinish()
78
134
class _BaseProgressBar(object):
79
136
def __init__(self,
82
139
show_spinner=False,
143
to_messages_file=None,
86
145
object.__init__(self)
148
if to_messages_file is None:
149
to_messages_file = sys.stdout
87
150
self.to_file = to_file
151
self.to_messages_file = to_messages_file
89
152
self.last_msg = None
90
153
self.last_cnt = None
91
154
self.last_total = None
94
157
self.show_eta = show_eta
95
158
self.show_bar = show_bar
96
159
self.show_count = show_count
162
self.MIN_PAUSE = 0.1 # seconds
165
self.start_time = now
166
# next update should not throttle
167
self.last_update = now - self.MIN_PAUSE - 1
170
"""Return this bar to its progress stack."""
172
assert self._stack is not None
173
self._stack.return_pb(self)
175
def note(self, fmt_string, *args, **kwargs):
176
"""Record a note without disrupting the progress bar."""
178
self.to_messages_file.write(fmt_string % args)
179
self.to_messages_file.write('\n')
181
def child_progress(self, **kwargs):
182
return ChildProgress(**kwargs)
100
185
class DummyProgress(_BaseProgressBar):
108
193
def update(self, msg=None, current=None, total=None):
196
def child_update(self, message, current, total):
202
def note(self, fmt_string, *args, **kwargs):
203
"""See _BaseProgressBar.note()."""
205
def child_progress(self, **kwargs):
206
return DummyProgress(**kwargs)
115
209
class DotsProgressBar(_BaseProgressBar):
116
211
def __init__(self, **kwargs):
117
212
_BaseProgressBar.__init__(self, **kwargs)
118
213
self.last_msg = None
157
255
The output file should be in line-buffered or unbuffered mode.
159
257
SPIN_CHARS = r'/-\|'
160
MIN_PAUSE = 0.1 # seconds
163
260
def __init__(self, **kwargs):
261
from bzrlib.osutils import terminal_width
164
262
_BaseProgressBar.__init__(self, **kwargs)
165
263
self.spin_pos = 0
166
self.width = _width()
264
self.width = terminal_width()
167
265
self.start_time = None
168
self.last_update = None
266
self.last_updates = deque()
267
self.child_fraction = 0
171
270
def throttle(self):
172
271
"""Return True if the bar was updated too recently"""
174
if self.start_time is None:
175
self.start_time = self.last_update = now
178
interval = now - self.last_update
179
if interval > 0 and interval < self.MIN_PAUSE:
272
# time.time consistently takes 40/4000 ms = 0.01 ms.
273
# but every single update to the pb invokes it.
274
# so we use time.clock which takes 20/4000 ms = 0.005ms
275
# on the downside, time.clock() appears to have approximately
276
# 10ms granularity, so we treat a zero-time change as 'throttled.'
279
interval = now - self.last_update
281
if interval < self.MIN_PAUSE:
284
self.last_updates.append(now - self.last_update)
182
285
self.last_update = now
187
self.update(self.last_msg, self.last_cnt, self.last_total)
191
def update(self, msg, current_cnt=None, total_cnt=None):
289
self.update(self.last_msg, self.last_cnt, self.last_total,
292
def child_update(self, message, current, total):
293
if current is not None and total != 0:
294
child_fraction = float(current) / total
295
if self.last_cnt is None:
297
elif self.last_cnt + child_fraction <= self.last_total:
298
self.child_fraction = child_fraction
300
mutter('not updating child fraction')
301
if self.last_msg is None:
305
def update(self, msg, current_cnt=None, total_cnt=None,
192
307
"""Update and redraw progress bar."""
311
if total_cnt is None:
312
total_cnt = self.last_total
317
if current_cnt > total_cnt:
318
total_cnt = current_cnt
320
## # optional corner case optimisation
321
## # currently does not seem to fire so costs more than saved.
322
## # trivial optimal case:
323
## # NB if callers are doing a clear and restore with
324
## # the saved values, this will prevent that:
325
## # in that case add a restore method that calls
326
## # _do_update or some such
327
## if (self.last_msg == msg and
328
## self.last_cnt == current_cnt and
329
## self.last_total == total_cnt and
330
## self.child_fraction == child_fraction):
333
old_msg = self.last_msg
194
334
# save these for the tick() function
195
335
self.last_msg = msg
196
336
self.last_cnt = current_cnt
197
337
self.last_total = total_cnt
203
assert current_cnt <= total_cnt
205
assert current_cnt >= 0
207
if self.show_eta and self.start_time and total_cnt:
208
eta = get_eta(self.start_time, current_cnt, total_cnt)
338
self.child_fraction = child_fraction
340
# each function call takes 20ms/4000 = 0.005 ms,
341
# but multiple that by 4000 calls -> starts to cost.
342
# so anything to make this function call faster
343
# will improve base 'diff' time by up to 0.1 seconds.
344
if old_msg == self.last_msg and self.throttle():
347
if self.show_eta and self.start_time and self.last_total:
348
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
349
self.last_total, last_updates = self.last_updates)
209
350
eta_str = " " + str_tdelta(eta)
218
359
# always update this; it's also used for the bar
219
360
self.spin_pos += 1
221
if self.show_pct and total_cnt and current_cnt:
222
pct = 100.0 * current_cnt / total_cnt
362
if self.show_pct and self.last_total and self.last_cnt:
363
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
223
364
pct_str = ' (%5.1f%%)' % pct
227
368
if not self.show_count:
229
elif current_cnt is None:
370
elif self.last_cnt is None:
231
elif total_cnt is None:
232
count_str = ' %i' % (current_cnt)
372
elif self.last_total is None:
373
count_str = ' %i' % (self.last_cnt)
234
375
# make both fields the same size
235
t = '%i' % (total_cnt)
236
c = '%*i' % (len(t), current_cnt)
376
t = '%i' % (self.last_total)
377
c = '%*i' % (len(t), self.last_cnt)
237
378
count_str = ' ' + c + '/' + t
239
380
if self.show_bar:
240
381
# progress bar, if present, soaks up all remaining space
241
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
382
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
242
383
- len(eta_str) - len(count_str) - 3
245
386
# number of markers highlighted in bar
246
markers = int(round(float(cols) * current_cnt / total_cnt))
387
markers = int(round(float(cols) *
388
(self.last_cnt + self.child_fraction) / self.last_total))
247
389
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
249
391
# don't know total, so can't show completion.
260
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
402
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
262
404
assert len(m) < self.width
263
405
self.to_file.write('\r' + m.ljust(self.width - 1))
264
406
#self.to_file.flush()
268
409
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
269
410
#self.to_file.flush()
413
class ChildProgress(_BaseProgressBar):
414
"""A progress indicator that pushes its data to the parent"""
416
def __init__(self, _stack, **kwargs):
417
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
418
self.parent = _stack.top()
421
self.child_fraction = 0
424
def update(self, msg, current_cnt=None, total_cnt=None):
425
self.current = current_cnt
426
self.total = total_cnt
428
self.child_fraction = 0
431
def child_update(self, message, current, total):
432
if current is None or total == 0:
433
self.child_fraction = 0
435
self.child_fraction = float(current) / total
439
if self.current is None:
442
count = self.current+self.child_fraction
443
if count > self.total:
445
mutter('clamping count of %d to %d' % (count, self.total))
447
self.parent.child_update(self.message, count, self.total)
452
def note(self, *args, **kwargs):
453
self.parent.note(*args, **kwargs)
273
456
def str_tdelta(delt):
302
485
assert total_duration >= elapsed
487
if last_updates and len(last_updates) >= n_recent:
488
while len(last_updates) > n_recent:
489
last_updates.popleft()
490
avg = sum(last_updates) / float(len(last_updates))
491
time_left = avg * (total - current)
493
old_time_left = total_duration - elapsed
495
# We could return the average, or some other value here
496
return (time_left + old_time_left) / 2
304
498
return total_duration - elapsed
501
class ProgressPhase(object):
502
"""Update progress object with the current phase"""
503
def __init__(self, message, total, pb):
504
object.__init__(self)
506
self.message = message
508
self.cur_phase = None
510
def next_phase(self):
511
if self.cur_phase is None:
515
assert self.cur_phase < self.total
516
self.pb.update(self.message, self.cur_phase, self.total)
309
521
result = doctest.testmod()
added
removed
bzrlib/progress.py
