/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/progress.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-08-23 01:15:41 UTC
  • mfrom: (7520.1.4 merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200823011541-nv0oh7nzaganx2qy
Merge lp:brz/3.1.

Merged from https://code.launchpad.net/~jelmer/brz/merge-3.1/+merge/389690

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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
 
 
18
17
"""Progress indicators.
19
18
 
20
 
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
 
19
The usual way to use this is via breezy.ui.ui_factory.nested_progress_bar which
21
20
will manage a conceptual stack of nested activities.
22
21
"""
23
22
 
24
 
 
25
 
import sys
26
23
import time
27
24
import os
28
25
 
29
26
 
30
 
from bzrlib.symbol_versioning import (
31
 
    deprecated_in,
32
 
    deprecated_method,
33
 
    )
34
 
 
35
 
 
36
27
def _supports_progress(f):
37
28
    """Detect if we can use pretty progress bars on file F.
38
29
 
65
56
    Code updating the task may also set fields as hints about how to display
66
57
    it: show_pct, show_spinner, show_eta, show_count, show_bar.  UIs
67
58
    will not necessarily respect all these fields.
68
 
    
 
59
 
 
60
    The message given when updating a task must be unicode, not bytes.
 
61
 
69
62
    :ivar update_latency: The interval (in seconds) at which the PB should be
70
63
        updated.  Setting this to zero suggests every update should be shown
71
64
        synchronously.
72
65
 
73
66
    :ivar show_transport_activity: If true (default), transport activity
74
 
        will be shown when this task is drawn.  Disable it if you're sure 
 
67
        will be shown when this task is drawn.  Disable it if you're sure
75
68
        that only irrelevant or uninteresting transport activity can occur
76
69
        during this task.
77
70
    """
83
76
 
84
77
        :param progress_view: ProgressView to display this ProgressTask.
85
78
 
86
 
        :param ui_factory: The UI factory that will display updates; 
 
79
        :param ui_factory: The UI factory that will display updates;
87
80
            deprecated in favor of passing progress_view directly.
88
81
 
89
82
        Normally you should not call this directly but rather through
113
106
            self.msg)
114
107
 
115
108
    def update(self, msg, current_cnt=None, total_cnt=None):
 
109
        """Report updated task message and if relevent progress counters
 
110
 
 
111
        The message given must be unicode, not a byte string.
 
112
        """
116
113
        self.msg = msg
117
114
        self.current_cnt = current_cnt
118
115
        if total_cnt:
133
130
 
134
131
    def make_sub_task(self):
135
132
        return ProgressTask(self, ui_factory=self.ui_factory,
136
 
            progress_view=self.progress_view)
 
133
                            progress_view=self.progress_view)
137
134
 
138
135
    def _overall_completion_fraction(self, child_fraction=0.0):
139
136
        """Return fractional completion of this task and its parents
140
137
 
141
138
        Returns None if no completion can be computed."""
142
139
        if self.current_cnt is not None and self.total_cnt:
143
 
            own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
 
140
            own_fraction = (float(self.current_cnt) +
 
141
                            child_fraction) / self.total_cnt
144
142
        else:
145
143
            # if this task has no estimation, it just passes on directly
146
144
            # whatever the child has measured...
152
150
                own_fraction = 0.0
153
151
            return self._parent_task._overall_completion_fraction(own_fraction)
154
152
 
155
 
    @deprecated_method(deprecated_in((2, 1, 0)))
156
 
    def note(self, fmt_string, *args):
157
 
        """Record a note without disrupting the progress bar.
158
 
        
159
 
        Deprecated: use ui_factory.note() instead or bzrlib.trace.  Note that
160
 
        ui_factory.note takes just one string as the argument, not a format
161
 
        string and arguments.
162
 
        """
163
 
        if args:
164
 
            self.ui_factory.note(fmt_string % args)
165
 
        else:
166
 
            self.ui_factory.note(fmt_string)
167
 
 
168
153
    def clear(self):
169
154
        # TODO: deprecate this method; the model object shouldn't be concerned
170
155
        # with whether it's shown or not.  Most callers use this because they
178
163
        else:
179
164
            self.ui_factory.clear_term()
180
165
 
181
 
 
182
 
# NOTE: This is also deprecated; you should provide a ProgressView instead.
183
 
class _BaseProgressBar(object):
184
 
 
185
 
    def __init__(self,
186
 
                 to_file=None,
187
 
                 show_pct=False,
188
 
                 show_spinner=False,
189
 
                 show_eta=False,
190
 
                 show_bar=True,
191
 
                 show_count=True,
192
 
                 to_messages_file=None,
193
 
                 _stack=None):
194
 
        object.__init__(self)
195
 
        if to_file is None:
196
 
            to_file = sys.stderr
197
 
        if to_messages_file is None:
198
 
            to_messages_file = sys.stdout
199
 
        self.to_file = to_file
200
 
        self.to_messages_file = to_messages_file
201
 
        self.last_msg = None
202
 
        self.last_cnt = None
203
 
        self.last_total = None
204
 
        self.show_pct = show_pct
205
 
        self.show_spinner = show_spinner
206
 
        self.show_eta = show_eta
207
 
        self.show_bar = show_bar
208
 
        self.show_count = show_count
209
 
        self._stack = _stack
210
 
        # seed throttler
211
 
        self.MIN_PAUSE = 0.1 # seconds
212
 
        now = time.time()
213
 
        # starting now
214
 
        self.start_time = now
215
 
        # next update should not throttle
216
 
        self.last_update = now - self.MIN_PAUSE - 1
217
 
 
218
 
    def finished(self):
219
 
        """Return this bar to its progress stack."""
220
 
        self.clear()
221
 
        self._stack.return_pb(self)
222
 
 
223
 
    def note(self, fmt_string, *args, **kwargs):
224
 
        """Record a note without disrupting the progress bar."""
225
 
        self.clear()
226
 
        self.to_messages_file.write(fmt_string % args)
227
 
        self.to_messages_file.write('\n')
 
166
    def __enter__(self):
 
167
        return self
 
168
 
 
169
    def __exit__(self, exc_type, exc_val, exc_tb):
 
170
        self.finished()
 
171
        return False
228
172
 
229
173
 
230
174
class DummyProgress(object):
248
192
    def clear(self):
249
193
        pass
250
194
 
251
 
    def note(self, fmt_string, *args, **kwargs):
252
 
        """See _BaseProgressBar.note()."""
253
 
 
254
195
    def child_progress(self, **kwargs):
255
196
        return DummyProgress(**kwargs)
256
197
 
259
200
    if delt is None:
260
201
        return "-:--:--"
261
202
    delt = int(round(delt))
262
 
    return '%d:%02d:%02d' % (delt/3600,
263
 
                             (delt/60) % 60,
 
203
    return '%d:%02d:%02d' % (delt / 3600,
 
204
                             (delt / 60) % 60,
264
205
                             delt % 60)
265
206
 
266
207
 
267
 
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
 
208
def get_eta(start_time, current, total, enough_samples=3, last_updates=None,
 
209
            n_recent=10):
268
210
    if start_time is None:
269
211
        return None
270
212
 
298
240
 
299
241
class ProgressPhase(object):
300
242
    """Update progress object with the current phase"""
 
243
 
301
244
    def __init__(self, message, total, pb):
302
245
        object.__init__(self)
303
246
        self.pb = pb