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 (
45
"""Return estimated terminal width.
47
TODO: Do something smart on Windows?
49
TODO: Is there anything that gets a better update when the window
50
is resized while the program is running?
53
return int(os.environ['COLUMNS'])
54
except (IndexError, KeyError, ValueError):
41
58
def _supports_progress(f):
42
"""Detect if we can use pretty progress bars on file F.
44
If this returns true we expect that a human may be looking at that
45
output, and that we can repaint a line to update it.
47
This doesn't check the policy for whether we *should* use them.
49
isatty = getattr(f, 'isatty', None)
54
# The following case also handles Win32 - on that platform $TERM is
55
# typically never set, so the case None is treated as a smart terminal,
56
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
57
# isatty methods that return true.
59
if not hasattr(f, 'isatty'):
58
63
if os.environ.get('TERM') == 'dumb':
59
64
# e.g. emacs compile window
64
class ProgressTask(object):
65
"""Model component of a progress indicator.
67
Most code that needs to indicate progress should update one of these,
68
and it will in turn update the display, if one is present.
70
Code updating the task may also set fields as hints about how to display
71
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
72
will not necessarily respect all these fields.
74
:ivar update_latency: The interval (in seconds) at which the PB should be
75
updated. Setting this to zero suggests every update should be shown
78
:ivar show_transport_activity: If true (default), transport activity
79
will be shown when this task is drawn. Disable it if you're sure
80
that only irrelevant or uninteresting transport activity can occur
84
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
85
"""Construct a new progress task.
87
:param parent_task: Enclosing ProgressTask or None.
89
:param progress_view: ProgressView to display this ProgressTask.
91
:param ui_factory: The UI factory that will display updates;
92
deprecated in favor of passing progress_view directly.
94
Normally you should not call this directly but rather through
95
`ui_factory.nested_progress_bar`.
97
self._parent_task = parent_task
100
self.current_cnt = None
102
# TODO: deprecate passing ui_factory
103
self.ui_factory = ui_factory
104
self.progress_view = progress_view
105
self.show_pct = False
106
self.show_spinner = True
107
self.show_eta = False,
108
self.show_count = True
110
self.update_latency = 0.1
111
self.show_transport_activity = True
114
return '%s(%r/%r, msg=%r)' % (
115
self.__class__.__name__,
120
def update(self, msg, current_cnt=None, total_cnt=None):
122
self.current_cnt = current_cnt
124
self.total_cnt = total_cnt
125
if self.progress_view:
126
self.progress_view.show_progress(self)
128
self.ui_factory._progress_updated(self)
131
self.update(self.msg)
134
if self.progress_view:
135
self.progress_view.task_finished(self)
137
self.ui_factory._progress_finished(self)
139
def make_sub_task(self):
140
return ProgressTask(self, ui_factory=self.ui_factory,
141
progress_view=self.progress_view)
143
def _overall_completion_fraction(self, child_fraction=0.0):
144
"""Return fractional completion of this task and its parents
146
Returns None if no completion can be computed."""
147
if self.current_cnt is not None and self.total_cnt:
148
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
150
# if this task has no estimation, it just passes on directly
151
# whatever the child has measured...
152
own_fraction = child_fraction
153
if self._parent_task is None:
156
if own_fraction is None:
158
return self._parent_task._overall_completion_fraction(own_fraction)
160
@deprecated_method(deprecated_in((2, 1, 0)))
161
def note(self, fmt_string, *args):
162
"""Record a note without disrupting the progress bar.
164
Deprecated: use ui_factory.note() instead or bzrlib.trace. Note that
165
ui_factory.note takes just one string as the argument, not a format
166
string and arguments.
169
self.ui_factory.note(fmt_string % args)
171
self.ui_factory.note(fmt_string)
174
# TODO: deprecate this method; the model object shouldn't be concerned
175
# with whether it's shown or not. Most callers use this because they
176
# want to write some different non-progress output to the screen, but
177
# they should probably instead use a stream that's synchronized with
178
# the progress output. It may be there is a model-level use for
179
# saying "this task's not active at the moment" but I don't see it. --
181
if self.progress_view:
182
self.progress_view.clear()
184
self.ui_factory.clear_term()
187
@deprecated_function(deprecated_in((1, 16, 0)))
188
def ProgressBar(to_file=None, **kwargs):
189
"""Construct a progress bar.
191
Deprecated; ask the ui_factory for a progress task instead.
195
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
196
# An value of '' or not set reverts to standard processing
197
if requested_bar_type in (None, ''):
198
if _supports_progress(to_file):
199
return TTYProgressBar(to_file=to_file, **kwargs)
201
return DummyProgress(to_file=to_file, **kwargs)
70
def ProgressBar(to_file=sys.stderr, **kwargs):
71
"""Abstract factory"""
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
203
# Minor sanitation to prevent spurious errors
204
requested_bar_type = requested_bar_type.lower().strip()
205
# TODO: jam 20060710 Arguably we shouldn't raise an exception
206
# but should instead just disable progress bars if we
207
# don't recognize the type
208
if requested_bar_type not in _progress_bar_types:
209
raise errors.InvalidProgressBarType(requested_bar_type,
210
_progress_bar_types.keys())
211
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
214
# NOTE: This is also deprecated; you should provide a ProgressView instead.
75
return DotsProgressBar(to_file=to_file, **kwargs)
215
78
class _BaseProgressBar(object):
217
79
def __init__(self,
220
82
show_spinner=False,
224
to_messages_file=None,
226
86
object.__init__(self)
229
if to_messages_file is None:
230
to_messages_file = sys.stdout
231
87
self.to_file = to_file
232
self.to_messages_file = to_messages_file
233
89
self.last_msg = None
234
90
self.last_cnt = None
235
91
self.last_total = None
338
157
The output file should be in line-buffered or unbuffered mode.
340
159
SPIN_CHARS = r'/-\|'
342
@deprecated_function(deprecated_in((1, 16, 0)))
160
MIN_PAUSE = 0.1 # seconds
343
163
def __init__(self, **kwargs):
344
from bzrlib.osutils import terminal_width
345
164
_BaseProgressBar.__init__(self, **kwargs)
346
165
self.spin_pos = 0
347
self.width = terminal_width()
348
self.last_updates = []
349
self._max_last_updates = 10
350
self.child_fraction = 0
351
self._have_output = False
166
self.width = _width()
167
self.start_time = None
168
self.last_update = None
353
def throttle(self, old_msg):
354
172
"""Return True if the bar was updated too recently"""
355
# time.time consistently takes 40/4000 ms = 0.01 ms.
356
# time.clock() is faster, but gives us CPU time, not wall-clock time
357
173
now = time.time()
358
if self.start_time is not None and (now - self.start_time) < 1:
360
if old_msg != self.last_msg:
174
if self.start_time is None:
175
self.start_time = self.last_update = now
362
interval = now - self.last_update
364
if interval < self.MIN_PAUSE:
178
interval = now - self.last_update
179
if interval > 0 and interval < self.MIN_PAUSE:
367
self.last_updates.append(now - self.last_update)
368
# Don't let the queue grow without bound
369
self.last_updates = self.last_updates[-self._max_last_updates:]
370
182
self.last_update = now
374
self.update(self.last_msg, self.last_cnt, self.last_total,
377
def child_update(self, message, current, total):
378
if current is not None and total != 0:
379
child_fraction = float(current) / total
380
if self.last_cnt is None:
382
elif self.last_cnt + child_fraction <= self.last_total:
383
self.child_fraction = child_fraction
384
if self.last_msg is None:
388
def update(self, msg, current_cnt=None, total_cnt=None,
390
"""Update and redraw progress bar.
395
if total_cnt is None:
396
total_cnt = self.last_total
187
self.update(self.last_msg, self.last_cnt, self.last_total)
191
def update(self, msg, current_cnt=None, total_cnt=None):
192
"""Update and redraw progress bar."""
398
194
if current_cnt < 0:
401
197
if current_cnt > total_cnt:
402
198
total_cnt = current_cnt
404
## # optional corner case optimisation
405
## # currently does not seem to fire so costs more than saved.
406
## # trivial optimal case:
407
## # NB if callers are doing a clear and restore with
408
## # the saved values, this will prevent that:
409
## # in that case add a restore method that calls
410
## # _do_update or some such
411
## if (self.last_msg == msg and
412
## self.last_cnt == current_cnt and
413
## self.last_total == total_cnt and
414
## self.child_fraction == child_fraction):
420
old_msg = self.last_msg
421
200
# save these for the tick() function
422
201
self.last_msg = msg
423
202
self.last_cnt = current_cnt
424
203
self.last_total = total_cnt
425
self.child_fraction = child_fraction
427
# each function call takes 20ms/4000 = 0.005 ms,
428
# but multiple that by 4000 calls -> starts to cost.
429
# so anything to make this function call faster
430
# will improve base 'diff' time by up to 0.1 seconds.
431
if self.throttle(old_msg):
434
if self.show_eta and self.start_time and self.last_total:
435
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
436
self.last_total, last_updates = self.last_updates)
208
if self.show_eta and self.start_time and total_cnt:
209
eta = get_eta(self.start_time, current_cnt, total_cnt)
437
210
eta_str = " " + str_tdelta(eta)
441
214
if self.show_spinner:
442
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
215
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
446
219
# always update this; it's also used for the bar
447
220
self.spin_pos += 1
449
if self.show_pct and self.last_total and self.last_cnt:
450
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
222
if self.show_pct and total_cnt and current_cnt:
223
pct = 100.0 * current_cnt / total_cnt
451
224
pct_str = ' (%5.1f%%)' % pct
455
228
if not self.show_count:
457
elif self.last_cnt is None:
230
elif current_cnt is None:
459
elif self.last_total is None:
460
count_str = ' %i' % (self.last_cnt)
232
elif total_cnt is None:
233
count_str = ' %i' % (current_cnt)
462
235
# make both fields the same size
463
t = '%i' % (self.last_total)
464
c = '%*i' % (len(t), self.last_cnt)
465
count_str = ' ' + c + '/' + t
236
t = '%i' % (total_cnt)
237
c = '%*i' % (len(t), current_cnt)
238
count_str = ' ' + c + '/' + t
467
240
if self.show_bar:
468
241
# progress bar, if present, soaks up all remaining space
469
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
242
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
470
243
- len(eta_str) - len(count_str) - 3
473
246
# number of markers highlighted in bar
474
markers = int(round(float(cols) *
475
(self.last_cnt + self.child_fraction) / self.last_total))
247
markers = int(round(float(cols) * current_cnt / total_cnt))
476
248
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
478
250
# don't know total, so can't show completion.
479
251
# so just show an expanded spinning thingy
480
252
m = self.spin_pos % cols
481
253
ms = (' ' * m + '*').ljust(cols)
483
255
bar_str = '[' + ms + '] '
489
m = spin_str + bar_str + self.last_msg + count_str \
491
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
492
self._have_output = True
493
#self.to_file.flush()
496
if self._have_output:
497
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
498
self._have_output = False
499
#self.to_file.flush()
504
class ChildProgress(_BaseProgressBar):
505
"""A progress indicator that pushes its data to the parent"""
507
@deprecated_function(deprecated_in((1, 16, 0)))
508
def __init__(self, _stack, **kwargs):
509
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
510
self.parent = _stack.top()
513
self.child_fraction = 0
516
def update(self, msg, current_cnt=None, total_cnt=None):
517
self.current = current_cnt
518
if total_cnt is not None:
519
self.total = total_cnt
521
self.child_fraction = 0
524
def child_update(self, message, current, total):
525
if current is None or total == 0:
526
self.child_fraction = 0
528
self.child_fraction = float(current) / total
532
if self.current is None:
535
count = self.current+self.child_fraction
536
if count > self.total:
538
mutter('clamping count of %d to %d' % (count, self.total))
540
self.parent.child_update(self.message, count, self.total)
545
def note(self, *args, **kwargs):
546
self.parent.note(*args, **kwargs)
261
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
263
assert len(m) < self.width
264
self.to_file.write('\r' + m.ljust(self.width - 1))
265
#self.to_file.flush()
269
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
270
#self.to_file.flush()
549
274
def str_tdelta(delt):
added
removed
bzrlib/progress.py
