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
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.
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.
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
45
"""Return estimated terminal width.
47
TODO: Do something smart on Windows?
49
TODO: Is there anything that gets a better update when the window
50
is resized while the program is running?
53
return int(os.environ['COLUMNS'])
54
except (IndexError, KeyError, ValueError):
30
from bzrlib.symbol_versioning import (
58
36
def _supports_progress(f):
59
if not hasattr(f, 'isatty'):
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.
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.
63
53
if os.environ.get('TERM') == 'dumb':
64
54
# e.g. emacs compile window
70
def ProgressBar(to_file=sys.stderr, **kwargs):
71
"""Abstract factory"""
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
75
return DotsProgressBar(to_file=to_file, **kwargs)
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.
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)
156
# TODO: deprecate this method; the model object shouldn't be concerned
157
# with whether it's shown or not. Most callers use this because they
158
# want to write some different non-progress output to the screen, but
159
# they should probably instead use a stream that's synchronized with
160
# the progress output. It may be there is a model-level use for
161
# saying "this task's not active at the moment" but I don't see it. --
163
if self.progress_view:
164
self.progress_view.clear()
166
self.ui_factory.clear_term()
169
# NOTE: This is also deprecated; you should provide a ProgressView instead.
78
170
class _BaseProgressBar(object):
79
172
def __init__(self,
82
175
show_spinner=False,
179
to_messages_file=None,
86
181
object.__init__(self)
184
if to_messages_file is None:
185
to_messages_file = sys.stdout
87
186
self.to_file = to_file
187
self.to_messages_file = to_messages_file
89
188
self.last_msg = None
90
189
self.last_cnt = None
91
190
self.last_total = None
94
193
self.show_eta = show_eta
95
194
self.show_bar = show_bar
96
195
self.show_count = show_count
100
class DotsProgressBar(_BaseProgressBar):
101
def __init__(self, **kwargs):
102
_BaseProgressBar.__init__(self, **kwargs)
109
def update(self, msg=None, current_cnt=None, total_cnt=None):
110
if msg and msg != self.last_msg:
112
self.to_file.write('\n')
114
self.to_file.write(msg + ': ')
117
self.to_file.write('.')
121
self.to_file.write('\n')
124
class TTYProgressBar(_BaseProgressBar):
125
"""Progress bar display object.
127
Several options are available to control the display. These can
128
be passed as parameters to the constructor or assigned at any time:
131
Show percentage complete.
133
Show rotating baton. This ticks over on every update even
134
if the values don't change.
136
Show predicted time-to-completion.
140
Show numerical counts.
142
The output file should be in line-buffered or unbuffered mode.
145
MIN_PAUSE = 0.1 # seconds
148
def __init__(self, **kwargs):
149
_BaseProgressBar.__init__(self, **kwargs)
151
self.width = _width()
152
self.start_time = None
153
self.last_update = None
157
"""Return True if the bar was updated too recently"""
198
self.MIN_PAUSE = 0.1 # seconds
158
199
now = time.time()
159
if self.start_time is None:
160
self.start_time = self.last_update = now
163
interval = now - self.last_update
164
if interval > 0 and interval < self.MIN_PAUSE:
167
self.last_update = now
201
self.start_time = now
202
# next update should not throttle
203
self.last_update = now - self.MIN_PAUSE - 1
206
"""Return this bar to its progress stack."""
208
self._stack.return_pb(self)
211
class DummyProgress(object):
212
"""Progress-bar standin that does nothing.
214
This was previously often constructed by application code if no progress
215
bar was explicitly passed in. That's no longer recommended: instead, just
216
create a progress task from the ui_factory. This class can be used in
217
test code that needs to fake a progress task for some reason.
172
self.update(self.last_msg, self.last_cnt, self.last_total)
176
def update(self, msg, current_cnt=None, total_cnt=None):
177
"""Update and redraw progress bar."""
179
# save these for the tick() function
181
self.last_cnt = current_cnt
182
self.last_total = total_cnt
188
assert current_cnt <= total_cnt
190
assert current_cnt >= 0
192
if self.show_eta and self.start_time and total_cnt:
193
eta = get_eta(self.start_time, current_cnt, total_cnt)
194
eta_str = " " + str_tdelta(eta)
198
if self.show_spinner:
199
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
203
# always update this; it's also used for the bar
206
if self.show_pct and total_cnt and current_cnt:
207
pct = 100.0 * current_cnt / total_cnt
208
pct_str = ' (%5.1f%%)' % pct
212
if not self.show_count:
214
elif current_cnt is None:
216
elif total_cnt is None:
217
count_str = ' %i' % (current_cnt)
219
# make both fields the same size
220
t = '%i' % (total_cnt)
221
c = '%*i' % (len(t), current_cnt)
222
count_str = ' ' + c + '/' + t
225
# progress bar, if present, soaks up all remaining space
226
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
227
- len(eta_str) - len(count_str) - 3
230
# number of markers highlighted in bar
231
markers = int(round(float(cols) * current_cnt / total_cnt))
232
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
234
# don't know total, so can't show completion.
235
# so just show an expanded spinning thingy
236
m = self.spin_pos % cols
237
ms = (' ' * m + '*').ljust(cols)
239
bar_str = '[' + ms + '] '
245
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
247
assert len(m) < self.width
248
self.to_file.write('\r' + m.ljust(self.width - 1))
249
#self.to_file.flush()
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
254
#self.to_file.flush()
223
def update(self, msg=None, current=None, total=None):
226
def child_update(self, message, current, total):
232
def child_progress(self, **kwargs):
233
return DummyProgress(**kwargs)
258
236
def str_tdelta(delt):
282
260
if elapsed < 2.0: # not enough time to estimate
285
263
total_duration = float(elapsed) * float(total) / float(current)
287
assert total_duration >= elapsed
265
if last_updates and len(last_updates) >= n_recent:
266
avg = sum(last_updates) / float(len(last_updates))
267
time_left = avg * (total - current)
269
old_time_left = total_duration - elapsed
271
# We could return the average, or some other value here
272
return (time_left + old_time_left) / 2
289
274
return total_duration - elapsed
294
result = doctest.testmod()
297
print "All tests passed"
299
print "No tests to run"
305
print 'dumb-terminal test:'
306
pb = DotsProgressBar()
308
pb.update('Leoparden', i, 99)
314
print 'smart-terminal test:'
315
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
317
pb.update('Elephanten', i, 99)
325
if __name__ == "__main__":
277
class ProgressPhase(object):
278
"""Update progress object with the current phase"""
279
def __init__(self, message, total, pb):
280
object.__init__(self)
282
self.message = message
284
self.cur_phase = None
286
def next_phase(self):
287
if self.cur_phase is None:
291
self.pb.update(self.message, self.cur_phase, self.total)
added
removed
bzrlib/progress.py
