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
"""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)
54
63
if os.environ.get('TERM') == 'dumb':
55
64
# e.g. emacs compile window
61
def ProgressBar(to_file=sys.stderr, **kwargs):
69
_progress_bar_types = {}
72
def ProgressBar(to_file=None, **kwargs):
62
73
"""Abstract factory"""
63
if _supports_progress(to_file):
64
return TTYProgressBar(to_file=to_file, **kwargs)
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)
66
return DotsProgressBar(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)
69
95
class ProgressBarStack(object):
70
96
"""A stack of progress bars."""
75
101
show_spinner=True,
79
to_messages_file=sys.stdout,
105
to_messages_file=None,
81
107
"""Setup the stack with the parameters the progress bars should have."""
110
if to_messages_file is None:
111
to_messages_file = sys.stdout
82
112
self._to_file = to_file
83
113
self._show_pct = show_pct
84
114
self._show_spinner = show_spinner
87
117
self._show_count = show_count
88
118
self._to_messages_file = to_messages_file
90
self._klass = klass or TTYProgressBar
120
self._klass = klass or ProgressBar
93
123
if len(self._stack) != 0:
128
158
class _BaseProgressBar(object):
130
160
def __init__(self,
133
163
show_spinner=False,
137
to_messages_file=sys.stdout,
167
to_messages_file=None,
139
169
object.__init__(self)
172
if to_messages_file is None:
173
to_messages_file = sys.stdout
140
174
self.to_file = to_file
141
175
self.to_messages_file = to_messages_file
142
176
self.last_msg = None
195
229
def child_progress(self, **kwargs):
196
230
return DummyProgress(**kwargs)
233
_progress_bar_types['dummy'] = DummyProgress
234
_progress_bar_types['none'] = DummyProgress
198
237
class DotsProgressBar(_BaseProgressBar):
200
239
def __init__(self, **kwargs):
220
258
self.to_file.write('\n')
222
261
def child_update(self, message, current, total):
265
_progress_bar_types['dots'] = DotsProgressBar
225
268
class TTYProgressBar(_BaseProgressBar):
226
269
"""Progress bar display object.
250
293
_BaseProgressBar.__init__(self, **kwargs)
251
294
self.spin_pos = 0
252
295
self.width = terminal_width()
253
self.start_time = None
254
self.last_updates = deque()
296
self.last_updates = []
297
self._max_last_updates = 10
255
298
self.child_fraction = 0
299
self._have_output = False
302
def throttle(self, old_msg):
259
303
"""Return True if the bar was updated too recently"""
260
304
# 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.'
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:
267
311
interval = now - self.last_update
268
312
# if interval > 0
269
313
if interval < self.MIN_PAUSE:
272
316
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:]
273
319
self.last_update = now
278
323
self.update(self.last_msg, self.last_cnt, self.last_total,
279
324
self.child_fraction)
291
336
self.last_msg = ''
295
339
def update(self, msg, current_cnt=None, total_cnt=None,
296
340
child_fraction=0):
297
341
"""Update and redraw progress bar."""
345
if total_cnt is None:
346
total_cnt = self.last_total
299
348
if current_cnt < 0:
326
375
# but multiple that by 4000 calls -> starts to cost.
327
376
# so anything to make this function call faster
328
377
# will improve base 'diff' time by up to 0.1 seconds.
329
if old_msg == self.last_msg and self.throttle():
378
if self.throttle(old_msg):
332
381
if self.show_eta and self.start_time and self.last_total:
387
436
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))
437
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
438
self._have_output = True
391
439
#self.to_file.flush()
394
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
395
445
#self.to_file.flush()
448
_progress_bar_types['tty'] = TTYProgressBar
398
451
class ChildProgress(_BaseProgressBar):
399
452
"""A progress indicator that pushes its data to the parent"""
400
454
def __init__(self, _stack, **kwargs):
401
455
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
402
456
self.parent = _stack.top()
408
462
def update(self, msg, current_cnt=None, total_cnt=None):
409
463
self.current = current_cnt
410
self.total = total_cnt
464
if total_cnt is not None:
465
self.total = total_cnt
411
466
self.message = msg
412
467
self.child_fraction = 0
436
491
def note(self, *args, **kwargs):
437
492
self.parent.note(*args, **kwargs)
495
class InstrumentedProgress(TTYProgressBar):
496
"""TTYProgress variant that tracks outcomes"""
498
def __init__(self, *args, **kwargs):
499
self.always_throttled = True
500
self.never_throttle = False
501
TTYProgressBar.__init__(self, *args, **kwargs)
503
def throttle(self, old_message):
504
if self.never_throttle:
507
result = TTYProgressBar.throttle(self, old_message)
509
self.always_throttled = False
440
512
def str_tdelta(delt):
469
541
assert total_duration >= elapsed
471
543
if last_updates and len(last_updates) >= n_recent:
472
while len(last_updates) > n_recent:
473
last_updates.popleft()
474
544
avg = sum(last_updates) / float(len(last_updates))
475
545
time_left = avg * (total - current)
added
removed
bzrlib/progress.py
