← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Andrew Bennetts
  • Date: 2009-08-05 02:37:11 UTC
  • mfrom: (4589 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4608.
  • Revision ID: andrew.bennetts@canonical.com-20090805023711-1mu01azkgbrw4fl1
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
69
69
    Code updating the task may also set fields as hints about how to display
70
70
    it: show_pct, show_spinner, show_eta, show_count, show_bar.  UIs
71
71
    will not necessarily respect all these fields.
 
72
    
 
73
    :ivar update_latency: The interval (in seconds) at which the PB should be
 
74
        updated.  Setting this to zero suggests every update should be shown
 
75
        synchronously.
 
76
 
 
77
    :ivar show_transport_activity: If true (default), transport activity
 
78
        will be shown when this task is drawn.  Disable it if you're sure 
 
79
        that only irrelevant or uninteresting transport activity can occur
 
80
        during this task.
72
81
    """
73
82
 
74
83
    def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
97
106
        self.show_eta = False,
98
107
        self.show_count = True
99
108
        self.show_bar = True
 
109
        self.update_latency = 0.1
 
110
        self.show_transport_activity = True
100
111
 
101
112
    def __repr__(self):
102
113
        return '%s(%r/%r, msg=%r)' % (
163
174
 
164
175
@deprecated_function(deprecated_in((1, 16, 0)))
165
176
def ProgressBar(to_file=None, **kwargs):
166
 
    """Abstract factory"""
 
177
    """Construct a progress bar.
 
178
 
 
179
    Deprecated; ask the ui_factory for a progress task instead.
 
180
    """
167
181
    if to_file is None:
168
182
        to_file = sys.stderr
169
183
    requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')