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.
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.
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
33
from bzrlib.trace import mutter
34
from bzrlib.symbol_versioning import (
42
from collections import deque
46
"""Return estimated terminal width.
48
TODO: Do something smart on Windows?
50
TODO: Is there anything that gets a better update when the window
51
is resized while the program is running?
54
return int(os.environ['COLUMNS'])
55
except (IndexError, KeyError, ValueError):
40
59
def _supports_progress(f):
41
"""Detect if we can use pretty progress bars on file F.
43
If this returns true we expect that a human may be looking at that
44
output, and that we can repaint a line to update it.
46
This doesn't check the policy for whether we *should* use them.
48
isatty = getattr(f, 'isatty', None)
53
# The following case also handles Win32 - on that platform $TERM is
54
# typically never set, so the case None is treated as a smart terminal,
55
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
56
# isatty methods that return true.
60
if not hasattr(f, 'isatty'):
57
64
if os.environ.get('TERM') == 'dumb':
58
65
# e.g. emacs compile window
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.
73
:ivar update_latency: The interval (in seconds) at which the PB should be
74
updated. Setting this to zero suggests every update should be shown
77
:ivar show_transport_activity: If true (default), transport activity
78
will be shown when this task is drawn. Disable it if you're sure
79
that only irrelevant or uninteresting transport activity can occur
83
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
84
"""Construct a new progress task.
86
:param parent_task: Enclosing ProgressTask or None.
88
:param progress_view: ProgressView to display this ProgressTask.
90
:param ui_factory: The UI factory that will display updates;
91
deprecated in favor of passing progress_view directly.
93
Normally you should not call this directly but rather through
94
`ui_factory.nested_progress_bar`.
96
self._parent_task = parent_task
99
self.current_cnt = None
101
# TODO: deprecate passing ui_factory
102
self.ui_factory = ui_factory
103
self.progress_view = progress_view
104
self.show_pct = False
105
self.show_spinner = True
106
self.show_eta = False,
107
self.show_count = True
109
self.update_latency = 0.1
110
self.show_transport_activity = True
113
return '%s(%r/%r, msg=%r)' % (
114
self.__class__.__name__,
119
def update(self, msg, current_cnt=None, total_cnt=None):
121
self.current_cnt = current_cnt
123
self.total_cnt = total_cnt
124
if self.progress_view:
125
self.progress_view.show_progress(self)
127
self.ui_factory._progress_updated(self)
130
self.update(self.msg)
133
if self.progress_view:
134
self.progress_view.task_finished(self)
136
self.ui_factory._progress_finished(self)
138
def make_sub_task(self):
139
return ProgressTask(self, ui_factory=self.ui_factory,
140
progress_view=self.progress_view)
142
def _overall_completion_fraction(self, child_fraction=0.0):
143
"""Return fractional completion of this task and its parents
145
Returns None if no completion can be computed."""
146
if self.current_cnt is not None and self.total_cnt:
147
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
149
# if this task has no estimation, it just passes on directly
150
# whatever the child has measured...
151
own_fraction = child_fraction
152
if self._parent_task is None:
155
if own_fraction is None:
157
return self._parent_task._overall_completion_fraction(own_fraction)
159
def note(self, fmt_string, *args):
160
"""Record a note without disrupting the progress bar."""
161
# XXX: shouldn't be here; put it in mutter or the ui instead
163
self.ui_factory.note(fmt_string % args)
165
self.ui_factory.note(fmt_string)
168
# XXX: shouldn't be here; put it in mutter or the ui instead
169
if self.progress_view:
170
self.progress_view.clear()
172
self.ui_factory.clear_term()
175
@deprecated_function(deprecated_in((1, 16, 0)))
176
def ProgressBar(to_file=None, **kwargs):
177
"""Construct a progress bar.
179
Deprecated; ask the ui_factory for a progress task instead.
183
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
184
# An value of '' or not set reverts to standard processing
185
if requested_bar_type in (None, ''):
186
if _supports_progress(to_file):
187
return TTYProgressBar(to_file=to_file, **kwargs)
189
return DummyProgress(to_file=to_file, **kwargs)
71
def ProgressBar(to_file=sys.stderr, **kwargs):
72
"""Abstract factory"""
73
if _supports_progress(to_file):
74
return TTYProgressBar(to_file=to_file, **kwargs)
191
# Minor sanitation to prevent spurious errors
192
requested_bar_type = requested_bar_type.lower().strip()
193
# TODO: jam 20060710 Arguably we shouldn't raise an exception
194
# but should instead just disable progress bars if we
195
# don't recognize the type
196
if requested_bar_type not in _progress_bar_types:
197
raise errors.InvalidProgressBarType(requested_bar_type,
198
_progress_bar_types.keys())
199
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
202
# NOTE: This is also deprecated; you should provide a ProgressView instead.
76
return DotsProgressBar(to_file=to_file, **kwargs)
203
79
class _BaseProgressBar(object):
205
80
def __init__(self,
208
83
show_spinner=False,
212
to_messages_file=None,
214
87
object.__init__(self)
217
if to_messages_file is None:
218
to_messages_file = sys.stdout
219
88
self.to_file = to_file
220
self.to_messages_file = to_messages_file
221
90
self.last_msg = None
222
91
self.last_cnt = None
223
92
self.last_total = None
326
158
The output file should be in line-buffered or unbuffered mode.
328
160
SPIN_CHARS = r'/-\|'
330
@deprecated_function(deprecated_in((1, 16, 0)))
161
MIN_PAUSE = 0.1 # seconds
331
164
def __init__(self, **kwargs):
332
from bzrlib.osutils import terminal_width
333
165
_BaseProgressBar.__init__(self, **kwargs)
334
166
self.spin_pos = 0
335
self.width = terminal_width()
336
self.last_updates = []
337
self._max_last_updates = 10
338
self.child_fraction = 0
339
self._have_output = False
167
self.width = _width()
168
self.start_time = None
169
self.last_update = None
170
self.last_updates = deque()
341
def throttle(self, old_msg):
342
174
"""Return True if the bar was updated too recently"""
343
# time.time consistently takes 40/4000 ms = 0.01 ms.
344
# time.clock() is faster, but gives us CPU time, not wall-clock time
345
175
now = time.time()
346
if self.start_time is not None and (now - self.start_time) < 1:
348
if old_msg != self.last_msg:
176
if self.start_time is None:
177
self.start_time = self.last_update = now
350
interval = now - self.last_update
352
if interval < self.MIN_PAUSE:
180
interval = now - self.last_update
181
if interval > 0 and interval < self.MIN_PAUSE:
355
184
self.last_updates.append(now - self.last_update)
356
# Don't let the queue grow without bound
357
self.last_updates = self.last_updates[-self._max_last_updates:]
358
185
self.last_update = now
362
self.update(self.last_msg, self.last_cnt, self.last_total,
365
def child_update(self, message, current, total):
366
if current is not None and total != 0:
367
child_fraction = float(current) / total
368
if self.last_cnt is None:
370
elif self.last_cnt + child_fraction <= self.last_total:
371
self.child_fraction = child_fraction
372
if self.last_msg is None:
376
def update(self, msg, current_cnt=None, total_cnt=None,
378
"""Update and redraw progress bar.
383
if total_cnt is None:
384
total_cnt = self.last_total
190
self.update(self.last_msg, self.last_cnt, self.last_total)
194
def update(self, msg, current_cnt=None, total_cnt=None):
195
"""Update and redraw progress bar."""
386
197
if current_cnt < 0:
389
200
if current_cnt > total_cnt:
390
201
total_cnt = current_cnt
392
## # optional corner case optimisation
393
## # currently does not seem to fire so costs more than saved.
394
## # trivial optimal case:
395
## # NB if callers are doing a clear and restore with
396
## # the saved values, this will prevent that:
397
## # in that case add a restore method that calls
398
## # _do_update or some such
399
## if (self.last_msg == msg and
400
## self.last_cnt == current_cnt and
401
## self.last_total == total_cnt and
402
## self.child_fraction == child_fraction):
408
old_msg = self.last_msg
409
203
# save these for the tick() function
410
204
self.last_msg = msg
411
205
self.last_cnt = current_cnt
412
206
self.last_total = total_cnt
413
self.child_fraction = child_fraction
415
# each function call takes 20ms/4000 = 0.005 ms,
416
# but multiple that by 4000 calls -> starts to cost.
417
# so anything to make this function call faster
418
# will improve base 'diff' time by up to 0.1 seconds.
419
if self.throttle(old_msg):
422
if self.show_eta and self.start_time and self.last_total:
423
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
424
self.last_total, last_updates = self.last_updates)
211
if self.show_eta and self.start_time and total_cnt:
212
eta = get_eta(self.start_time, current_cnt, total_cnt,
213
last_updates = self.last_updates)
425
214
eta_str = " " + str_tdelta(eta)
429
218
if self.show_spinner:
430
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
219
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
434
223
# always update this; it's also used for the bar
435
224
self.spin_pos += 1
437
if self.show_pct and self.last_total and self.last_cnt:
438
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
226
if self.show_pct and total_cnt and current_cnt:
227
pct = 100.0 * current_cnt / total_cnt
439
228
pct_str = ' (%5.1f%%)' % pct
443
232
if not self.show_count:
445
elif self.last_cnt is None:
234
elif current_cnt is None:
447
elif self.last_total is None:
448
count_str = ' %i' % (self.last_cnt)
236
elif total_cnt is None:
237
count_str = ' %i' % (current_cnt)
450
239
# make both fields the same size
451
t = '%i' % (self.last_total)
452
c = '%*i' % (len(t), self.last_cnt)
453
count_str = ' ' + c + '/' + t
240
t = '%i' % (total_cnt)
241
c = '%*i' % (len(t), current_cnt)
242
count_str = ' ' + c + '/' + t
455
244
if self.show_bar:
456
245
# progress bar, if present, soaks up all remaining space
457
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
246
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
458
247
- len(eta_str) - len(count_str) - 3
461
250
# number of markers highlighted in bar
462
markers = int(round(float(cols) *
463
(self.last_cnt + self.child_fraction) / self.last_total))
251
markers = int(round(float(cols) * current_cnt / total_cnt))
464
252
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
466
254
# don't know total, so can't show completion.
467
255
# so just show an expanded spinning thingy
468
256
m = self.spin_pos % cols
469
257
ms = (' ' * m + '*').ljust(cols)
471
259
bar_str = '[' + ms + '] '
477
m = spin_str + bar_str + self.last_msg + count_str \
479
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
480
self._have_output = True
481
#self.to_file.flush()
484
if self._have_output:
485
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
486
self._have_output = False
487
#self.to_file.flush()
492
class ChildProgress(_BaseProgressBar):
493
"""A progress indicator that pushes its data to the parent"""
495
@deprecated_function(deprecated_in((1, 16, 0)))
496
def __init__(self, _stack, **kwargs):
497
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
498
self.parent = _stack.top()
501
self.child_fraction = 0
504
def update(self, msg, current_cnt=None, total_cnt=None):
505
self.current = current_cnt
506
if total_cnt is not None:
507
self.total = total_cnt
509
self.child_fraction = 0
512
def child_update(self, message, current, total):
513
if current is None or total == 0:
514
self.child_fraction = 0
516
self.child_fraction = float(current) / total
520
if self.current is None:
523
count = self.current+self.child_fraction
524
if count > self.total:
526
mutter('clamping count of %d to %d' % (count, self.total))
528
self.parent.child_update(self.message, count, self.total)
533
def note(self, *args, **kwargs):
534
self.parent.note(*args, **kwargs)
265
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
267
assert len(m) < self.width
268
self.to_file.write('\r' + m.ljust(self.width - 1))
269
#self.to_file.flush()
273
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
274
#self.to_file.flush()
537
278
def str_tdelta(delt):
added
removed
bzrlib/progress.py
