1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Progress indicators.
20
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
21
will manage a conceptual stack of nested activities.
33
from bzrlib.trace import mutter
34
from bzrlib.symbol_versioning import (
41
def _supports_progress(f):
42
"""Detect if we can use pretty progress bars on file F.
44
If this returns true we expect that a human may be looking at that
45
output, and that we can repaint a line to update it.
47
This doesn't check the policy for whether we *should* use them.
49
isatty = getattr(f, 'isatty', None)
54
# The following case also handles Win32 - on that platform $TERM is
55
# typically never set, so the case None is treated as a smart terminal,
56
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
57
# isatty methods that return true.
58
if os.environ.get('TERM') == 'dumb':
59
# e.g. emacs compile window
64
class ProgressTask(object):
65
"""Model component of a progress indicator.
67
Most code that needs to indicate progress should update one of these,
68
and it will in turn update the display, if one is present.
70
Code updating the task may also set fields as hints about how to display
71
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
72
will not necessarily respect all these fields.
74
:ivar update_latency: The interval (in seconds) at which the PB should be
75
updated. Setting this to zero suggests every update should be shown
78
:ivar show_transport_activity: If true (default), transport activity
79
will be shown when this task is drawn. Disable it if you're sure
80
that only irrelevant or uninteresting transport activity can occur
84
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
85
"""Construct a new progress task.
87
:param parent_task: Enclosing ProgressTask or None.
89
:param progress_view: ProgressView to display this ProgressTask.
91
:param ui_factory: The UI factory that will display updates;
92
deprecated in favor of passing progress_view directly.
94
Normally you should not call this directly but rather through
95
`ui_factory.nested_progress_bar`.
97
self._parent_task = parent_task
100
self.current_cnt = None
102
# TODO: deprecate passing ui_factory
103
self.ui_factory = ui_factory
104
self.progress_view = progress_view
105
self.show_pct = False
106
self.show_spinner = True
107
self.show_eta = False,
108
self.show_count = True
110
self.update_latency = 0.1
111
self.show_transport_activity = True
114
return '%s(%r/%r, msg=%r)' % (
115
self.__class__.__name__,
120
def update(self, msg, current_cnt=None, total_cnt=None):
122
self.current_cnt = current_cnt
124
self.total_cnt = total_cnt
125
if self.progress_view:
126
self.progress_view.show_progress(self)
128
self.ui_factory._progress_updated(self)
131
self.update(self.msg)
134
if self.progress_view:
135
self.progress_view.task_finished(self)
137
self.ui_factory._progress_finished(self)
139
def make_sub_task(self):
140
return ProgressTask(self, ui_factory=self.ui_factory,
141
progress_view=self.progress_view)
143
def _overall_completion_fraction(self, child_fraction=0.0):
144
"""Return fractional completion of this task and its parents
146
Returns None if no completion can be computed."""
147
if self.current_cnt is not None and self.total_cnt:
148
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
150
# if this task has no estimation, it just passes on directly
151
# whatever the child has measured...
152
own_fraction = child_fraction
153
if self._parent_task is None:
156
if own_fraction is None:
158
return self._parent_task._overall_completion_fraction(own_fraction)
160
@deprecated_method(deprecated_in((2, 1, 0)))
161
def note(self, fmt_string, *args):
162
"""Record a note without disrupting the progress bar.
164
Deprecated: use ui_factory.note() instead or bzrlib.trace. Note that
165
ui_factory.note takes just one string as the argument, not a format
166
string and arguments.
169
self.ui_factory.note(fmt_string % args)
171
self.ui_factory.note(fmt_string)
174
# TODO: deprecate this method; the model object shouldn't be concerned
175
# with whether it's shown or not. Most callers use this because they
176
# want to write some different non-progress output to the screen, but
177
# they should probably instead use a stream that's synchronized with
178
# the progress output. It may be there is a model-level use for
179
# saying "this task's not active at the moment" but I don't see it. --
181
if self.progress_view:
182
self.progress_view.clear()
184
self.ui_factory.clear_term()
187
# NOTE: This is also deprecated; you should provide a ProgressView instead.
188
class _BaseProgressBar(object):
197
to_messages_file=None,
199
object.__init__(self)
202
if to_messages_file is None:
203
to_messages_file = sys.stdout
204
self.to_file = to_file
205
self.to_messages_file = to_messages_file
208
self.last_total = None
209
self.show_pct = show_pct
210
self.show_spinner = show_spinner
211
self.show_eta = show_eta
212
self.show_bar = show_bar
213
self.show_count = show_count
216
self.MIN_PAUSE = 0.1 # seconds
219
self.start_time = now
220
# next update should not throttle
221
self.last_update = now - self.MIN_PAUSE - 1
224
"""Return this bar to its progress stack."""
226
self._stack.return_pb(self)
228
def note(self, fmt_string, *args, **kwargs):
229
"""Record a note without disrupting the progress bar."""
231
self.to_messages_file.write(fmt_string % args)
232
self.to_messages_file.write('\n')
235
class DummyProgress(object):
236
"""Progress-bar standin that does nothing.
238
This was previously often constructed by application code if no progress
239
bar was explicitly passed in. That's no longer recommended: instead, just
240
create a progress task from the ui_factory. This class can be used in
241
test code that needs to fake a progress task for some reason.
247
def update(self, msg=None, current=None, total=None):
250
def child_update(self, message, current, total):
256
def note(self, fmt_string, *args, **kwargs):
257
"""See _BaseProgressBar.note()."""
259
def child_progress(self, **kwargs):
260
return DummyProgress(**kwargs)
263
def str_tdelta(delt):
266
delt = int(round(delt))
267
return '%d:%02d:%02d' % (delt/3600,
272
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
273
if start_time is None:
279
if current < enough_samples:
285
elapsed = time.time() - start_time
287
if elapsed < 2.0: # not enough time to estimate
290
total_duration = float(elapsed) * float(total) / float(current)
292
if last_updates and len(last_updates) >= n_recent:
293
avg = sum(last_updates) / float(len(last_updates))
294
time_left = avg * (total - current)
296
old_time_left = total_duration - elapsed
298
# We could return the average, or some other value here
299
return (time_left + old_time_left) / 2
301
return total_duration - elapsed
304
class ProgressPhase(object):
305
"""Update progress object with the current phase"""
306
def __init__(self, message, total, pb):
307
object.__init__(self)
309
self.message = message
311
self.cur_phase = None
313
def next_phase(self):
314
if self.cur_phase is None:
318
self.pb.update(self.message, self.cur_phase, self.total)
added
removed
bzrlib/progress.py
