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
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):
33
from bzrlib.trace import mutter
34
from bzrlib.symbol_versioning import (
58
40
def _supports_progress(f):
59
if not hasattr(f, 'isatty'):
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.
63
57
if os.environ.get('TERM') == 'dumb':
64
58
# e.g. emacs compile window
70
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, progress_view=None):
75
"""Construct a new progress task.
77
:param parent_task: Enclosing ProgressTask or None.
79
:param progress_view: ProgressView to display this ProgressTask.
81
:param ui_factory: The UI factory that will display updates;
82
deprecated in favor of passing progress_view directly.
84
Normally you should not call this directly but rather through
85
`ui_factory.nested_progress_bar`.
87
self._parent_task = parent_task
90
self.current_cnt = None
92
# TODO: deprecate passing ui_factory
93
self.ui_factory = ui_factory
94
self.progress_view = progress_view
96
self.show_spinner = True
97
self.show_eta = False,
98
self.show_count = True
102
return '%s(%r/%r, msg=%r)' % (
103
self.__class__.__name__,
108
def update(self, msg, current_cnt=None, total_cnt=None):
110
self.current_cnt = current_cnt
112
self.total_cnt = total_cnt
113
if self.progress_view:
114
self.progress_view.show_progress(self)
116
self.ui_factory._progress_updated(self)
119
self.update(self.msg)
122
if self.progress_view:
123
self.progress_view.task_finished(self)
125
self.ui_factory._progress_finished(self)
127
def make_sub_task(self):
128
return ProgressTask(self, ui_factory=self.ui_factory,
129
progress_view=self.progress_view)
131
def _overall_completion_fraction(self, child_fraction=0.0):
132
"""Return fractional completion of this task and its parents
134
Returns None if no completion can be computed."""
135
if self.current_cnt is not None and self.total_cnt:
136
own_fraction = (float(self.current_cnt) + child_fraction) / self.total_cnt
138
# if this task has no estimation, it just passes on directly
139
# whatever the child has measured...
140
own_fraction = child_fraction
141
if self._parent_task is None:
144
if own_fraction is None:
146
return self._parent_task._overall_completion_fraction(own_fraction)
148
def note(self, fmt_string, *args):
149
"""Record a note without disrupting the progress bar."""
150
# XXX: shouldn't be here; put it in mutter or the ui instead
152
self.ui_factory.note(fmt_string % args)
154
self.ui_factory.note(fmt_string)
157
# XXX: shouldn't be here; put it in mutter or the ui instead
158
if self.progress_view:
159
self.progress_view.clear()
161
self.ui_factory.clear_term()
164
@deprecated_function(deprecated_in((1, 16, 0)))
165
def ProgressBar(to_file=None, **kwargs):
71
166
"""Abstract factory"""
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
169
requested_bar_type = os.environ.get('BZR_PROGRESS_BAR')
170
# An value of '' or not set reverts to standard processing
171
if requested_bar_type in (None, ''):
172
if _supports_progress(to_file):
173
return TTYProgressBar(to_file=to_file, **kwargs)
175
return DummyProgress(to_file=to_file, **kwargs)
75
return DotsProgressBar(to_file=to_file, **kwargs)
177
# Minor sanitation to prevent spurious errors
178
requested_bar_type = requested_bar_type.lower().strip()
179
# TODO: jam 20060710 Arguably we shouldn't raise an exception
180
# but should instead just disable progress bars if we
181
# don't recognize the type
182
if requested_bar_type not in _progress_bar_types:
183
raise errors.InvalidProgressBarType(requested_bar_type,
184
_progress_bar_types.keys())
185
return _progress_bar_types[requested_bar_type](to_file=to_file, **kwargs)
188
# NOTE: This is also deprecated; you should provide a ProgressView instead.
78
189
class _BaseProgressBar(object):
79
191
def __init__(self,
82
194
show_spinner=False,
198
to_messages_file=None,
86
200
object.__init__(self)
203
if to_messages_file is None:
204
to_messages_file = sys.stdout
87
205
self.to_file = to_file
206
self.to_messages_file = to_messages_file
89
207
self.last_msg = None
90
208
self.last_cnt = None
91
209
self.last_total = None
94
212
self.show_eta = show_eta
95
213
self.show_bar = show_bar
96
214
self.show_count = show_count
217
self.MIN_PAUSE = 0.1 # seconds
220
self.start_time = now
221
# next update should not throttle
222
self.last_update = now - self.MIN_PAUSE - 1
225
"""Return this bar to its progress stack."""
227
self._stack.return_pb(self)
229
def note(self, fmt_string, *args, **kwargs):
230
"""Record a note without disrupting the progress bar."""
232
self.to_messages_file.write(fmt_string % args)
233
self.to_messages_file.write('\n')
235
@deprecated_function(deprecated_in((1, 16, 0)))
236
def child_progress(self, **kwargs):
237
return ChildProgress(**kwargs)
240
class DummyProgress(_BaseProgressBar):
241
"""Progress-bar standin that does nothing.
243
This can be used as the default argument for methods that
244
take an optional progress indicator."""
249
def update(self, msg=None, current=None, total=None):
252
def child_update(self, message, current, total):
258
def note(self, fmt_string, *args, **kwargs):
259
"""See _BaseProgressBar.note()."""
261
def child_progress(self, **kwargs):
262
return DummyProgress(**kwargs)
100
265
class DotsProgressBar(_BaseProgressBar):
267
@deprecated_function(deprecated_in((1, 16, 0)))
101
268
def __init__(self, **kwargs):
102
269
_BaseProgressBar.__init__(self, **kwargs)
103
270
self.last_msg = None
104
271
self.need_nl = False
109
276
def update(self, msg=None, current_cnt=None, total_cnt=None):
110
277
if msg and msg != self.last_msg:
112
279
self.to_file.write('\n')
114
280
self.to_file.write(msg + ': ')
115
281
self.last_msg = msg
116
282
self.need_nl = True
117
283
self.to_file.write('.')
121
287
self.to_file.write('\n')
290
def child_update(self, message, current, total):
124
294
class TTYProgressBar(_BaseProgressBar):
125
295
"""Progress bar display object.
142
312
The output file should be in line-buffered or unbuffered mode.
144
314
SPIN_CHARS = r'/-\|'
145
MIN_PAUSE = 0.1 # seconds
316
@deprecated_function(deprecated_in((1, 16, 0)))
148
317
def __init__(self, **kwargs):
318
from bzrlib.osutils import terminal_width
149
319
_BaseProgressBar.__init__(self, **kwargs)
150
320
self.spin_pos = 0
151
self.width = _width()
152
self.start_time = None
153
self.last_update = None
321
self.width = terminal_width()
322
self.last_updates = []
323
self._max_last_updates = 10
324
self.child_fraction = 0
325
self._have_output = False
327
def throttle(self, old_msg):
157
328
"""Return True if the bar was updated too recently"""
329
# time.time consistently takes 40/4000 ms = 0.01 ms.
330
# time.clock() is faster, but gives us CPU time, not wall-clock time
158
331
now = time.time()
159
if self.start_time is None:
160
self.start_time = self.last_update = now
332
if self.start_time is not None and (now - self.start_time) < 1:
334
if old_msg != self.last_msg:
163
interval = now - self.last_update
164
if interval > 0 and interval < self.MIN_PAUSE:
336
interval = now - self.last_update
338
if interval < self.MIN_PAUSE:
341
self.last_updates.append(now - self.last_update)
342
# Don't let the queue grow without bound
343
self.last_updates = self.last_updates[-self._max_last_updates:]
167
344
self.last_update = now
172
self.update(self.last_msg, self.last_cnt, self.last_total)
176
def update(self, msg, current_cnt=None, total_cnt=None):
177
"""Update and redraw progress bar."""
348
self.update(self.last_msg, self.last_cnt, self.last_total,
351
def child_update(self, message, current, total):
352
if current is not None and total != 0:
353
child_fraction = float(current) / total
354
if self.last_cnt is None:
356
elif self.last_cnt + child_fraction <= self.last_total:
357
self.child_fraction = child_fraction
358
if self.last_msg is None:
362
def update(self, msg, current_cnt=None, total_cnt=None,
364
"""Update and redraw progress bar.
369
if total_cnt is None:
370
total_cnt = self.last_total
375
if current_cnt > total_cnt:
376
total_cnt = current_cnt
378
## # optional corner case optimisation
379
## # currently does not seem to fire so costs more than saved.
380
## # trivial optimal case:
381
## # NB if callers are doing a clear and restore with
382
## # the saved values, this will prevent that:
383
## # in that case add a restore method that calls
384
## # _do_update or some such
385
## if (self.last_msg == msg and
386
## self.last_cnt == current_cnt and
387
## self.last_total == total_cnt and
388
## self.child_fraction == child_fraction):
394
old_msg = self.last_msg
179
395
# save these for the tick() function
180
396
self.last_msg = msg
181
397
self.last_cnt = current_cnt
182
398
self.last_total = total_cnt
188
assert current_cnt <= total_cnt
190
assert current_cnt >= 0
192
if self.show_eta and self.start_time and total_cnt:
193
eta = get_eta(self.start_time, current_cnt, total_cnt)
399
self.child_fraction = child_fraction
401
# each function call takes 20ms/4000 = 0.005 ms,
402
# but multiple that by 4000 calls -> starts to cost.
403
# so anything to make this function call faster
404
# will improve base 'diff' time by up to 0.1 seconds.
405
if self.throttle(old_msg):
408
if self.show_eta and self.start_time and self.last_total:
409
eta = get_eta(self.start_time, self.last_cnt + self.child_fraction,
410
self.last_total, last_updates = self.last_updates)
194
411
eta_str = " " + str_tdelta(eta)
198
415
if self.show_spinner:
199
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
416
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
203
420
# always update this; it's also used for the bar
204
421
self.spin_pos += 1
206
if self.show_pct and total_cnt and current_cnt:
207
pct = 100.0 * current_cnt / total_cnt
423
if self.show_pct and self.last_total and self.last_cnt:
424
pct = 100.0 * ((self.last_cnt + self.child_fraction) / self.last_total)
208
425
pct_str = ' (%5.1f%%)' % pct
212
429
if not self.show_count:
214
elif current_cnt is None:
431
elif self.last_cnt is None:
216
elif total_cnt is None:
217
count_str = ' %i' % (current_cnt)
433
elif self.last_total is None:
434
count_str = ' %i' % (self.last_cnt)
219
436
# make both fields the same size
220
t = '%i' % (total_cnt)
221
c = '%*i' % (len(t), current_cnt)
222
count_str = ' ' + c + '/' + t
437
t = '%i' % (self.last_total)
438
c = '%*i' % (len(t), self.last_cnt)
439
count_str = ' ' + c + '/' + t
224
441
if self.show_bar:
225
442
# progress bar, if present, soaks up all remaining space
226
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
443
cols = self.width - 1 - len(self.last_msg) - len(spin_str) - len(pct_str) \
227
444
- len(eta_str) - len(count_str) - 3
230
447
# number of markers highlighted in bar
231
markers = int(round(float(cols) * current_cnt / total_cnt))
448
markers = int(round(float(cols) *
449
(self.last_cnt + self.child_fraction) / self.last_total))
232
450
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
234
452
# don't know total, so can't show completion.
235
453
# so just show an expanded spinning thingy
236
454
m = self.spin_pos % cols
237
455
ms = (' ' * m + '*').ljust(cols)
239
457
bar_str = '[' + ms + '] '
245
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
247
assert len(m) < self.width
248
self.to_file.write('\r' + m.ljust(self.width - 1))
249
#self.to_file.flush()
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
254
#self.to_file.flush()
463
m = spin_str + bar_str + self.last_msg + count_str \
465
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
466
self._have_output = True
467
#self.to_file.flush()
470
if self._have_output:
471
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
472
self._have_output = False
473
#self.to_file.flush()
478
class ChildProgress(_BaseProgressBar):
479
"""A progress indicator that pushes its data to the parent"""
481
@deprecated_function(deprecated_in((1, 16, 0)))
482
def __init__(self, _stack, **kwargs):
483
_BaseProgressBar.__init__(self, _stack=_stack, **kwargs)
484
self.parent = _stack.top()
487
self.child_fraction = 0
490
def update(self, msg, current_cnt=None, total_cnt=None):
491
self.current = current_cnt
492
if total_cnt is not None:
493
self.total = total_cnt
495
self.child_fraction = 0
498
def child_update(self, message, current, total):
499
if current is None or total == 0:
500
self.child_fraction = 0
502
self.child_fraction = float(current) / total
506
if self.current is None:
509
count = self.current+self.child_fraction
510
if count > self.total:
512
mutter('clamping count of %d to %d' % (count, self.total))
514
self.parent.child_update(self.message, count, self.total)
519
def note(self, *args, **kwargs):
520
self.parent.note(*args, **kwargs)
258
523
def str_tdelta(delt):
282
547
if elapsed < 2.0: # not enough time to estimate
285
550
total_duration = float(elapsed) * float(total) / float(current)
287
assert total_duration >= elapsed
552
if last_updates and len(last_updates) >= n_recent:
553
avg = sum(last_updates) / float(len(last_updates))
554
time_left = avg * (total - current)
556
old_time_left = total_duration - elapsed
558
# We could return the average, or some other value here
559
return (time_left + old_time_left) / 2
289
561
return total_duration - elapsed
294
result = doctest.testmod()
297
print "All tests passed"
299
print "No tests to run"
305
print 'dumb-terminal test:'
306
pb = DotsProgressBar()
308
pb.update('Leoparden', i, 99)
314
print 'smart-terminal test:'
315
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
317
pb.update('Elephanten', i, 99)
325
if __name__ == "__main__":
564
class ProgressPhase(object):
565
"""Update progress object with the current phase"""
566
def __init__(self, message, total, pb):
567
object.__init__(self)
569
self.message = message
571
self.cur_phase = None
573
def next_phase(self):
574
if self.cur_phase is None:
578
self.pb.update(self.message, self.cur_phase, self.total)
581
_progress_bar_types = {}
582
_progress_bar_types['dummy'] = DummyProgress
583
_progress_bar_types['none'] = DummyProgress
584
_progress_bar_types['tty'] = TTYProgressBar
585
_progress_bar_types['dots'] = DotsProgressBar
added
removed
bzrlib/progress.py
