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.
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005 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
20
Simple text-mode progress indicator.
22
Everyone loves ascii art!
24
To display an indicator, create a ProgressBar object. Call it,
25
passing Progress objects indicating the current state. When done,
28
Progress is suppressed when output is not sent to a terminal, so as
29
not to clutter log files.
32
# TODO: remove functions in favour of keeping everything in one class
34
# TODO: should be a global option e.g. --silent that disables progress
35
# indicators, preferably without needing to adjust all code that
36
# potentially calls them.
38
# TODO: Perhaps don't write updates faster than a certain rate, say
30
from bzrlib.symbol_versioning import (
47
"""Return estimated terminal width.
49
TODO: Do something smart on Windows?
51
TODO: Is there anything that gets a better update when the window
52
is resized while the program is running?
56
return int(os.environ['COLUMNS'])
57
except (IndexError, KeyError, ValueError):
36
61
def _supports_progress(f):
37
"""Detect if we can use pretty progress bars on file F.
39
If this returns true we expect that a human may be looking at that
40
output, and that we can repaint a line to update it.
42
This doesn't check the policy for whether we *should* use them.
62
return hasattr(f, 'isatty') and f.isatty()
66
class ProgressBar(object):
67
"""Progress bar display object.
69
Several options are available to control the display. These can
70
be passed as parameters to the constructor or assigned at any time:
73
Show percentage complete.
75
Show rotating baton. This ticks over on every update even
76
if the values don't change.
78
Show predicted time-to-completion.
82
Show numerical counts.
84
The output file should be in line-buffered or unbuffered mode.
44
isatty = getattr(f, 'isatty', None)
49
# The following case also handles Win32 - on that platform $TERM is
50
# typically never set, so the case None is treated as a smart terminal,
51
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
52
# isatty methods that return true.
53
if os.environ.get('TERM') == 'dumb':
54
# e.g. emacs compile window
59
class ProgressTask(object):
60
"""Model component of a progress indicator.
62
Most code that needs to indicate progress should update one of these,
63
and it will in turn update the display, if one is present.
65
Code updating the task may also set fields as hints about how to display
66
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
67
will not necessarily respect all these fields.
87
MIN_PAUSE = 0.1 # seconds
69
:ivar update_latency: The interval (in seconds) at which the PB should be
70
updated. Setting this to zero suggests every update should be shown
73
:ivar show_transport_activity: If true (default), transport activity
74
will be shown when this task is drawn. Disable it if you're sure
75
that only irrelevant or uninteresting transport activity can occur
79
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
80
"""Construct a new progress task.
82
:param parent_task: Enclosing ProgressTask or None.
84
:param progress_view: ProgressView to display this ProgressTask.
86
:param ui_factory: The UI factory that will display updates;
87
deprecated in favor of passing progress_view directly.
89
Normally you should not call this directly but rather through
90
`ui_factory.nested_progress_bar`.
92
self._parent_task = parent_task
95
self.current_cnt = None
97
# TODO: deprecate passing ui_factory
98
self.ui_factory = ui_factory
99
self.progress_view = progress_view
100
self.show_pct = False
101
self.show_spinner = True
102
self.show_eta = False,
103
self.show_count = True
105
self.update_latency = 0.1
106
self.show_transport_activity = True
109
return '%s(%r/%r, msg=%r)' % (
110
self.__class__.__name__,
115
def update(self, msg, current_cnt=None, total_cnt=None):
117
self.current_cnt = current_cnt
119
self.total_cnt = total_cnt
120
if self.progress_view:
121
self.progress_view.show_progress(self)
123
self.ui_factory._progress_updated(self)
126
self.update(self.msg)
129
if self.progress_view:
130
self.progress_view.task_finished(self)
132
self.ui_factory._progress_finished(self)
134
def make_sub_task(self):
135
return ProgressTask(self, ui_factory=self.ui_factory,
136
progress_view=self.progress_view)
138
def _overall_completion_fraction(self, child_fraction=0.0):
139
"""Return fractional completion of this task and its parents
141
Returns None if no completion can be computed."""
142
if self.current_cnt is not None and self.total_cnt:
143
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
145
# if this task has no estimation, it just passes on directly
146
# whatever the child has measured...
147
own_fraction = child_fraction
148
if self._parent_task is None:
151
if own_fraction is None:
153
return self._parent_task._overall_completion_fraction(own_fraction)
155
@deprecated_method(deprecated_in((2, 1, 0)))
156
def note(self, fmt_string, *args):
157
"""Record a note without disrupting the progress bar.
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.
164
self.ui_factory.note(fmt_string % args)
166
self.ui_factory.note(fmt_string)
169
# TODO: deprecate this method; the model object shouldn't be concerned
170
# with whether it's shown or not. Most callers use this because they
171
# want to write some different non-progress output to the screen, but
172
# they should probably instead use a stream that's synchronized with
173
# the progress output. It may be there is a model-level use for
174
# saying "this task's not active at the moment" but I don't see it. --
176
if self.progress_view:
177
self.progress_view.clear()
179
self.ui_factory.clear_term()
182
# NOTE: This is also deprecated; you should provide a ProgressView instead.
183
class _BaseProgressBar(object):
185
92
def __init__(self,
188
95
show_spinner=False,
192
to_messages_file=None,
194
99
object.__init__(self)
197
if to_messages_file is None:
198
to_messages_file = sys.stdout
199
100
self.to_file = to_file
200
self.to_messages_file = to_messages_file
101
self.suppressed = not _supports_progress(self.to_file)
201
104
self.last_msg = None
202
105
self.last_cnt = None
203
106
self.last_total = None
206
109
self.show_eta = show_eta
207
110
self.show_bar = show_bar
208
111
self.show_count = show_count
211
self.MIN_PAUSE = 0.1 # seconds
115
self.update(self.last_msg, self.last_cnt, self.last_total)
119
def update(self, msg, current_cnt=None, total_cnt=None):
120
"""Update and redraw progress bar."""
124
# save these for the tick() function
126
self.last_cnt = current_cnt
127
self.last_total = total_cnt
212
129
now = time.time()
214
self.start_time = now
215
# next update should not throttle
216
self.last_update = now - self.MIN_PAUSE - 1
219
"""Return this bar to its progress stack."""
221
self._stack.return_pb(self)
223
def note(self, fmt_string, *args, **kwargs):
224
"""Record a note without disrupting the progress bar."""
226
self.to_messages_file.write(fmt_string % args)
227
self.to_messages_file.write('\n')
230
class DummyProgress(object):
231
"""Progress-bar standin that does nothing.
233
This was previously often constructed by application code if no progress
234
bar was explicitly passed in. That's no longer recommended: instead, just
235
create a progress task from the ui_factory. This class can be used in
236
test code that needs to fake a progress task for some reason.
242
def update(self, msg=None, current=None, total=None):
245
def child_update(self, message, current, total):
130
if self.start_time is None:
131
self.start_time = now
133
interval = now - self.last_update
134
if interval > 0 and interval < self.MIN_PAUSE:
137
self.last_update = now
142
assert current_cnt <= total_cnt
144
assert current_cnt >= 0
146
if self.show_eta and self.start_time and total_cnt:
147
eta = get_eta(self.start_time, current_cnt, total_cnt)
148
eta_str = " " + str_tdelta(eta)
152
if self.show_spinner:
153
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
157
# always update this; it's also used for the bar
160
if self.show_pct and total_cnt and current_cnt:
161
pct = 100.0 * current_cnt / total_cnt
162
pct_str = ' (%5.1f%%)' % pct
166
if not self.show_count:
168
elif current_cnt is None:
170
elif total_cnt is None:
171
count_str = ' %i' % (current_cnt)
173
# make both fields the same size
174
t = '%i' % (total_cnt)
175
c = '%*i' % (len(t), current_cnt)
176
count_str = ' ' + c + '/' + t
179
# progress bar, if present, soaks up all remaining space
180
cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
181
- len(eta_str) - len(count_str) - 3
184
# number of markers highlighted in bar
185
markers = int(round(float(cols) * current_cnt / total_cnt))
186
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
188
# don't know total, so can't show completion.
189
# so just show an expanded spinning thingy
190
m = self.spin_pos % cols
191
ms = (' ' * m + '*').ljust(cols)
193
bar_str = '[' + ms + '] '
199
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
201
assert len(m) < width
202
self.to_file.write('\r' + m.ljust(width - 1))
203
#self.to_file.flush()
251
def note(self, fmt_string, *args, **kwargs):
252
"""See _BaseProgressBar.note()."""
254
def child_progress(self, **kwargs):
255
return DummyProgress(**kwargs)
210
self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
211
#self.to_file.flush()
258
215
def str_tdelta(delt):
added
removed
bzrlib/progress.py
