← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Jonathan Riddell
  • Date: 2011-06-02 12:46:20 UTC
  • mto: This revision was merged to the branch mainline in revision 5965.
  • Revision ID: jriddell@canonical.com-20110602124620-fbwhv52femfjxi6k
make set_commit_message hook syntax more consistent with generate_commit_message_template

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: