← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-24 19:21:32 UTC
  • mto: This revision was merged to the branch mainline in revision 5390.
  • Revision ID: john@arbash-meinel.com-20100824192132-2ktt5adkbk5bk1ct
Handle test_source and extensions. Also define an 'extern' protocol, to allow
the test suite to recognize that returning an object of that type is a Python object.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
17
18
"""Progress indicators.
18
19
 
19
20
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
20
21
will manage a conceptual stack of nested activities.
21
22
"""
22
23
 
23
 
from __future__ import absolute_import
24
24
 
 
25
import sys
25
26
import time
26
27
import os
27
28
 
28
29
 
 
30
from bzrlib.symbol_versioning import (
 
31
    deprecated_in,
 
32
    deprecated_method,
 
33
    )
 
34
 
 
35
 
29
36
def _supports_progress(f):
30
37
    """Detect if we can use pretty progress bars on file F.
31
38
 
58
65
    Code updating the task may also set fields as hints about how to display
59
66
    it: show_pct, show_spinner, show_eta, show_count, show_bar.  UIs
60
67
    will not necessarily respect all these fields.
61
 
 
62
 
    The message given when updating a task must be unicode, not bytes.
63
 
 
 
68
    
64
69
    :ivar update_latency: The interval (in seconds) at which the PB should be
65
70
        updated.  Setting this to zero suggests every update should be shown
66
71
        synchronously.
108
113
            self.msg)
109
114
 
110
115
    def update(self, msg, current_cnt=None, total_cnt=None):
111
 
        """Report updated task message and if relevent progress counters
112
 
 
113
 
        The message given must be unicode, not a byte string.
114
 
        """
115
116
        self.msg = msg
116
117
        self.current_cnt = current_cnt
117
118
        if total_cnt:
165
166
            self.ui_factory.clear_term()
166
167
 
167
168
 
 
169
# NOTE: This is also deprecated; you should provide a ProgressView instead.
 
170
class _BaseProgressBar(object):
 
171
 
 
172
    def __init__(self,
 
173
                 to_file=None,
 
174
                 show_pct=False,
 
175
                 show_spinner=False,
 
176
                 show_eta=False,
 
177
                 show_bar=True,
 
178
                 show_count=True,
 
179
                 to_messages_file=None,
 
180
                 _stack=None):
 
181
        object.__init__(self)
 
182
        if to_file is None:
 
183
            to_file = sys.stderr
 
184
        if to_messages_file is None:
 
185
            to_messages_file = sys.stdout
 
186
        self.to_file = to_file
 
187
        self.to_messages_file = to_messages_file
 
188
        self.last_msg = None
 
189
        self.last_cnt = None
 
190
        self.last_total = None
 
191
        self.show_pct = show_pct
 
192
        self.show_spinner = show_spinner
 
193
        self.show_eta = show_eta
 
194
        self.show_bar = show_bar
 
195
        self.show_count = show_count
 
196
        self._stack = _stack
 
197
        # seed throttler
 
198
        self.MIN_PAUSE = 0.1 # seconds
 
199
        now = time.time()
 
200
        # starting now
 
201
        self.start_time = now
 
202
        # next update should not throttle
 
203
        self.last_update = now - self.MIN_PAUSE - 1
 
204
 
 
205
    def finished(self):
 
206
        """Return this bar to its progress stack."""
 
207
        self.clear()
 
208
        self._stack.return_pb(self)
 
209
 
 
210
 
168
211
class DummyProgress(object):
169
212
    """Progress-bar standin that does nothing.
170
213