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, 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
30
from bzrlib.symbol_versioning import (
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
36
50
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.
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.
51
if not hasattr(f, 'isatty'):
53
55
if os.environ.get('TERM') == 'dumb':
54
56
# 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.
62
def ProgressBar(to_file=sys.stderr, **kwargs):
63
"""Abstract factory"""
64
if _supports_progress(to_file):
65
return TTYProgressBar(to_file=to_file, **kwargs)
67
return DotsProgressBar(to_file=to_file, **kwargs)
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.
70
class ProgressBarStack(object):
71
"""A stack of progress bars."""
80
to_messages_file=sys.stdout,
82
"""Setup the stack with the parameters the progress bars should have."""
83
self._to_file = to_file
84
self._show_pct = show_pct
85
self._show_spinner = show_spinner
86
self._show_eta = show_eta
87
self._show_bar = show_bar
88
self._show_count = show_count
89
self._to_messages_file = to_messages_file
91
self._klass = klass or TTYProgressBar
94
if len(self._stack) != 0:
95
return self._stack[-1]
100
if len(self._stack) != 0:
101
return self._stack[0]
105
def get_nested(self):
106
"""Return a nested progress bar."""
107
if len(self._stack) == 0:
110
func = self.top().child_progress
111
new_bar = func(to_file=self._to_file,
112
show_pct=self._show_pct,
113
show_spinner=self._show_spinner,
114
show_eta=self._show_eta,
115
show_bar=self._show_bar,
116
show_count=self._show_count,
117
to_messages_file=self._to_messages_file,
119
self._stack.append(new_bar)
122
def return_pb(self, bar):
123
"""Return bar after its been used."""
124
if bar is not self._stack[-1]:
125
raise errors.MissingProgressBarFinish()
183
129
class _BaseProgressBar(object):
185
131
def __init__(self,
188
134
show_spinner=False,
192
to_messages_file=None,
138
to_messages_file=sys.stdout,
194
140
object.__init__(self)
197
if to_messages_file is None:
198
to_messages_file = sys.stdout
199
141
self.to_file = to_file
200
142
self.to_messages_file = to_messages_file
201
143
self.last_msg = None
251
193
def note(self, fmt_string, *args, **kwargs):
252
194
"""See _BaseProgressBar.note()."""
254
196
def child_progress(self, **kwargs):
255
197
return DummyProgress(**kwargs)
199
class DotsProgressBar(_BaseProgressBar):
201
def __init__(self, **kwargs):
202
_BaseProgressBar.__init__(self, **kwargs)
209
def update(self, msg=None, current_cnt=None, total_cnt=None):
210
if msg and msg != self.last_msg:
212
self.to_file.write('\n')
214
self.to_file.write(msg + ': ')
217
self.to_file.write('.')
221
self.to_file.write('\n')
223
def child_update(self, message, current, total):
226
class TTYProgressBar(_BaseProgressBar):
227
"""Progress bar display object.
229
Several options are available to control the display. These can
230
be passed as parameters to the constructor or assigned at any time:
233
Show percentage complete.
235
Show rotating baton. This ticks over on every update even
236
if the values don't change.
238
Show predicted time-to-completion.
242
Show numerical counts.
244
The output file should be in line-buffered or unbuffered mode.
249
def __init__(self, **kwargs):
250
from bzrlib.osutils import terminal_width
251
_BaseProgressBar.__init__(self, **kwargs)
253
self.width = terminal_width()
254
self.start_time = None
255
self.last_updates = deque()
256
self.child_fraction = 0
260
"""Return True if the bar was updated too recently"""
261
# time.time consistently takes 40/4000 ms = 0.01 ms.
262
# but every single update to the pb invokes it.
263
# so we use time.clock which takes 20/4000 ms = 0.005ms
264
# on the downside, time.clock() appears to have approximately
265
# 10ms granularity, so we treat a zero-time change as 'throttled.'
268
interval = now - self.last_update
270
if interval < self.MIN_PAUSE:
273
self.last_updates.append(now - self.last_update)
274
self.last_update = now
279
self.update(self.last_msg, self.last_cnt, self.last_total,
282
def child_update(self, message, current, total):
283
if current is not None and total != 0:
284
child_fraction = float(current) / total
285
if self.last_cnt is None:
287
elif self.last_cnt + child_fraction <= self.last_total:
288
self.child_fraction = child_fraction
290
mutter('not updating child fraction')
291
if self.last_msg is None:
296
def update(self, msg, current_cnt=None, total_cnt=None,
298
"""Update and redraw progress bar."""
303
if current_cnt > total_cnt:
304
total_cnt = current_cnt
306
## # optional corner case optimisation
307
## # currently does not seem to fire so costs more than saved.
308
## # trivial optimal case:
309
## # NB if callers are doing a clear and restore with
310
## # the saved values, this will prevent that:
311
## # in that case add a restore method that calls
312
## # _do_update or some such
313
## if (self.last_msg == msg and
314
## self.last_cnt == current_cnt and
315
## self.last_total == total_cnt and
316
## self.child_fraction == child_fraction):
319
old_msg = self.last_msg
320
# save these for the tick() function
322
self.last_cnt = current_cnt
323
self.last_total = total_cnt
324
self.child_fraction = child_fraction
326
# each function call takes 20ms/4000 = 0.005 ms,
327
# but multiple that by 4000 calls -> starts to cost.
328
# so anything to make this function call faster
329
# will improve base 'diff' time by up to 0.1 seconds.
330
if old_msg == self.last_msg and self.throttle():
333
if self.show_eta and self.start_time and self.last_total:
334
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
335
self.last_total, last_updates = self.last_updates)
336
eta_str = " " + str_tdelta(eta)
340
if self.show_spinner:
341
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
345
# always update this; it's also used for the bar
348
if self.show_pct and self.last_total and self.last_cnt:
349
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
350
pct_str = ' (%5.1f%%)' % pct
354
if not self.show_count:
356
elif self.last_cnt is None:
358
elif self.last_total is None:
359
count_str = ' %i' % (self.last_cnt)
361
# make both fields the same size
362
t = '%i' % (self.last_total)
363
c = '%*i' % (len(t), self.last_cnt)
364
count_str = ' ' + c + '/' + t
367
# progress bar, if present, soaks up all remaining space
368
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
369
- len(eta_str) - len(count_str) - 3
372
# number of markers highlighted in bar
373
markers = int(round(float(cols) *
374
(self.last_cnt + self.child_fraction) / self.last_total))
375
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
377
# don't know total, so can't show completion.
378
# so just show an expanded spinning thingy
379
m = self.spin_pos % cols
380
ms = (' ' * m + '*').ljust(cols)
382
bar_str = '[' + ms + '] '
388
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
390
assert len(m) < self.width
391
self.to_file.write('\r' + m.ljust(self.width - 1))
392
#self.to_file.flush()
395
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
396
#self.to_file.flush()
399
class ChildProgress(_BaseProgressBar):
400
"""A progress indicator that pushes its data to the parent"""
401
def __init__(self, _stack, **kwargs):
402
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
403
self.parent = _stack.top()
406
self.child_fraction = 0
409
def update(self, msg, current_cnt=None, total_cnt=None):
410
self.current = current_cnt
411
self.total = total_cnt
413
self.child_fraction = 0
416
def child_update(self, message, current, total):
417
if current is None or total == 0:
418
self.child_fraction = 0
420
self.child_fraction = float(current) / total
424
if self.current is None:
427
count = self.current+self.child_fraction
428
if count > self.total:
430
mutter('clamping count of %d to %d' % (count, self.total))
432
self.parent.child_update(self.message, count, self.total)
258
438
def str_tdelta(delt):
added
removed
bzrlib/progress.py
