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.
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.
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
42
from collections import deque
45
import bzrlib.errors as errors
46
from bzrlib.trace import mutter
37
from bzrlib.trace import mutter
38
from bzrlib.symbol_versioning import (
45
# XXX: deprecated; can be removed when the ProgressBar factory is removed
49
46
def _supports_progress(f):
50
if not hasattr(f, 'isatty'):
47
"""Detect if we can use pretty progress bars on the output stream f.
49
If this returns true we expect that a human may be looking at that
50
output, and that we can repaint a line to update it.
52
isatty = getattr(f, 'isatty', None)
54
57
if os.environ.get('TERM') == 'dumb':
55
58
# e.g. emacs compile window
61
def ProgressBar(to_file=sys.stderr, **kwargs):
63
class ProgressTask(object):
64
"""Model component of a progress indicator.
66
Most code that needs to indicate progress should update one of these,
67
and it will in turn update the display, if one is present.
69
Code updating the task may also set fields as hints about how to display
70
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
71
will not necessarily respect all these fields.
74
def __init__(self, parent_task=None, ui_factory=None):
75
"""Construct a new progress task.
77
Normally you should not call this directly but rather through
78
`ui_factory.nested_progress_bar`.
80
self._parent_task = parent_task
83
self.current_cnt = None
85
self.ui_factory = ui_factory
87
self.show_spinner = True
88
self.show_eta = False,
89
self.show_count = True
93
return '%s(%r/%r, msg=%r)' % (
94
self.__class__.__name__,
99
def update(self, msg, current_cnt=None, total_cnt=None):
101
self.current_cnt = current_cnt
103
self.total_cnt = total_cnt
104
self.ui_factory._progress_updated(self)
107
self.update(self.msg)
110
self.ui_factory._progress_finished(self)
112
def make_sub_task(self):
113
return ProgressTask(self, self.ui_factory)
115
def _overall_completion_fraction(self, child_fraction=0.0):
116
"""Return fractional completion of this task and its parents
118
Returns None if no completion can be computed."""
119
if self.current_cnt is not None and self.total_cnt:
120
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
122
# if this task has no estimation, it just passes on directly
123
# whatever the child has measured...
124
own_fraction = child_fraction
125
if self._parent_task is None:
128
if own_fraction is None:
130
return self._parent_task._overall_completion_fraction(own_fraction)
132
def note(self, fmt_string, *args):
133
"""Record a note without disrupting the progress bar."""
134
# XXX: shouldn't be here; put it in mutter or the ui instead
136
self.ui_factory.note(fmt_string % args)
138
self.ui_factory.note(fmt_string)
141
# XXX: shouldn't be here; put it in mutter or the ui instead
142
self.ui_factory.clear_term()
145
@deprecated_function(deprecated_in((1, 16, 0)))
146
def ProgressBar(to_file=None, **kwargs):
62
147
"""Abstract factory"""
63
if _supports_progress(to_file):
64
return TTYProgressBar(to_file=to_file, **kwargs)
150
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
151
# An value of '' or not set reverts to standard processing
152
if requested_bar_type in (None, ''):
153
if _supports_progress(to_file):
154
return TTYProgressBar(to_file=to_file, **kwargs)
156
return DummyProgress(to_file=to_file, **kwargs)
66
return DotsProgressBar(to_file=to_file, **kwargs)
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()
158
# Minor sanitation to prevent spurious errors
159
requested_bar_type = requested_bar_type.lower().strip()
160
# TODO: jam 20060710 Arguably we shouldn't raise an exception
161
# but should instead just disable progress bars if we
162
# don't recognize the type
163
if requested_bar_type not in _progress_bar_types:
164
raise errors.InvalidProgressBarType(requested_bar_type,
165
_progress_bar_types.keys())
166
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
128
169
class _BaseProgressBar(object):
130
171
def __init__(self,
133
174
show_spinner=False,
137
to_messages_file=sys.stdout,
178
to_messages_file=None,
139
180
object.__init__(self)
183
if to_messages_file is None:
184
to_messages_file = sys.stdout
140
185
self.to_file = to_file
141
186
self.to_messages_file = to_messages_file
142
187
self.last_msg = None
192
238
def note(self, fmt_string, *args, **kwargs):
193
239
"""See _BaseProgressBar.note()."""
195
241
def child_progress(self, **kwargs):
196
242
return DummyProgress(**kwargs)
198
245
class DotsProgressBar(_BaseProgressBar):
247
@deprecated_function(deprecated_in((1, 16, 0)))
200
248
def __init__(self, **kwargs):
201
249
_BaseProgressBar.__init__(self, **kwargs)
202
250
self.last_msg = None
203
251
self.need_nl = False
208
256
def update(self, msg=None, current_cnt=None, total_cnt=None):
209
257
if msg and msg != self.last_msg:
211
259
self.to_file.write('\n')
213
260
self.to_file.write(msg + ': ')
214
261
self.last_msg = msg
215
262
self.need_nl = True
216
263
self.to_file.write('.')
220
267
self.to_file.write('\n')
222
270
def child_update(self, message, current, total):
225
274
class TTYProgressBar(_BaseProgressBar):
226
275
"""Progress bar display object.
245
294
SPIN_CHARS = r'/-\|'
296
@deprecated_function(deprecated_in((1, 16, 0)))
248
297
def __init__(self, **kwargs):
249
298
from bzrlib.osutils import terminal_width
250
299
_BaseProgressBar.__init__(self, **kwargs)
251
300
self.spin_pos = 0
252
301
self.width = terminal_width()
253
self.start_time = None
254
self.last_updates = deque()
302
self.last_updates = []
303
self._max_last_updates = 10
255
304
self.child_fraction = 0
305
self._have_output = False
307
def throttle(self, old_msg):
259
308
"""Return True if the bar was updated too recently"""
260
309
# time.time consistently takes 40/4000 ms = 0.01 ms.
261
# but every single update to the pb invokes it.
262
# so we use time.clock which takes 20/4000 ms = 0.005ms
263
# on the downside, time.clock() appears to have approximately
264
# 10ms granularity, so we treat a zero-time change as 'throttled.'
310
# time.clock() is faster, but gives us CPU time, not wall-clock time
312
if self.start_time is not None and (now - self.start_time) < 1:
314
if old_msg != self.last_msg:
267
316
interval = now - self.last_update
268
317
# if interval > 0
269
318
if interval < self.MIN_PAUSE:
272
321
self.last_updates.append(now - self.last_update)
322
# Don't let the queue grow without bound
323
self.last_updates = self.last_updates[-self._max_last_updates:]
273
324
self.last_update = now
278
self.update(self.last_msg, self.last_cnt, self.last_total,
328
self.update(self.last_msg, self.last_cnt, self.last_total,
279
329
self.child_fraction)
281
331
def child_update(self, message, current, total):
286
336
elif self.last_cnt + child_fraction <= self.last_total:
287
337
self.child_fraction = child_fraction
289
mutter('not updating child fraction')
290
338
if self.last_msg is None:
291
339
self.last_msg = ''
342
def update(self, msg, current_cnt=None, total_cnt=None,
344
"""Update and redraw progress bar.
295
def update(self, msg, current_cnt=None, total_cnt=None,
297
"""Update and redraw progress bar."""
349
if total_cnt is None:
350
total_cnt = self.last_total
299
352
if current_cnt < 0:
302
355
if current_cnt > total_cnt:
303
356
total_cnt = current_cnt
305
## # optional corner case optimisation
358
## # optional corner case optimisation
306
359
## # currently does not seem to fire so costs more than saved.
307
360
## # trivial optimal case:
308
361
## # NB if callers are doing a clear and restore with
322
378
self.last_total = total_cnt
323
379
self.child_fraction = child_fraction
325
# each function call takes 20ms/4000 = 0.005 ms,
381
# each function call takes 20ms/4000 = 0.005 ms,
326
382
# but multiple that by 4000 calls -> starts to cost.
327
383
# so anything to make this function call faster
328
384
# will improve base 'diff' time by up to 0.1 seconds.
329
if old_msg == self.last_msg and self.throttle():
385
if self.throttle(old_msg):
332
388
if self.show_eta and self.start_time and self.last_total:
333
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
389
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
334
390
self.last_total, last_updates = self.last_updates)
335
391
eta_str = " " + str_tdelta(eta)
339
395
if self.show_spinner:
340
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
396
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
377
433
# so just show an expanded spinning thingy
378
434
m = self.spin_pos % cols
379
435
ms = (' ' * m + '*').ljust(cols)
381
437
bar_str = '[' + ms + '] '
387
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
443
m = spin_str + bar_str + self.last_msg + count_str \
445
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
446
self._have_output = True
447
#self.to_file.flush()
389
assert len(m) < self.width
390
self.to_file.write('\r' + m.ljust(self.width - 1))
450
if self._have_output:
451
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
452
self._have_output = False
391
453
#self.to_file.flush()
394
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
395
#self.to_file.flush()
398
456
class ChildProgress(_BaseProgressBar):
399
457
"""A progress indicator that pushes its data to the parent"""
459
@deprecated_function(deprecated_in((1, 16, 0)))
400
460
def __init__(self, _stack, **kwargs):
401
461
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
402
462
self.parent = _stack.top()
added
removed
bzrlib/progress.py
