1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
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
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
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
49
from bzrlib.trace import mutter
49
52
def _supports_progress(f):
50
if not hasattr(f, 'isatty'):
53
isatty = getattr(f, 'isatty', None)
54
58
if os.environ.get('TERM') == 'dumb':
55
59
# e.g. emacs compile window
61
def ProgressBar(to_file=sys.stderr, **kwargs):
64
_progress_bar_types = {}
67
def ProgressBar(to_file=None, **kwargs):
62
68
"""Abstract factory"""
63
if _supports_progress(to_file):
64
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)
66
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)
69
90
class ProgressBarStack(object):
70
91
"""A stack of progress bars."""
79
to_messages_file=sys.stdout,
100
to_messages_file=None,
81
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
82
107
self._to_file = to_file
83
108
self._show_pct = show_pct
84
109
self._show_spinner = show_spinner
87
112
self._show_count = show_count
88
113
self._to_messages_file = to_messages_file
90
self._klass = klass or TTYProgressBar
115
self._klass = klass or ProgressBar
93
118
if len(self._stack) != 0:
128
153
class _BaseProgressBar(object):
130
155
def __init__(self,
133
158
show_spinner=False,
137
to_messages_file=sys.stdout,
162
to_messages_file=None,
139
164
object.__init__(self)
167
if to_messages_file is None:
168
to_messages_file = sys.stdout
140
169
self.to_file = to_file
141
170
self.to_messages_file = to_messages_file
142
171
self.last_msg = None
195
224
def child_progress(self, **kwargs):
196
225
return DummyProgress(**kwargs)
228
_progress_bar_types['dummy'] = DummyProgress
229
_progress_bar_types['none'] = DummyProgress
198
232
class DotsProgressBar(_BaseProgressBar):
200
234
def __init__(self, **kwargs):
220
253
self.to_file.write('\n')
222
256
def child_update(self, message, current, total):
260
_progress_bar_types['dots'] = DotsProgressBar
225
263
class TTYProgressBar(_BaseProgressBar):
226
264
"""Progress bar display object.
250
288
_BaseProgressBar.__init__(self, **kwargs)
251
289
self.spin_pos = 0
252
290
self.width = terminal_width()
253
self.start_time = None
254
self.last_updates = deque()
291
self.last_updates = []
292
self._max_last_updates = 10
255
293
self.child_fraction = 0
294
self._have_output = False
297
def throttle(self, old_msg):
259
298
"""Return True if the bar was updated too recently"""
260
299
# 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.'
300
# time.clock() is faster, but gives us CPU time, not wall-clock time
302
if self.start_time is not None and (now - self.start_time) < 1:
304
if old_msg != self.last_msg:
267
306
interval = now - self.last_update
268
307
# if interval > 0
269
308
if interval < self.MIN_PAUSE:
272
311
self.last_updates.append(now - self.last_update)
312
# Don't let the queue grow without bound
313
self.last_updates = self.last_updates[-self._max_last_updates:]
273
314
self.last_update = now
278
318
self.update(self.last_msg, self.last_cnt, self.last_total,
279
319
self.child_fraction)
291
331
self.last_msg = ''
295
334
def update(self, msg, current_cnt=None, total_cnt=None,
296
335
child_fraction=0):
297
336
"""Update and redraw progress bar."""
340
if total_cnt is None:
341
total_cnt = self.last_total
299
343
if current_cnt < 0:
326
370
# but multiple that by 4000 calls -> starts to cost.
327
371
# so anything to make this function call faster
328
372
# will improve base 'diff' time by up to 0.1 seconds.
329
if old_msg == self.last_msg and self.throttle():
373
if self.throttle(old_msg):
332
376
if self.show_eta and self.start_time and self.last_total:
387
431
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
389
assert len(m) < self.width
390
self.to_file.write('\r' + m.ljust(self.width - 1))
432
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
433
self._have_output = True
391
434
#self.to_file.flush()
394
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
437
if self._have_output:
438
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
439
self._have_output = False
395
440
#self.to_file.flush()
443
_progress_bar_types['tty'] = TTYProgressBar
398
446
class ChildProgress(_BaseProgressBar):
399
447
"""A progress indicator that pushes its data to the parent"""
400
449
def __init__(self, _stack, **kwargs):
401
450
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
402
451
self.parent = _stack.top()
469
518
assert total_duration >= elapsed
471
520
if last_updates and len(last_updates) >= n_recent:
472
while len(last_updates) > n_recent:
473
last_updates.popleft()
474
521
avg = sum(last_updates) / float(len(last_updates))
475
522
time_left = avg * (total - current)
added
removed
bzrlib/progress.py
