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
from __future__ import absolute_import
19
"""Progress indicators.
21
The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which
22
will manage a conceptual stack of nested activities.
31
from bzrlib.symbol_versioning import (
37
def _supports_progress(f):
38
"""Detect if we can use pretty progress bars on file F.
40
If this returns true we expect that a human may be looking at that
41
output, and that we can repaint a line to update it.
43
This doesn't check the policy for whether we *should* use them.
45
isatty = getattr(f, 'isatty', None)
50
# The following case also handles Win32 - on that platform $TERM is
51
# typically never set, so the case None is treated as a smart terminal,
52
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
53
# isatty methods that return true.
54
if os.environ.get('TERM') == 'dumb':
55
# e.g. emacs compile window
60
class ProgressTask(object):
61
"""Model component of a progress indicator.
63
Most code that needs to indicate progress should update one of these,
64
and it will in turn update the display, if one is present.
66
Code updating the task may also set fields as hints about how to display
67
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
68
will not necessarily respect all these fields.
70
:ivar update_latency: The interval (in seconds) at which the PB should be
71
updated. Setting this to zero suggests every update should be shown
74
:ivar show_transport_activity: If true (default), transport activity
75
will be shown when this task is drawn. Disable it if you're sure
76
that only irrelevant or uninteresting transport activity can occur
80
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
81
"""Construct a new progress task.
83
:param parent_task: Enclosing ProgressTask or None.
85
:param progress_view: ProgressView to display this ProgressTask.
87
:param ui_factory: The UI factory that will display updates;
88
deprecated in favor of passing progress_view directly.
90
Normally you should not call this directly but rather through
91
`ui_factory.nested_progress_bar`.
93
self._parent_task = parent_task
96
self.current_cnt = None
98
# TODO: deprecate passing ui_factory
99
self.ui_factory = ui_factory
100
self.progress_view = progress_view
101
self.show_pct = False
102
self.show_spinner = True
103
self.show_eta = False,
104
self.show_count = True
106
self.update_latency = 0.1
107
self.show_transport_activity = True
110
return '%s(%r/%r, msg=%r)' % (
111
self.__class__.__name__,
116
def update(self, msg, current_cnt=None, total_cnt=None):
118
self.current_cnt = current_cnt
120
self.total_cnt = total_cnt
121
if self.progress_view:
122
self.progress_view.show_progress(self)
124
self.ui_factory._progress_updated(self)
127
self.update(self.msg)
130
if self.progress_view:
131
self.progress_view.task_finished(self)
133
self.ui_factory._progress_finished(self)
135
def make_sub_task(self):
136
return ProgressTask(self, ui_factory=self.ui_factory,
137
progress_view=self.progress_view)
139
def _overall_completion_fraction(self, child_fraction=0.0):
140
"""Return fractional completion of this task and its parents
142
Returns None if no completion can be computed."""
143
if self.current_cnt is not None and self.total_cnt:
144
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
146
# if this task has no estimation, it just passes on directly
147
# whatever the child has measured...
148
own_fraction = child_fraction
149
if self._parent_task is None:
152
if own_fraction is None:
154
return self._parent_task._overall_completion_fraction(own_fraction)
157
# TODO: deprecate this method; the model object shouldn't be concerned
158
# with whether it's shown or not. Most callers use this because they
159
# want to write some different non-progress output to the screen, but
160
# they should probably instead use a stream that's synchronized with
161
# the progress output. It may be there is a model-level use for
162
# saying "this task's not active at the moment" but I don't see it. --
164
if self.progress_view:
165
self.progress_view.clear()
167
self.ui_factory.clear_term()
170
class DummyProgress(object):
171
"""Progress-bar standin that does nothing.
173
This was previously often constructed by application code if no progress
174
bar was explicitly passed in. That's no longer recommended: instead, just
175
create a progress task from the ui_factory. This class can be used in
176
test code that needs to fake a progress task for some reason.
182
def update(self, msg=None, current=None, total=None):
185
def child_update(self, message, current, total):
191
def child_progress(self, **kwargs):
192
return DummyProgress(**kwargs)
195
def str_tdelta(delt):
198
delt = int(round(delt))
199
return '%d:%02d:%02d' % (delt/3600,
204
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
205
if start_time is None:
211
if current < enough_samples:
217
elapsed = time.time() - start_time
219
if elapsed < 2.0: # not enough time to estimate
222
total_duration = float(elapsed) * float(total) / float(current)
224
if last_updates and len(last_updates) >= n_recent:
225
avg = sum(last_updates) / float(len(last_updates))
226
time_left = avg * (total - current)
228
old_time_left = total_duration - elapsed
230
# We could return the average, or some other value here
231
return (time_left + old_time_left) / 2
233
return total_duration - elapsed
236
class ProgressPhase(object):
237
"""Update progress object with the current phase"""
238
def __init__(self, message, total, pb):
239
object.__init__(self)
241
self.message = message
243
self.cur_phase = None
245
def next_phase(self):
246
if self.cur_phase is None:
250
self.pb.update(self.message, self.cur_phase, self.total)
added
removed
bzrlib/progress.py
