90
89
self._klass = klass or TTYProgressBar
93
if len(self._stack) != 0:
94
return self._stack[-1]
99
if len(self._stack) != 0:
100
return self._stack[0]
104
91
def get_nested(self):
105
92
"""Return a nested progress bar."""
106
if len(self._stack) == 0:
109
func = self.top().child_progress
110
new_bar = func(to_file=self._to_file,
111
show_pct=self._show_pct,
112
show_spinner=self._show_spinner,
113
show_eta=self._show_eta,
114
show_bar=self._show_bar,
115
show_count=self._show_count,
116
to_messages_file=self._to_messages_file,
93
# initial implementation - return a new bar each time.
94
new_bar = self._klass(to_file=self._to_file,
95
show_pct=self._show_pct,
96
show_spinner=self._show_spinner,
97
show_eta=self._show_eta,
98
show_bar=self._show_bar,
99
show_count=self._show_count,
100
to_messages_file=self._to_messages_file,
118
102
self._stack.append(new_bar)
148
132
self.show_bar = show_bar
149
133
self.show_count = show_count
150
134
self._stack = _stack
152
self.MIN_PAUSE = 0.1 # seconds
155
self.start_time = now
156
# next update should not throttle
157
self.last_update = now - self.MIN_PAUSE - 1
159
136
def finished(self):
160
137
"""Return this bar to its progress stack."""
168
145
self.to_messages_file.write(fmt_string % args)
169
146
self.to_messages_file.write('\n')
171
def child_progress(self, **kwargs):
172
return ChildProgress(**kwargs)
175
149
class DummyProgress(_BaseProgressBar):
176
150
"""Progress-bar standin that does nothing.
183
157
def update(self, msg=None, current=None, total=None):
186
def child_update(self, message, current, total):
192
163
def note(self, fmt_string, *args, **kwargs):
193
164
"""See _BaseProgressBar.note()."""
195
def child_progress(self, **kwargs):
196
return DummyProgress(**kwargs)
198
167
class DotsProgressBar(_BaseProgressBar):
220
189
self.to_file.write('\n')
222
def child_update(self, message, current, total):
225
192
class TTYProgressBar(_BaseProgressBar):
226
193
"""Progress bar display object.
251
219
self.spin_pos = 0
252
220
self.width = terminal_width()
253
221
self.start_time = None
222
self.last_update = None
254
223
self.last_updates = deque()
255
self.child_fraction = 0
258
226
def throttle(self):
259
227
"""Return True if the bar was updated too recently"""
260
# time.time consistently takes 40/4000 ms = 0.01 ms.
261
# but every single update to the pb invokes it.
262
# so we use time.clock which takes 20/4000 ms = 0.005ms
263
# on the downside, time.clock() appears to have approximately
264
# 10ms granularity, so we treat a zero-time change as 'throttled.'
267
interval = now - self.last_update
269
if interval < self.MIN_PAUSE:
229
if self.start_time is None:
230
self.start_time = self.last_update = now
233
interval = now - self.last_update
234
if interval > 0 and interval < self.MIN_PAUSE:
272
237
self.last_updates.append(now - self.last_update)
273
238
self.last_update = now
278
self.update(self.last_msg, self.last_cnt, self.last_total,
281
def child_update(self, message, current, total):
282
if current is not None and total != 0:
283
child_fraction = float(current) / total
284
if self.last_cnt is None:
286
elif self.last_cnt + child_fraction <= self.last_total:
287
self.child_fraction = child_fraction
289
mutter('not updating child fraction')
290
if self.last_msg is None:
295
def update(self, msg, current_cnt=None, total_cnt=None,
243
self.update(self.last_msg, self.last_cnt, self.last_total)
247
def update(self, msg, current_cnt=None, total_cnt=None):
297
248
"""Update and redraw progress bar."""
299
250
if current_cnt < 0:
302
253
if current_cnt > total_cnt:
303
254
total_cnt = current_cnt
305
## # optional corner case optimisation
306
## # currently does not seem to fire so costs more than saved.
307
## # trivial optimal case:
308
## # NB if callers are doing a clear and restore with
309
## # the saved values, this will prevent that:
310
## # in that case add a restore method that calls
311
## # _do_update or some such
312
## if (self.last_msg == msg and
313
## self.last_cnt == current_cnt and
314
## self.last_total == total_cnt and
315
## self.child_fraction == child_fraction):
318
256
old_msg = self.last_msg
319
257
# save these for the tick() function
320
258
self.last_msg = msg
321
259
self.last_cnt = current_cnt
322
260
self.last_total = total_cnt
323
self.child_fraction = child_fraction
325
# each function call takes 20ms/4000 = 0.005 ms,
326
# but multiple that by 4000 calls -> starts to cost.
327
# so anything to make this function call faster
328
# will improve base 'diff' time by up to 0.1 seconds.
329
262
if old_msg == self.last_msg and self.throttle():
332
if self.show_eta and self.start_time and self.last_total:
333
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
334
self.last_total, last_updates = self.last_updates)
265
if self.show_eta and self.start_time and total_cnt:
266
eta = get_eta(self.start_time, current_cnt, total_cnt,
267
last_updates = self.last_updates)
335
268
eta_str = " " + str_tdelta(eta)
344
277
# always update this; it's also used for the bar
345
278
self.spin_pos += 1
347
if self.show_pct and self.last_total and self.last_cnt:
348
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
280
if self.show_pct and total_cnt and current_cnt:
281
pct = 100.0 * current_cnt / total_cnt
349
282
pct_str = ' (%5.1f%%)' % pct
353
286
if not self.show_count:
355
elif self.last_cnt is None:
288
elif current_cnt is None:
357
elif self.last_total is None:
358
count_str = ' %i' % (self.last_cnt)
290
elif total_cnt is None:
291
count_str = ' %i' % (current_cnt)
360
293
# make both fields the same size
361
t = '%i' % (self.last_total)
362
c = '%*i' % (len(t), self.last_cnt)
294
t = '%i' % (total_cnt)
295
c = '%*i' % (len(t), current_cnt)
363
296
count_str = ' ' + c + '/' + t
365
298
if self.show_bar:
366
299
# progress bar, if present, soaks up all remaining space
367
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
300
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
368
301
- len(eta_str) - len(count_str) - 3
371
304
# number of markers highlighted in bar
372
markers = int(round(float(cols) *
373
(self.last_cnt + self.child_fraction) / self.last_total))
305
markers = int(round(float(cols) * current_cnt / total_cnt))
374
306
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
376
308
# don't know total, so can't show completion.
387
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
319
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
389
321
assert len(m) < self.width
390
322
self.to_file.write('\r' + m.ljust(self.width - 1))
394
326
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
395
327
#self.to_file.flush()
398
class ChildProgress(_BaseProgressBar):
399
"""A progress indicator that pushes its data to the parent"""
400
def __init__(self, _stack, **kwargs):
401
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
402
self.parent = _stack.top()
405
self.child_fraction = 0
408
def update(self, msg, current_cnt=None, total_cnt=None):
409
self.current = current_cnt
410
self.total = total_cnt
412
self.child_fraction = 0
415
def child_update(self, message, current, total):
416
if current is None or total == 0:
417
self.child_fraction = 0
419
self.child_fraction = float(current) / total
423
if self.current is None:
426
count = self.current+self.child_fraction
427
if count > self.total:
429
mutter('clamping count of %d to %d' % (count, self.total))
431
self.parent.child_update(self.message, count, self.total)
436
def note(self, *args, **kwargs):
437
self.parent.note(*args, **kwargs)
440
330
def str_tdelta(delt):
482
372
return total_duration - elapsed
485
class ProgressPhase(object):
486
"""Update progress object with the current phase"""
487
def __init__(self, message, total, pb):
488
object.__init__(self)
490
self.message = message
492
self.cur_phase = None
494
def next_phase(self):
495
if self.cur_phase is None:
499
assert self.cur_phase < self.total
500
self.pb.update(self.message, self.cur_phase, self.total)
505
377
result = doctest.testmod()
added
removed
bzrlib/progress.py
