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, 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
44
"""Return estimated terminal width.
46
TODO: Do something smart on Windows?
48
TODO: Is there anything that gets a better update when the window
49
is resized while the program is running?
53
return int(os.environ['COLUMNS'])
54
except (IndexError, KeyError, ValueError):
37
from bzrlib.trace import mutter
38
from bzrlib.symbol_versioning import (
45
# XXX: deprecated; can be removed when the ProgressBar factory is removed
58
46
def _supports_progress(f):
59
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)
64
57
if os.environ.get('TERM') == 'dumb':
65
58
# e.g. emacs compile window
71
class ProgressBar(object):
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):
147
"""Abstract factory"""
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)
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)
169
class _BaseProgressBar(object):
178
to_messages_file=None,
180
object.__init__(self)
183
if to_messages_file is None:
184
to_messages_file = sys.stdout
185
self.to_file = to_file
186
self.to_messages_file = to_messages_file
189
self.last_total = None
190
self.show_pct = show_pct
191
self.show_spinner = show_spinner
192
self.show_eta = show_eta
193
self.show_bar = show_bar
194
self.show_count = show_count
197
self.MIN_PAUSE = 0.1 # seconds
200
self.start_time = now
201
# next update should not throttle
202
self.last_update = now - self.MIN_PAUSE - 1
205
"""Return this bar to its progress stack."""
207
self._stack.return_pb(self)
209
def note(self, fmt_string, *args, **kwargs):
210
"""Record a note without disrupting the progress bar."""
212
self.to_messages_file.write(fmt_string % args)
213
self.to_messages_file.write('\n')
215
@deprecated_function(deprecated_in((1, 16, 0)))
216
def child_progress(self, **kwargs):
217
return ChildProgress(**kwargs)
220
class DummyProgress(_BaseProgressBar):
221
"""Progress-bar standin that does nothing.
223
This can be used as the default argument for methods that
224
take an optional progress indicator."""
229
def update(self, msg=None, current=None, total=None):
232
def child_update(self, message, current, total):
238
def note(self, fmt_string, *args, **kwargs):
239
"""See _BaseProgressBar.note()."""
241
def child_progress(self, **kwargs):
242
return DummyProgress(**kwargs)
245
class DotsProgressBar(_BaseProgressBar):
247
@deprecated_function(deprecated_in((1, 16, 0)))
248
def __init__(self, **kwargs):
249
_BaseProgressBar.__init__(self, **kwargs)
256
def update(self, msg=None, current_cnt=None, total_cnt=None):
257
if msg and msg != self.last_msg:
259
self.to_file.write('\n')
260
self.to_file.write(msg + ': ')
263
self.to_file.write('.')
267
self.to_file.write('\n')
270
def child_update(self, message, current, total):
274
class TTYProgressBar(_BaseProgressBar):
72
275
"""Progress bar display object.
74
277
Several options are available to control the display. These can
89
292
The output file should be in line-buffered or unbuffered mode.
91
294
SPIN_CHARS = r'/-\|'
92
MIN_PAUSE = 0.1 # seconds
104
object.__init__(self)
105
self.to_file = to_file
106
self.suppressed = not _supports_progress(self.to_file)
296
@deprecated_function(deprecated_in((1, 16, 0)))
297
def __init__(self, **kwargs):
298
from bzrlib.osutils import terminal_width
299
_BaseProgressBar.__init__(self, **kwargs)
107
300
self.spin_pos = 0
111
self.last_total = None
112
self.show_pct = show_pct
113
self.show_spinner = show_spinner
114
self.show_eta = show_eta
115
self.show_bar = show_bar
116
self.show_count = show_count
118
self.width = _width()
301
self.width = terminal_width()
302
self.last_updates = []
303
self._max_last_updates = 10
304
self.child_fraction = 0
305
self._have_output = False
307
def throttle(self, old_msg):
308
"""Return True if the bar was updated too recently"""
309
# time.time consistently takes 40/4000 ms = 0.01 ms.
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:
316
interval = now - self.last_update
318
if interval < self.MIN_PAUSE:
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:]
324
self.last_update = now
122
self.update(self.last_msg, self.last_cnt, self.last_total)
126
def update(self, msg, current_cnt=None, total_cnt=None):
127
"""Update and redraw progress bar."""
328
self.update(self.last_msg, self.last_cnt, self.last_total,
331
def child_update(self, message, current, total):
332
if current is not None and total != 0:
333
child_fraction = float(current) / total
334
if self.last_cnt is None:
336
elif self.last_cnt + child_fraction <= self.last_total:
337
self.child_fraction = child_fraction
338
if self.last_msg is None:
342
def update(self, msg, current_cnt=None, total_cnt=None,
344
"""Update and redraw progress bar.
349
if total_cnt is None:
350
total_cnt = self.last_total
355
if current_cnt > total_cnt:
356
total_cnt = current_cnt
358
## # optional corner case optimisation
359
## # currently does not seem to fire so costs more than saved.
360
## # trivial optimal case:
361
## # NB if callers are doing a clear and restore with
362
## # the saved values, this will prevent that:
363
## # in that case add a restore method that calls
364
## # _do_update or some such
365
## if (self.last_msg == msg and
366
## self.last_cnt == current_cnt and
367
## self.last_total == total_cnt and
368
## self.child_fraction == child_fraction):
374
old_msg = self.last_msg
131
375
# save these for the tick() function
132
376
self.last_msg = msg
133
377
self.last_cnt = current_cnt
134
378
self.last_total = total_cnt
137
if self.start_time is None:
138
self.start_time = now
140
interval = now - self.last_update
141
if interval > 0 and interval < self.MIN_PAUSE:
144
self.last_update = now
147
assert current_cnt <= total_cnt
149
assert current_cnt >= 0
151
if self.show_eta and self.start_time and total_cnt:
152
eta = get_eta(self.start_time, current_cnt, total_cnt)
379
self.child_fraction = child_fraction
381
# each function call takes 20ms/4000 = 0.005 ms,
382
# but multiple that by 4000 calls -> starts to cost.
383
# so anything to make this function call faster
384
# will improve base 'diff' time by up to 0.1 seconds.
385
if self.throttle(old_msg):
388
if self.show_eta and self.start_time and self.last_total:
389
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
390
self.last_total, last_updates = self.last_updates)
153
391
eta_str = " " + str_tdelta(eta)
157
395
if self.show_spinner:
158
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
396
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
162
400
# always update this; it's also used for the bar
163
401
self.spin_pos += 1
165
if self.show_pct and total_cnt and current_cnt:
166
pct = 100.0 * current_cnt / total_cnt
403
if self.show_pct and self.last_total and self.last_cnt:
404
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
167
405
pct_str = ' (%5.1f%%)' % pct
171
409
if not self.show_count:
173
elif current_cnt is None:
411
elif self.last_cnt is None:
175
elif total_cnt is None:
176
count_str = ' %i' % (current_cnt)
413
elif self.last_total is None:
414
count_str = ' %i' % (self.last_cnt)
178
416
# make both fields the same size
179
t = '%i' % (total_cnt)
180
c = '%*i' % (len(t), current_cnt)
181
count_str = ' ' + c + '/' + t
417
t = '%i' % (self.last_total)
418
c = '%*i' % (len(t), self.last_cnt)
419
count_str = ' ' + c + '/' + t
183
421
if self.show_bar:
184
422
# progress bar, if present, soaks up all remaining space
185
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
423
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
186
424
- len(eta_str) - len(count_str) - 3
189
427
# number of markers highlighted in bar
190
markers = int(round(float(cols) * current_cnt / total_cnt))
428
markers = int(round(float(cols) *
429
(self.last_cnt + self.child_fraction) / self.last_total))
191
430
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
193
432
# don't know total, so can't show completion.
194
433
# so just show an expanded spinning thingy
195
434
m = self.spin_pos % cols
196
435
ms = (' ' * m + '*').ljust(cols)
198
437
bar_str = '[' + ms + '] '
204
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
206
assert len(m) < self.width
207
self.to_file.write('\r' + m.ljust(self.width - 1))
208
#self.to_file.flush()
215
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
216
#self.to_file.flush()
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()
450
if self._have_output:
451
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
452
self._have_output = False
453
#self.to_file.flush()
456
class ChildProgress(_BaseProgressBar):
457
"""A progress indicator that pushes its data to the parent"""
459
@deprecated_function(deprecated_in((1, 16, 0)))
460
def __init__(self, _stack, **kwargs):
461
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
462
self.parent = _stack.top()
465
self.child_fraction = 0
468
def update(self, msg, current_cnt=None, total_cnt=None):
469
self.current = current_cnt
470
if total_cnt is not None:
471
self.total = total_cnt
473
self.child_fraction = 0
476
def child_update(self, message, current, total):
477
if current is None or total == 0:
478
self.child_fraction = 0
480
self.child_fraction = float(current) / total
484
if self.current is None:
487
count = self.current+self.child_fraction
488
if count > self.total:
490
mutter('clamping count of %d to %d' % (count, self.total))
492
self.parent.child_update(self.message, count, self.total)
497
def note(self, *args, **kwargs):
498
self.parent.note(*args, **kwargs)
220
501
def str_tdelta(delt):
added
removed
bzrlib/progress.py
