1
# Copyright (C) 2005, 2006, 2008, 2009 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.
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical <canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Simple text-mode progress indicator.
21
To display an indicator, create a ProgressBar object. Call it,
22
passing Progress objects indicating the current state. When done,
25
Progress is suppressed when output is not sent to a terminal, so as
26
not to clutter log files.
29
# TODO: should be a global option e.g. --silent that disables progress
30
# indicators, preferably without needing to adjust all code that
31
# potentially calls them.
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
# when the rate is unpredictable
33
from bzrlib.trace import mutter
34
from bzrlib.symbol_versioning import (
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
41
49
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.
50
if not hasattr(f, 'isatty'):
58
54
if os.environ.get('TERM') == 'dumb':
59
55
# 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.
61
def ProgressBar(to_file=sys.stderr, **kwargs):
62
"""Abstract factory"""
63
if _supports_progress(to_file):
64
return TTYProgressBar(to_file=to_file, **kwargs)
66
return DotsProgressBar(to_file=to_file, **kwargs)
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
@deprecated_function(deprecated_in((1, 16, 0)))
188
def ProgressBar(to_file=None, **kwargs):
189
"""Construct a progress bar.
191
Deprecated; ask the ui_factory for a progress task instead.
195
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
196
# An value of '' or not set reverts to standard processing
197
if requested_bar_type in (None, ''):
198
if _supports_progress(to_file):
199
return TTYProgressBar(to_file=to_file, **kwargs)
201
return DummyProgress(to_file=to_file, **kwargs)
203
# Minor sanitation to prevent spurious errors
204
requested_bar_type = requested_bar_type.lower().strip()
205
# TODO: jam 20060710 Arguably we shouldn't raise an exception
206
# but should instead just disable progress bars if we
207
# don't recognize the type
208
if requested_bar_type not in _progress_bar_types:
209
raise errors.InvalidProgressBarType(requested_bar_type,
210
_progress_bar_types.keys())
211
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
214
# NOTE: This is also deprecated; you should provide a ProgressView instead.
69
class ProgressBarStack(object):
70
"""A stack of progress bars."""
79
to_messages_file=sys.stdout,
81
"""Setup the stack with the parameters the progress bars should have."""
82
self._to_file = to_file
83
self._show_pct = show_pct
84
self._show_spinner = show_spinner
85
self._show_eta = show_eta
86
self._show_bar = show_bar
87
self._show_count = show_count
88
self._to_messages_file = to_messages_file
90
self._klass = klass or TTYProgressBar
93
if len(self._stack) != 0:
94
return self._stack[-1]
99
if len(self._stack) != 0:
100
return self._stack[0]
104
def get_nested(self):
105
"""Return a nested progress bar."""
106
if len(self._stack) == 0:
109
func = self.top().child_progress
110
new_bar = func(to_file=self._to_file,
111
show_pct=self._show_pct,
112
show_spinner=self._show_spinner,
113
show_eta=self._show_eta,
114
show_bar=self._show_bar,
115
show_count=self._show_count,
116
to_messages_file=self._to_messages_file,
118
self._stack.append(new_bar)
121
def return_pb(self, bar):
122
"""Return bar after its been used."""
123
if bar is not self._stack[-1]:
124
raise errors.MissingProgressBarFinish()
215
128
class _BaseProgressBar(object):
217
130
def __init__(self,
220
133
show_spinner=False,
224
to_messages_file=None,
137
to_messages_file=sys.stdout,
226
139
object.__init__(self)
229
if to_messages_file is None:
230
to_messages_file = sys.stdout
231
140
self.to_file = to_file
232
141
self.to_messages_file = to_messages_file
233
142
self.last_msg = None
added
removed
bzrlib/progress.py
