1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
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
2
# Copyright (C) 2005, 2006 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
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
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
49
from bzrlib.trace import mutter
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
52
49
def _supports_progress(f):
53
"""Detect if we can use pretty progress bars on the output stream f.
55
If this returns true we expect that a human may be looking at that
56
output, and that we can repaint a line to update it.
58
isatty = getattr(f, 'isatty', None)
50
if not hasattr(f, 'isatty'):
63
54
if os.environ.get('TERM') == 'dumb':
64
55
# e.g. emacs compile window
69
_progress_bar_types = {}
72
def ProgressBar(to_file=None, **kwargs):
61
def ProgressBar(to_file=sys.stderr, **kwargs):
73
62
"""Abstract factory"""
76
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
77
# An value of '' or not set reverts to standard processing
78
if requested_bar_type in (None, ''):
79
if _supports_progress(to_file):
80
return TTYProgressBar(to_file=to_file, **kwargs)
82
return DummyProgress(to_file=to_file, **kwargs)
63
if _supports_progress(to_file):
64
return TTYProgressBar(to_file=to_file, **kwargs)
84
# Minor sanitation to prevent spurious errors
85
requested_bar_type = requested_bar_type.lower().strip()
86
# TODO: jam 20060710 Arguably we shouldn't raise an exception
87
# but should instead just disable progress bars if we
88
# don't recognize the type
89
if requested_bar_type not in _progress_bar_types:
90
raise errors.InvalidProgressBarType(requested_bar_type,
91
_progress_bar_types.keys())
92
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
66
return DotsProgressBar(to_file=to_file, **kwargs)
95
69
class ProgressBarStack(object):
96
70
"""A stack of progress bars."""
101
75
show_spinner=True,
105
to_messages_file=None,
79
to_messages_file=sys.stdout,
107
81
"""Setup the stack with the parameters the progress bars should have."""
110
if to_messages_file is None:
111
to_messages_file = sys.stdout
112
82
self._to_file = to_file
113
83
self._show_pct = show_pct
114
84
self._show_spinner = show_spinner
117
87
self._show_count = show_count
118
88
self._to_messages_file = to_messages_file
120
self._klass = klass or ProgressBar
90
self._klass = klass or TTYProgressBar
123
93
if len(self._stack) != 0:
158
122
class _BaseProgressBar(object):
160
124
def __init__(self,
163
127
show_spinner=False,
167
to_messages_file=None,
131
to_messages_file=sys.stdout,
169
133
object.__init__(self)
172
if to_messages_file is None:
173
to_messages_file = sys.stdout
174
134
self.to_file = to_file
175
135
self.to_messages_file = to_messages_file
176
136
self.last_msg = None
229
189
def child_progress(self, **kwargs):
230
190
return DummyProgress(**kwargs)
233
_progress_bar_types['dummy'] = DummyProgress
234
_progress_bar_types['none'] = DummyProgress
237
192
class DotsProgressBar(_BaseProgressBar):
239
194
def __init__(self, **kwargs):
258
214
self.to_file.write('\n')
261
216
def child_update(self, message, current, total):
265
_progress_bar_types['dots'] = DotsProgressBar
268
219
class TTYProgressBar(_BaseProgressBar):
269
220
"""Progress bar display object.
293
244
_BaseProgressBar.__init__(self, **kwargs)
294
245
self.spin_pos = 0
295
246
self.width = terminal_width()
296
self.last_updates = []
297
self._max_last_updates = 10
247
self.start_time = None
248
self.last_updates = deque()
298
249
self.child_fraction = 0
299
self._have_output = False
302
def throttle(self, old_msg):
303
253
"""Return True if the bar was updated too recently"""
304
254
# time.time consistently takes 40/4000 ms = 0.01 ms.
305
# time.clock() is faster, but gives us CPU time, not wall-clock time
307
if self.start_time is not None and (now - self.start_time) < 1:
309
if old_msg != self.last_msg:
255
# but every single update to the pb invokes it.
256
# so we use time.clock which takes 20/4000 ms = 0.005ms
257
# on the downside, time.clock() appears to have approximately
258
# 10ms granularity, so we treat a zero-time change as 'throttled.'
311
261
interval = now - self.last_update
312
262
# if interval > 0
313
263
if interval < self.MIN_PAUSE:
316
266
self.last_updates.append(now - self.last_update)
317
# Don't let the queue grow without bound
318
self.last_updates = self.last_updates[-self._max_last_updates:]
319
267
self.last_update = now
323
272
self.update(self.last_msg, self.last_cnt, self.last_total,
324
273
self.child_fraction)
336
285
self.last_msg = ''
339
289
def update(self, msg, current_cnt=None, total_cnt=None,
340
290
child_fraction=0):
341
291
"""Update and redraw progress bar."""
345
if total_cnt is None:
346
total_cnt = self.last_total
348
293
if current_cnt < 0:
375
320
# but multiple that by 4000 calls -> starts to cost.
376
321
# so anything to make this function call faster
377
322
# will improve base 'diff' time by up to 0.1 seconds.
378
if self.throttle(old_msg):
323
if old_msg == self.last_msg and self.throttle():
381
326
if self.show_eta and self.start_time and self.last_total:
436
381
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
437
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
438
self._have_output = True
383
assert len(m) < self.width
384
self.to_file.write('\r' + m.ljust(self.width - 1))
439
385
#self.to_file.flush()
442
if self._have_output:
443
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
444
self._have_output = False
388
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
445
389
#self.to_file.flush()
448
_progress_bar_types['tty'] = TTYProgressBar
451
392
class ChildProgress(_BaseProgressBar):
452
393
"""A progress indicator that pushes its data to the parent"""
454
394
def __init__(self, _stack, **kwargs):
455
395
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
456
396
self.parent = _stack.top()
523
460
assert total_duration >= elapsed
525
462
if last_updates and len(last_updates) >= n_recent:
463
while len(last_updates) > n_recent:
464
last_updates.popleft()
526
465
avg = sum(last_updates) / float(len(last_updates))
527
466
time_left = avg * (total - current)
added
removed
bzrlib/progress.py
