← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Vincent Ladeuil
  • Date: 2007-07-15 11:24:18 UTC
  • mfrom: (2617 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2646.
  • Revision ID: v.ladeuil+lp@free.fr-20070715112418-9nn4n6esxv60ny4b
merge bzr.dev@1617

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
41
 
43
 
import bzrlib.errors as errors
 
42
from bzrlib.lazy_import import lazy_import
 
43
lazy_import(globals(), """
 
44
from bzrlib import (
 
45
    errors,
 
46
    )
 
47
""")
 
48
 
44
49
from bzrlib.trace import mutter
45
50
 
46
51
 
47
52
def _supports_progress(f):
 
53
    """Detect if we can use pretty progress bars on the output stream f.
 
54
 
 
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.
 
57
    """
48
58
    isatty = getattr(f, 'isatty', None)
49
59
    if isatty is None:
50
60
        return False
69
79
        if _supports_progress(to_file):
70
80
            return TTYProgressBar(to_file=to_file, **kwargs)
71
81
        else:
72
 
            return DotsProgressBar(to_file=to_file, **kwargs)
 
82
            return DummyProgress(to_file=to_file, **kwargs)
73
83
    else:
74
84
        # Minor sanitation to prevent spurious errors
75
85
        requested_bar_type = requested_bar_type.lower().strip()
174
184
        self._stack = _stack
175
185
        # seed throttler
176
186
        self.MIN_PAUSE = 0.1 # seconds
177
 
        now = time.clock()
 
187
        now = time.time()
178
188
        # starting now
179
189
        self.start_time = now
180
190
        # next update should not throttle
292
302
    def throttle(self, old_msg):
293
303
        """Return True if the bar was updated too recently"""
294
304
        # time.time consistently takes 40/4000 ms = 0.01 ms.
295
 
        # but every single update to the pb invokes it.
296
 
        # so we use time.clock which takes 20/4000 ms = 0.005ms
297
 
        # on the downside, time.clock() appears to have approximately
298
 
        # 10ms granularity, so we treat a zero-time change as 'throttled.'
299
 
        now = time.clock()
 
305
        # time.clock() is faster, but gives us CPU time, not wall-clock time
 
306
        now = time.time()
300
307
        if self.start_time is not None and (now - self.start_time) < 1:
301
308
            return True
302
309
        if old_msg != self.last_msg:
427
434
            bar_str = ''
428
435
 
429
436
        m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
430
 
 
431
 
        assert len(m) < self.width
432
 
        self.to_file.write('\r' + m.ljust(self.width - 1))
 
437
        self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
433
438
        self._have_output = True
434
439
        #self.to_file.flush()
435
440
            
508
513
    if current > total:
509
514
        return None                     # wtf?
510
515
 
511
 
    elapsed = time.clock() - start_time
 
516
    elapsed = time.time() - start_time
512
517
 
513
518
    if elapsed < 2.0:                   # not enough time to estimate
514
519
        return None