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
49
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.
50
if not hasattr(f, 'isatty'):
53
54
if os.environ.get('TERM') == 'dumb':
54
55
# 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.
61
def ProgressBar(to_file=None, **kwargs):
62
"""Abstract factory"""
65
if _supports_progress(to_file):
66
return TTYProgressBar(to_file=to_file, **kwargs)
68
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)
71
class ProgressBarStack(object):
72
"""A stack of progress bars."""
81
to_messages_file=None,
83
"""Setup the stack with the parameters the progress bars should have."""
86
if to_messages_file is None:
87
to_messages_file = sys.stdout
88
self._to_file = to_file
89
self._show_pct = show_pct
90
self._show_spinner = show_spinner
91
self._show_eta = show_eta
92
self._show_bar = show_bar
93
self._show_count = show_count
94
self._to_messages_file = to_messages_file
96
self._klass = klass or TTYProgressBar
99
if len(self._stack) != 0:
100
return self._stack[-1]
105
if len(self._stack) != 0:
106
return self._stack[0]
110
def get_nested(self):
111
"""Return a nested progress bar."""
112
if len(self._stack) == 0:
115
func = self.top().child_progress
116
new_bar = func(to_file=self._to_file,
117
show_pct=self._show_pct,
118
show_spinner=self._show_spinner,
119
show_eta=self._show_eta,
120
show_bar=self._show_bar,
121
show_count=self._show_count,
122
to_messages_file=self._to_messages_file,
124
self._stack.append(new_bar)
127
def return_pb(self, bar):
128
"""Return bar after its been used."""
129
if bar is not self._stack[-1]:
130
raise errors.MissingProgressBarFinish()
134
class _BaseProgressBar(object):
143
to_messages_file=None,
145
object.__init__(self)
148
if to_messages_file is None:
149
to_messages_file = sys.stdout
150
self.to_file = to_file
151
self.to_messages_file = to_messages_file
154
self.last_total = None
155
self.show_pct = show_pct
156
self.show_spinner = show_spinner
157
self.show_eta = show_eta
158
self.show_bar = show_bar
159
self.show_count = show_count
162
self.MIN_PAUSE = 0.1 # seconds
165
self.start_time = now
166
# next update should not throttle
167
self.last_update = now - self.MIN_PAUSE - 1
128
169
def finished(self):
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
class DummyProgress(object):
170
"""Return this bar to its progress stack."""
172
assert self._stack is not None
173
self._stack.return_pb(self)
175
def note(self, fmt_string, *args, **kwargs):
176
"""Record a note without disrupting the progress bar."""
178
self.to_messages_file.write(fmt_string % args)
179
self.to_messages_file.write('\n')
181
def child_progress(self, **kwargs):
182
return ChildProgress(**kwargs)
185
class DummyProgress(_BaseProgressBar):
170
186
"""Progress-bar standin that does nothing.
172
This was previously often constructed by application code if no progress
173
bar was explicitly passed in. That's no longer recommended: instead, just
174
create a progress task from the ui_factory. This class can be used in
175
test code that needs to fake a progress task for some reason.
188
This can be used as the default argument for methods that
189
take an optional progress indicator."""
202
def note(self, fmt_string, *args, **kwargs):
203
"""See _BaseProgressBar.note()."""
190
205
def child_progress(self, **kwargs):
191
206
return DummyProgress(**kwargs)
209
class DotsProgressBar(_BaseProgressBar):
211
def __init__(self, **kwargs):
212
_BaseProgressBar.__init__(self, **kwargs)
219
def update(self, msg=None, current_cnt=None, total_cnt=None):
220
if msg and msg != self.last_msg:
222
self.to_file.write('\n')
223
self.to_file.write(msg + ': ')
226
self.to_file.write('.')
230
self.to_file.write('\n')
233
def child_update(self, message, current, total):
237
class TTYProgressBar(_BaseProgressBar):
238
"""Progress bar display object.
240
Several options are available to control the display. These can
241
be passed as parameters to the constructor or assigned at any time:
244
Show percentage complete.
246
Show rotating baton. This ticks over on every update even
247
if the values don't change.
249
Show predicted time-to-completion.
253
Show numerical counts.
255
The output file should be in line-buffered or unbuffered mode.
260
def __init__(self, **kwargs):
261
from bzrlib.osutils import terminal_width
262
_BaseProgressBar.__init__(self, **kwargs)
264
self.width = terminal_width()
265
self.start_time = None
266
self.last_updates = deque()
267
self.child_fraction = 0
271
"""Return True if the bar was updated too recently"""
272
# time.time consistently takes 40/4000 ms = 0.01 ms.
273
# but every single update to the pb invokes it.
274
# so we use time.clock which takes 20/4000 ms = 0.005ms
275
# on the downside, time.clock() appears to have approximately
276
# 10ms granularity, so we treat a zero-time change as 'throttled.'
279
interval = now - self.last_update
281
if interval < self.MIN_PAUSE:
284
self.last_updates.append(now - self.last_update)
285
self.last_update = now
290
self.update(self.last_msg, self.last_cnt, self.last_total,
293
def child_update(self, message, current, total):
294
if current is not None and total != 0:
295
child_fraction = float(current) / total
296
if self.last_cnt is None:
298
elif self.last_cnt + child_fraction <= self.last_total:
299
self.child_fraction = child_fraction
301
mutter('not updating child fraction')
302
if self.last_msg is None:
307
def update(self, msg, current_cnt=None, total_cnt=None,
309
"""Update and redraw progress bar."""
314
if current_cnt > total_cnt:
315
total_cnt = current_cnt
317
## # optional corner case optimisation
318
## # currently does not seem to fire so costs more than saved.
319
## # trivial optimal case:
320
## # NB if callers are doing a clear and restore with
321
## # the saved values, this will prevent that:
322
## # in that case add a restore method that calls
323
## # _do_update or some such
324
## if (self.last_msg == msg and
325
## self.last_cnt == current_cnt and
326
## self.last_total == total_cnt and
327
## self.child_fraction == child_fraction):
330
old_msg = self.last_msg
331
# save these for the tick() function
333
self.last_cnt = current_cnt
334
self.last_total = total_cnt
335
self.child_fraction = child_fraction
337
# each function call takes 20ms/4000 = 0.005 ms,
338
# but multiple that by 4000 calls -> starts to cost.
339
# so anything to make this function call faster
340
# will improve base 'diff' time by up to 0.1 seconds.
341
if old_msg == self.last_msg and self.throttle():
344
if self.show_eta and self.start_time and self.last_total:
345
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
346
self.last_total, last_updates = self.last_updates)
347
eta_str = " " + str_tdelta(eta)
351
if self.show_spinner:
352
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
356
# always update this; it's also used for the bar
359
if self.show_pct and self.last_total and self.last_cnt:
360
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
361
pct_str = ' (%5.1f%%)' % pct
365
if not self.show_count:
367
elif self.last_cnt is None:
369
elif self.last_total is None:
370
count_str = ' %i' % (self.last_cnt)
372
# make both fields the same size
373
t = '%i' % (self.last_total)
374
c = '%*i' % (len(t), self.last_cnt)
375
count_str = ' ' + c + '/' + t
378
# progress bar, if present, soaks up all remaining space
379
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
380
- len(eta_str) - len(count_str) - 3
383
# number of markers highlighted in bar
384
markers = int(round(float(cols) *
385
(self.last_cnt + self.child_fraction) / self.last_total))
386
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
388
# don't know total, so can't show completion.
389
# so just show an expanded spinning thingy
390
m = self.spin_pos % cols
391
ms = (' ' * m + '*').ljust(cols)
393
bar_str = '[' + ms + '] '
399
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
401
assert len(m) < self.width
402
self.to_file.write('\r' + m.ljust(self.width - 1))
403
#self.to_file.flush()
406
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
407
#self.to_file.flush()
410
class ChildProgress(_BaseProgressBar):
411
"""A progress indicator that pushes its data to the parent"""
413
def __init__(self, _stack, **kwargs):
414
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
415
self.parent = _stack.top()
418
self.child_fraction = 0
421
def update(self, msg, current_cnt=None, total_cnt=None):
422
self.current = current_cnt
423
self.total = total_cnt
425
self.child_fraction = 0
428
def child_update(self, message, current, total):
429
if current is None or total == 0:
430
self.child_fraction = 0
432
self.child_fraction = float(current) / total
436
if self.current is None:
439
count = self.current+self.child_fraction
440
if count > self.total:
442
mutter('clamping count of %d to %d' % (count, self.total))
444
self.parent.child_update(self.message, count, self.total)
449
def note(self, *args, **kwargs):
450
self.parent.note(*args, **kwargs)
194
453
def str_tdelta(delt):
added
removed
bzrlib/progress.py
