← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Robert Collins
  • Date: 2007-03-08 04:06:06 UTC
  • mfrom: (2323.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2442.
  • Revision ID: robertc@robertcollins.net-20070308040606-84gsniv56huiyjt4
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
 
# Copyright (C) 2005, 2006 Canonical <canonical.com>
3
 
#
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.
8
 
#
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.
13
 
#
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
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
17
17
 
18
18
 
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
37
37
 
38
 
 
39
38
import sys
40
39
import time
41
40
import os
42
 
from collections import deque
43
 
 
44
 
 
45
 
import bzrlib.errors as errors
46
 
from bzrlib.trace import mutter 
 
41
 
 
42
from bzrlib.lazy_import import lazy_import
 
43
lazy_import(globals(), """
 
44
from bzrlib import (
 
45
    errors,
 
46
    )
 
47
""")
 
48
 
 
49
from bzrlib.trace import mutter
47
50
 
48
51
 
49
52
def _supports_progress(f):
50
 
    if not hasattr(f, 'isatty'):
 
53
    isatty = getattr(f, 'isatty', None)
 
54
    if isatty is None:
51
55
        return False
52
 
    if not f.isatty():
 
56
    if not isatty():
53
57
        return False
54
58
    if os.environ.get('TERM') == 'dumb':
55
59
        # e.g. emacs compile window
57
61
    return True
58
62
 
59
63
 
 
64
_progress_bar_types = {}
 
65
 
60
66
 
61
67
def ProgressBar(to_file=None, **kwargs):
62
68
    """Abstract factory"""
63
69
    if to_file is None:
64
70
        to_file = sys.stderr
65
 
    if _supports_progress(to_file):
66
 
        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)
 
76
        else:
 
77
            return DotsProgressBar(to_file=to_file, **kwargs)
67
78
    else:
68
 
        return DotsProgressBar(to_file=to_file, **kwargs)
69
 
    
 
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)
 
88
 
70
89
 
71
90
class ProgressBarStack(object):
72
91
    """A stack of progress bars."""
93
112
        self._show_count = show_count
94
113
        self._to_messages_file = to_messages_file
95
114
        self._stack = []
96
 
        self._klass = klass or TTYProgressBar
 
115
        self._klass = klass or ProgressBar
97
116
 
98
117
    def top(self):
99
118
        if len(self._stack) != 0:
137
156
                 to_file=None,
138
157
                 show_pct=False,
139
158
                 show_spinner=False,
140
 
                 show_eta=True,
 
159
                 show_eta=False,
141
160
                 show_bar=True,
142
161
                 show_count=True,
143
162
                 to_messages_file=None,
160
179
        self._stack = _stack
161
180
        # seed throttler
162
181
        self.MIN_PAUSE = 0.1 # seconds
163
 
        now = time.clock()
 
182
        now = time.time()
164
183
        # starting now
165
184
        self.start_time = now
166
185
        # next update should not throttle
206
225
        return DummyProgress(**kwargs)
207
226
 
208
227
 
 
228
_progress_bar_types['dummy'] = DummyProgress
 
229
_progress_bar_types['none'] = DummyProgress
 
230
 
 
231
 
209
232
class DotsProgressBar(_BaseProgressBar):
210
233
 
211
234
    def __init__(self, **kwargs):
233
256
    def child_update(self, message, current, total):
234
257
        self.tick()
235
258
 
 
259
 
 
260
_progress_bar_types['dots'] = DotsProgressBar
 
261
 
236
262
    
237
263
class TTYProgressBar(_BaseProgressBar):
238
264
    """Progress bar display object.
262
288
        _BaseProgressBar.__init__(self, **kwargs)
263
289
        self.spin_pos = 0
264
290
        self.width = terminal_width()
265
 
        self.start_time = None
266
 
        self.last_updates = deque()
 
291
        self.last_updates = []
 
292
        self._max_last_updates = 10
267
293
        self.child_fraction = 0
 
294
        self._have_output = False
268
295
    
269
296
 
270
 
    def throttle(self):
 
297
    def throttle(self, old_msg):
271
298
        """Return True if the bar was updated too recently"""
272
299
        # time.time consistently takes 40/4000 ms = 0.01 ms.
273
 
        # but every single update to the pb invokes it.
274
 
        # so we use time.clock which takes 20/4000 ms = 0.005ms
275
 
        # on the downside, time.clock() appears to have approximately
276
 
        # 10ms granularity, so we treat a zero-time change as 'throttled.'
277
 
        
278
 
        now = time.clock()
 
300
        # time.clock() is faster, but gives us CPU time, not wall-clock time
 
301
        now = time.time()
 
302
        if self.start_time is not None and (now - self.start_time) < 1:
 
303
            return True
 
304
        if old_msg != self.last_msg:
 
305
            return False
279
306
        interval = now - self.last_update
280
307
        # if interval > 0
281
308
        if interval < self.MIN_PAUSE:
282
309
            return True
283
310
 
284
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:]
285
314
        self.last_update = now
286
315
        return False
287
316
        
341
370
        # but multiple that by 4000 calls -> starts to cost.
342
371
        # so anything to make this function call faster
343
372
        # will improve base 'diff' time by up to 0.1 seconds.
344
 
        if old_msg == self.last_msg and self.throttle():
 
373
        if self.throttle(old_msg):
345
374
            return
346
375
 
347
376
        if self.show_eta and self.start_time and self.last_total:
400
429
            bar_str = ''
401
430
 
402
431
        m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
403
 
 
404
 
        assert len(m) < self.width
405
 
        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
406
434
        #self.to_file.flush()
407
435
            
408
436
    def clear(self):        
409
 
        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
410
440
        #self.to_file.flush()        
411
441
 
412
442
 
 
443
_progress_bar_types['tty'] = TTYProgressBar
 
444
 
 
445
 
413
446
class ChildProgress(_BaseProgressBar):
414
447
    """A progress indicator that pushes its data to the parent"""
415
448
 
475
508
    if current > total:
476
509
        return None                     # wtf?
477
510
 
478
 
    elapsed = time.clock() - start_time
 
511
    elapsed = time.time() - start_time
479
512
 
480
513
    if elapsed < 2.0:                   # not enough time to estimate
481
514
        return None
485
518
    assert total_duration >= elapsed
486
519
 
487
520
    if last_updates and len(last_updates) >= n_recent:
488
 
        while len(last_updates) > n_recent:
489
 
            last_updates.popleft()
490
521
        avg = sum(last_updates) / float(len(last_updates))
491
522
        time_left = avg * (total - current)
492
523