1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005 Canonical <canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2
# Copyright (C) 2005, 2006 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
19
"""Simple text-mode progress indicator.
35
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
36
# when the rate is unpredictable
45
"""Return estimated terminal width.
47
TODO: Do something smart on Windows?
49
TODO: Is there anything that gets a better update when the window
50
is resized while the program is running?
53
return int(os.environ['COLUMNS'])
54
except (IndexError, KeyError, ValueError):
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
49
from bzrlib.trace import mutter
58
52
def _supports_progress(f):
59
if not hasattr(f, 'isatty'):
53
isatty = getattr(f, 'isatty', None)
63
58
if os.environ.get('TERM') == 'dumb':
64
59
# e.g. emacs compile window
70
def ProgressBar(to_file=sys.stderr, **kwargs):
64
_progress_bar_types = {}
67
def ProgressBar(to_file=None, **kwargs):
71
68
"""Abstract factory"""
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
71
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
72
# An value of '' or not set reverts to standard processing
73
if requested_bar_type in (None, ''):
74
if _supports_progress(to_file):
75
return TTYProgressBar(to_file=to_file, **kwargs)
77
return DotsProgressBar(to_file=to_file, **kwargs)
75
return DotsProgressBar(to_file=to_file, **kwargs)
79
# Minor sanitation to prevent spurious errors
80
requested_bar_type = requested_bar_type.lower().strip()
81
# TODO: jam 20060710 Arguably we shouldn't raise an exception
82
# but should instead just disable progress bars if we
83
# don't recognize the type
84
if requested_bar_type not in _progress_bar_types:
85
raise errors.InvalidProgressBarType(requested_bar_type,
86
_progress_bar_types.keys())
87
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
90
class ProgressBarStack(object):
91
"""A stack of progress bars."""
100
to_messages_file=None,
102
"""Setup the stack with the parameters the progress bars should have."""
105
if to_messages_file is None:
106
to_messages_file = sys.stdout
107
self._to_file = to_file
108
self._show_pct = show_pct
109
self._show_spinner = show_spinner
110
self._show_eta = show_eta
111
self._show_bar = show_bar
112
self._show_count = show_count
113
self._to_messages_file = to_messages_file
115
self._klass = klass or ProgressBar
118
if len(self._stack) != 0:
119
return self._stack[-1]
124
if len(self._stack) != 0:
125
return self._stack[0]
129
def get_nested(self):
130
"""Return a nested progress bar."""
131
if len(self._stack) == 0:
134
func = self.top().child_progress
135
new_bar = func(to_file=self._to_file,
136
show_pct=self._show_pct,
137
show_spinner=self._show_spinner,
138
show_eta=self._show_eta,
139
show_bar=self._show_bar,
140
show_count=self._show_count,
141
to_messages_file=self._to_messages_file,
143
self._stack.append(new_bar)
146
def return_pb(self, bar):
147
"""Return bar after its been used."""
148
if bar is not self._stack[-1]:
149
raise errors.MissingProgressBarFinish()
78
153
class _BaseProgressBar(object):
79
155
def __init__(self,
82
158
show_spinner=False,
162
to_messages_file=None,
86
164
object.__init__(self)
167
if to_messages_file is None:
168
to_messages_file = sys.stdout
87
169
self.to_file = to_file
170
self.to_messages_file = to_messages_file
89
171
self.last_msg = None
90
172
self.last_cnt = None
91
173
self.last_total = None
94
176
self.show_eta = show_eta
95
177
self.show_bar = show_bar
96
178
self.show_count = show_count
181
self.MIN_PAUSE = 0.1 # seconds
184
self.start_time = now
185
# next update should not throttle
186
self.last_update = now - self.MIN_PAUSE - 1
189
"""Return this bar to its progress stack."""
191
assert self._stack is not None
192
self._stack.return_pb(self)
194
def note(self, fmt_string, *args, **kwargs):
195
"""Record a note without disrupting the progress bar."""
197
self.to_messages_file.write(fmt_string % args)
198
self.to_messages_file.write('\n')
200
def child_progress(self, **kwargs):
201
return ChildProgress(**kwargs)
204
class DummyProgress(_BaseProgressBar):
205
"""Progress-bar standin that does nothing.
207
This can be used as the default argument for methods that
208
take an optional progress indicator."""
212
def update(self, msg=None, current=None, total=None):
215
def child_update(self, message, current, total):
221
def note(self, fmt_string, *args, **kwargs):
222
"""See _BaseProgressBar.note()."""
224
def child_progress(self, **kwargs):
225
return DummyProgress(**kwargs)
228
_progress_bar_types['dummy'] = DummyProgress
229
_progress_bar_types['none'] = DummyProgress
100
232
class DotsProgressBar(_BaseProgressBar):
101
234
def __init__(self, **kwargs):
102
235
_BaseProgressBar.__init__(self, **kwargs)
103
236
self.last_msg = None
142
281
The output file should be in line-buffered or unbuffered mode.
144
283
SPIN_CHARS = r'/-\|'
145
MIN_PAUSE = 0.1 # seconds
148
286
def __init__(self, **kwargs):
287
from bzrlib.osutils import terminal_width
149
288
_BaseProgressBar.__init__(self, **kwargs)
150
289
self.spin_pos = 0
151
self.width = _width()
152
self.start_time = None
153
self.last_update = None
290
self.width = terminal_width()
291
self.last_updates = []
292
self._max_last_updates = 10
293
self.child_fraction = 0
294
self._have_output = False
297
def throttle(self, old_msg):
157
298
"""Return True if the bar was updated too recently"""
159
if self.start_time is None:
160
self.start_time = self.last_update = now
299
# time.time consistently takes 40/4000 ms = 0.01 ms.
300
# but every single update to the pb invokes it.
301
# so we use time.clock which takes 20/4000 ms = 0.005ms
302
# on the downside, time.clock() appears to have approximately
303
# 10ms granularity, so we treat a zero-time change as 'throttled.'
305
if self.start_time is not None and (now - self.start_time) < 1:
307
if old_msg != self.last_msg:
163
interval = now - self.last_update
164
if interval > 0 and interval < self.MIN_PAUSE:
309
interval = now - self.last_update
311
if interval < self.MIN_PAUSE:
314
self.last_updates.append(now - self.last_update)
315
# Don't let the queue grow without bound
316
self.last_updates = self.last_updates[-self._max_last_updates:]
167
317
self.last_update = now
172
self.update(self.last_msg, self.last_cnt, self.last_total)
176
def update(self, msg, current_cnt=None, total_cnt=None):
321
self.update(self.last_msg, self.last_cnt, self.last_total,
324
def child_update(self, message, current, total):
325
if current is not None and total != 0:
326
child_fraction = float(current) / total
327
if self.last_cnt is None:
329
elif self.last_cnt + child_fraction <= self.last_total:
330
self.child_fraction = child_fraction
332
mutter('not updating child fraction')
333
if self.last_msg is None:
337
def update(self, msg, current_cnt=None, total_cnt=None,
177
339
"""Update and redraw progress bar."""
343
if total_cnt is None:
344
total_cnt = self.last_total
349
if current_cnt > total_cnt:
350
total_cnt = current_cnt
352
## # optional corner case optimisation
353
## # currently does not seem to fire so costs more than saved.
354
## # trivial optimal case:
355
## # NB if callers are doing a clear and restore with
356
## # the saved values, this will prevent that:
357
## # in that case add a restore method that calls
358
## # _do_update or some such
359
## if (self.last_msg == msg and
360
## self.last_cnt == current_cnt and
361
## self.last_total == total_cnt and
362
## self.child_fraction == child_fraction):
365
old_msg = self.last_msg
179
366
# save these for the tick() function
180
367
self.last_msg = msg
181
368
self.last_cnt = current_cnt
182
369
self.last_total = total_cnt
188
assert current_cnt <= total_cnt
190
assert current_cnt >= 0
192
if self.show_eta and self.start_time and total_cnt:
193
eta = get_eta(self.start_time, current_cnt, total_cnt)
370
self.child_fraction = child_fraction
372
# each function call takes 20ms/4000 = 0.005 ms,
373
# but multiple that by 4000 calls -> starts to cost.
374
# so anything to make this function call faster
375
# will improve base 'diff' time by up to 0.1 seconds.
376
if self.throttle(old_msg):
379
if self.show_eta and self.start_time and self.last_total:
380
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
381
self.last_total, last_updates = self.last_updates)
194
382
eta_str = " " + str_tdelta(eta)
203
391
# always update this; it's also used for the bar
204
392
self.spin_pos += 1
206
if self.show_pct and total_cnt and current_cnt:
207
pct = 100.0 * current_cnt / total_cnt
394
if self.show_pct and self.last_total and self.last_cnt:
395
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
208
396
pct_str = ' (%5.1f%%)' % pct
212
400
if not self.show_count:
214
elif current_cnt is None:
402
elif self.last_cnt is None:
216
elif total_cnt is None:
217
count_str = ' %i' % (current_cnt)
404
elif self.last_total is None:
405
count_str = ' %i' % (self.last_cnt)
219
407
# make both fields the same size
220
t = '%i' % (total_cnt)
221
c = '%*i' % (len(t), current_cnt)
408
t = '%i' % (self.last_total)
409
c = '%*i' % (len(t), self.last_cnt)
222
410
count_str = ' ' + c + '/' + t
224
412
if self.show_bar:
225
413
# progress bar, if present, soaks up all remaining space
226
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
414
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
227
415
- len(eta_str) - len(count_str) - 3
230
418
# number of markers highlighted in bar
231
markers = int(round(float(cols) * current_cnt / total_cnt))
419
markers = int(round(float(cols) *
420
(self.last_cnt + self.child_fraction) / self.last_total))
232
421
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
234
423
# don't know total, so can't show completion.
245
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
434
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
247
436
assert len(m) < self.width
248
437
self.to_file.write('\r' + m.ljust(self.width - 1))
438
self._have_output = True
249
439
#self.to_file.flush()
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
442
if self._have_output:
443
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
444
self._have_output = False
254
445
#self.to_file.flush()
448
_progress_bar_types['tty'] = TTYProgressBar
451
class ChildProgress(_BaseProgressBar):
452
"""A progress indicator that pushes its data to the parent"""
454
def __init__(self, _stack, **kwargs):
455
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
456
self.parent = _stack.top()
459
self.child_fraction = 0
462
def update(self, msg, current_cnt=None, total_cnt=None):
463
self.current = current_cnt
464
self.total = total_cnt
466
self.child_fraction = 0
469
def child_update(self, message, current, total):
470
if current is None or total == 0:
471
self.child_fraction = 0
473
self.child_fraction = float(current) / total
477
if self.current is None:
480
count = self.current+self.child_fraction
481
if count > self.total:
483
mutter('clamping count of %d to %d' % (count, self.total))
485
self.parent.child_update(self.message, count, self.total)
490
def note(self, *args, **kwargs):
491
self.parent.note(*args, **kwargs)
258
494
def str_tdelta(delt):
287
523
assert total_duration >= elapsed
525
if last_updates and len(last_updates) >= n_recent:
526
avg = sum(last_updates) / float(len(last_updates))
527
time_left = avg * (total - current)
529
old_time_left = total_duration - elapsed
531
# We could return the average, or some other value here
532
return (time_left + old_time_left) / 2
289
534
return total_duration - elapsed
537
class ProgressPhase(object):
538
"""Update progress object with the current phase"""
539
def __init__(self, message, total, pb):
540
object.__init__(self)
542
self.message = message
544
self.cur_phase = None
546
def next_phase(self):
547
if self.cur_phase is None:
551
assert self.cur_phase < self.total
552
self.pb.update(self.message, self.cur_phase, self.total)
294
557
result = doctest.testmod()
added
removed
bzrlib/progress.py
