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
17
"""Progress indicators.
19
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
20
will manage a conceptual stack of nested activities.
23
from __future__ import absolute_import
29
def _supports_progress(f):
30
"""Detect if we can use pretty progress bars on file F.
32
If this returns true we expect that a human may be looking at that
33
output, and that we can repaint a line to update it.
35
This doesn't check the policy for whether we *should* use them.
37
isatty = getattr(f, 'isatty', None)
42
# The following case also handles Win32 - on that platform $TERM is
43
# typically never set, so the case None is treated as a smart terminal,
44
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
45
# isatty methods that return true.
46
if os.environ.get('TERM') == 'dumb':
47
# e.g. emacs compile window
52
class ProgressTask(object):
53
"""Model component of a progress indicator.
55
Most code that needs to indicate progress should update one of these,
56
and it will in turn update the display, if one is present.
58
Code updating the task may also set fields as hints about how to display
59
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
60
will not necessarily respect all these fields.
62
:ivar update_latency: The interval (in seconds) at which the PB should be
63
updated. Setting this to zero suggests every update should be shown
66
:ivar show_transport_activity: If true (default), transport activity
67
will be shown when this task is drawn. Disable it if you're sure
68
that only irrelevant or uninteresting transport activity can occur
72
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
73
"""Construct a new progress task.
75
:param parent_task: Enclosing ProgressTask or None.
77
:param progress_view: ProgressView to display this ProgressTask.
79
:param ui_factory: The UI factory that will display updates;
80
deprecated in favor of passing progress_view directly.
82
Normally you should not call this directly but rather through
83
`ui_factory.nested_progress_bar`.
85
self._parent_task = parent_task
88
self.current_cnt = None
90
# TODO: deprecate passing ui_factory
91
self.ui_factory = ui_factory
92
self.progress_view = progress_view
94
self.show_spinner = True
95
self.show_eta = False,
96
self.show_count = True
98
self.update_latency = 0.1
99
self.show_transport_activity = True
102
return '%s(%r/%r, msg=%r)' % (
103
self.__class__.__name__,
108
def update(self, msg, current_cnt=None, total_cnt=None):
110
self.current_cnt = current_cnt
112
self.total_cnt = total_cnt
113
if self.progress_view:
114
self.progress_view.show_progress(self)
116
self.ui_factory._progress_updated(self)
119
self.update(self.msg)
122
if self.progress_view:
123
self.progress_view.task_finished(self)
125
self.ui_factory._progress_finished(self)
127
def make_sub_task(self):
128
return ProgressTask(self, ui_factory=self.ui_factory,
129
progress_view=self.progress_view)
131
def _overall_completion_fraction(self, child_fraction=0.0):
132
"""Return fractional completion of this task and its parents
134
Returns None if no completion can be computed."""
135
if self.current_cnt is not None and self.total_cnt:
136
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
138
# if this task has no estimation, it just passes on directly
139
# whatever the child has measured...
140
own_fraction = child_fraction
141
if self._parent_task is None:
144
if own_fraction is None:
146
return self._parent_task._overall_completion_fraction(own_fraction)
149
# TODO: deprecate this method; the model object shouldn't be concerned
150
# with whether it's shown or not. Most callers use this because they
151
# want to write some different non-progress output to the screen, but
152
# they should probably instead use a stream that's synchronized with
153
# the progress output. It may be there is a model-level use for
154
# saying "this task's not active at the moment" but I don't see it. --
156
if self.progress_view:
157
self.progress_view.clear()
159
self.ui_factory.clear_term()
162
class DummyProgress(object):
163
"""Progress-bar standin that does nothing.
165
This was previously often constructed by application code if no progress
166
bar was explicitly passed in. That's no longer recommended: instead, just
167
create a progress task from the ui_factory. This class can be used in
168
test code that needs to fake a progress task for some reason.
174
def update(self, msg=None, current=None, total=None):
177
def child_update(self, message, current, total):
183
def child_progress(self, **kwargs):
184
return DummyProgress(**kwargs)
187
def str_tdelta(delt):
190
delt = int(round(delt))
191
return '%d:%02d:%02d' % (delt/3600,
196
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
197
if start_time is None:
203
if current < enough_samples:
209
elapsed = time.time() - start_time
211
if elapsed < 2.0: # not enough time to estimate
214
total_duration = float(elapsed) * float(total) / float(current)
216
if last_updates and len(last_updates) >= n_recent:
217
avg = sum(last_updates) / float(len(last_updates))
218
time_left = avg * (total - current)
220
old_time_left = total_duration - elapsed
222
# We could return the average, or some other value here
223
return (time_left + old_time_left) / 2
225
return total_duration - elapsed
228
class ProgressPhase(object):
229
"""Update progress object with the current phase"""
230
def __init__(self, message, total, pb):
231
object.__init__(self)
233
self.message = message
235
self.cur_phase = None
237
def next_phase(self):
238
if self.cur_phase is None:
242
self.pb.update(self.message, self.cur_phase, self.total)
added
removed
bzrlib/progress.py
