1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical <canonical.com>
2
# Copyright (C) 2005 Canonical <canonical.com>
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
42
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
46
"""Return estimated terminal width.
48
TODO: Do something smart on Windows?
50
TODO: Is there anything that gets a better update when the window
51
is resized while the program is running?
54
return int(os.environ['COLUMNS'])
55
except (IndexError, KeyError, ValueError):
49
59
def _supports_progress(f):
66
76
return DotsProgressBar(to_file=to_file, **kwargs)
69
class ProgressBarStack(object):
70
"""A stack of progress bars."""
79
to_messages_file=sys.stdout,
81
"""Setup the stack with the parameters the progress bars should have."""
82
self._to_file = to_file
83
self._show_pct = show_pct
84
self._show_spinner = show_spinner
85
self._show_eta = show_eta
86
self._show_bar = show_bar
87
self._show_count = show_count
88
self._to_messages_file = to_messages_file
90
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
def get_nested(self):
105
"""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,
118
self._stack.append(new_bar)
121
def return_pb(self, bar):
122
"""Return bar after its been used."""
123
if bar is not self._stack[-1]:
124
raise errors.MissingProgressBarFinish()
128
79
class _BaseProgressBar(object):
130
80
def __init__(self,
131
81
to_file=sys.stderr,
133
83
show_spinner=False,
137
to_messages_file=sys.stdout,
139
87
object.__init__(self)
140
88
self.to_file = to_file
141
self.to_messages_file = to_messages_file
142
90
self.last_msg = None
143
91
self.last_cnt = None
144
92
self.last_total = None
147
95
self.show_eta = show_eta
148
96
self.show_bar = show_bar
149
97
self.show_count = show_count
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
160
"""Return this bar to its progress stack."""
162
assert self._stack is not None
163
self._stack.return_pb(self)
165
def note(self, fmt_string, *args, **kwargs):
166
"""Record a note without disrupting the progress bar."""
168
self.to_messages_file.write(fmt_string % args)
169
self.to_messages_file.write('\n')
171
def child_progress(self, **kwargs):
172
return ChildProgress(**kwargs)
175
101
class DummyProgress(_BaseProgressBar):
183
109
def update(self, msg=None, current=None, total=None):
186
def child_update(self, message, current, total):
192
def note(self, fmt_string, *args, **kwargs):
193
"""See _BaseProgressBar.note()."""
195
def child_progress(self, **kwargs):
196
return DummyProgress(**kwargs)
198
116
class DotsProgressBar(_BaseProgressBar):
200
117
def __init__(self, **kwargs):
201
118
_BaseProgressBar.__init__(self, **kwargs)
202
119
self.last_msg = None
220
137
self.to_file.write('\n')
222
def child_update(self, message, current, total):
225
140
class TTYProgressBar(_BaseProgressBar):
226
141
"""Progress bar display object.
243
158
The output file should be in line-buffered or unbuffered mode.
245
160
SPIN_CHARS = r'/-\|'
161
MIN_PAUSE = 0.1 # seconds
248
164
def __init__(self, **kwargs):
249
from bzrlib.osutils import terminal_width
250
165
_BaseProgressBar.__init__(self, **kwargs)
251
166
self.spin_pos = 0
252
self.width = terminal_width()
167
self.width = _width()
253
168
self.start_time = None
169
self.last_update = None
254
170
self.last_updates = deque()
255
self.child_fraction = 0
258
173
def throttle(self):
259
174
"""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:
176
if self.start_time is None:
177
self.start_time = self.last_update = now
180
interval = now - self.last_update
181
if interval > 0 and interval < self.MIN_PAUSE:
272
184
self.last_updates.append(now - self.last_update)
273
185
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,
190
self.update(self.last_msg, self.last_cnt, self.last_total)
194
def update(self, msg, current_cnt=None, total_cnt=None):
297
195
"""Update and redraw progress bar."""
299
197
if current_cnt < 0:
302
200
if current_cnt > total_cnt:
303
201
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
old_msg = self.last_msg
319
203
# save these for the tick() function
320
204
self.last_msg = msg
321
205
self.last_cnt = current_cnt
322
206
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
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)
211
if self.show_eta and self.start_time and total_cnt:
212
eta = get_eta(self.start_time, current_cnt, total_cnt,
213
last_updates = self.last_updates)
335
214
eta_str = " " + str_tdelta(eta)
344
223
# always update this; it's also used for the bar
345
224
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)
226
if self.show_pct and total_cnt and current_cnt:
227
pct = 100.0 * current_cnt / total_cnt
349
228
pct_str = ' (%5.1f%%)' % pct
353
232
if not self.show_count:
355
elif self.last_cnt is None:
234
elif current_cnt is None:
357
elif self.last_total is None:
358
count_str = ' %i' % (self.last_cnt)
236
elif total_cnt is None:
237
count_str = ' %i' % (current_cnt)
360
239
# make both fields the same size
361
t = '%i' % (self.last_total)
362
c = '%*i' % (len(t), self.last_cnt)
240
t = '%i' % (total_cnt)
241
c = '%*i' % (len(t), current_cnt)
363
242
count_str = ' ' + c + '/' + t
365
244
if self.show_bar:
366
245
# progress bar, if present, soaks up all remaining space
367
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
246
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
368
247
- len(eta_str) - len(count_str) - 3
371
250
# number of markers highlighted in bar
372
markers = int(round(float(cols) *
373
(self.last_cnt + self.child_fraction) / self.last_total))
251
markers = int(round(float(cols) * current_cnt / total_cnt))
374
252
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
376
254
# don't know total, so can't show completion.
387
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
265
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
389
267
assert len(m) < self.width
390
268
self.to_file.write('\r' + m.ljust(self.width - 1))
391
269
#self.to_file.flush()
394
273
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
395
274
#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
278
def str_tdelta(delt):
482
320
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
325
result = doctest.testmod()
added
removed
bzrlib/progress.py
