1
# Copyright (C) 2005-2010 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
17
"""Progress indicators.
19
The usual way to use this is via breezy.ui.ui_factory.nested_progress_bar which
20
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.
23
from __future__ import absolute_import
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
29
45
def _supports_progress(f):
30
"""Detect if we can use pretty progress bars on file F.
32
If this returns true we expect that a human may be looking at that
33
output, and that we can repaint a line to update it.
35
This doesn't check the policy for whether we *should* use them.
37
isatty = getattr(f, 'isatty', None)
42
# The following case also handles Win32 - on that platform $TERM is
43
# typically never set, so the case None is treated as a smart terminal,
44
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
45
# isatty methods that return true.
46
if not hasattr(f, 'isatty'):
46
50
if os.environ.get('TERM') == 'dumb':
47
51
# e.g. emacs compile window
52
class ProgressTask(object):
53
"""Model component of a progress indicator.
55
Most code that needs to indicate progress should update one of these,
56
and it will in turn update the display, if one is present.
58
Code updating the task may also set fields as hints about how to display
59
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
60
will not necessarily respect all these fields.
62
The message given when updating a task must be unicode, not bytes.
64
:ivar update_latency: The interval (in seconds) at which the PB should be
65
updated. Setting this to zero suggests every update should be shown
68
:ivar show_transport_activity: If true (default), transport activity
69
will be shown when this task is drawn. Disable it if you're sure
70
that only irrelevant or uninteresting transport activity can occur
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
100
self.update_latency = 0.1
101
self.show_transport_activity = True
104
return '%s(%r/%r, msg=%r)' % (
105
self.__class__.__name__,
110
def update(self, msg, current_cnt=None, total_cnt=None):
111
"""Report updated task message and if relevent progress counters
113
The message given must be unicode, not a byte string.
116
self.current_cnt = current_cnt
118
self.total_cnt = total_cnt
119
if self.progress_view:
120
self.progress_view.show_progress(self)
122
self.ui_factory._progress_updated(self)
125
self.update(self.msg)
128
if self.progress_view:
129
self.progress_view.task_finished(self)
131
self.ui_factory._progress_finished(self)
133
def make_sub_task(self):
134
return ProgressTask(self, ui_factory=self.ui_factory,
135
progress_view=self.progress_view)
137
def _overall_completion_fraction(self, child_fraction=0.0):
138
"""Return fractional completion of this task and its parents
140
Returns None if no completion can be computed."""
141
if self.current_cnt is not None and self.total_cnt:
142
own_fraction = (float(self.current_cnt) +
143
child_fraction) / self.total_cnt
145
# if this task has no estimation, it just passes on directly
146
# whatever the child has measured...
147
own_fraction = child_fraction
148
if self._parent_task is None:
151
if own_fraction is None:
153
return self._parent_task._overall_completion_fraction(own_fraction)
156
# TODO: deprecate this method; the model object shouldn't be concerned
157
# with whether it's shown or not. Most callers use this because they
158
# want to write some different non-progress output to the screen, but
159
# they should probably instead use a stream that's synchronized with
160
# the progress output. It may be there is a model-level use for
161
# saying "this task's not active at the moment" but I don't see it. --
163
if self.progress_view:
164
self.progress_view.clear()
166
self.ui_factory.clear_term()
171
def __exit__(self, exc_type, exc_val, exc_tb):
176
class DummyProgress(object):
57
def ProgressBar(to_file=sys.stderr, **kwargs):
58
"""Abstract factory"""
59
if _supports_progress(to_file):
60
return TTYProgressBar(to_file=to_file, **kwargs)
62
return DotsProgressBar(to_file=to_file, **kwargs)
65
class _BaseProgressBar(object):
73
to_messages_file=sys.stdout):
75
self.to_file = to_file
76
self.to_messages_file = to_messages_file
79
self.last_total = None
80
self.show_pct = show_pct
81
self.show_spinner = show_spinner
82
self.show_eta = show_eta
83
self.show_bar = show_bar
84
self.show_count = show_count
86
def note(self, fmt_string, *args, **kwargs):
87
"""Record a note without disrupting the progress bar."""
89
self.to_messages_file.write(fmt_string % args)
90
self.to_messages_file.write('\n')
93
class DummyProgress(_BaseProgressBar):
177
94
"""Progress-bar standin that does nothing.
179
This was previously often constructed by application code if no progress
180
bar was explicitly passed in. That's no longer recommended: instead, just
181
create a progress task from the ui_factory. This class can be used in
182
test code that needs to fake a progress task for some reason.
96
This can be used as the default argument for methods that
97
take an optional progress indicator."""
188
101
def update(self, msg=None, current=None, total=None):
191
def child_update(self, message, current, total):
197
def child_progress(self, **kwargs):
198
return DummyProgress(**kwargs)
107
def note(self, fmt_string, *args, **kwargs):
108
"""See _BaseProgressBar.note()."""
111
class DotsProgressBar(_BaseProgressBar):
112
def __init__(self, **kwargs):
113
_BaseProgressBar.__init__(self, **kwargs)
120
def update(self, msg=None, current_cnt=None, total_cnt=None):
121
if msg and msg != self.last_msg:
123
self.to_file.write('\n')
125
self.to_file.write(msg + ': ')
128
self.to_file.write('.')
132
self.to_file.write('\n')
135
class TTYProgressBar(_BaseProgressBar):
136
"""Progress bar display object.
138
Several options are available to control the display. These can
139
be passed as parameters to the constructor or assigned at any time:
142
Show percentage complete.
144
Show rotating baton. This ticks over on every update even
145
if the values don't change.
147
Show predicted time-to-completion.
151
Show numerical counts.
153
The output file should be in line-buffered or unbuffered mode.
156
MIN_PAUSE = 0.1 # seconds
159
def __init__(self, **kwargs):
160
from bzrlib.osutils import terminal_width
161
_BaseProgressBar.__init__(self, **kwargs)
163
self.width = terminal_width()
164
self.start_time = None
165
self.last_update = None
166
self.last_updates = deque()
170
"""Return True if the bar was updated too recently"""
172
if self.start_time is None:
173
self.start_time = self.last_update = now
176
interval = now - self.last_update
177
if interval > 0 and interval < self.MIN_PAUSE:
180
self.last_updates.append(now - self.last_update)
181
self.last_update = now
186
self.update(self.last_msg, self.last_cnt, self.last_total)
190
def update(self, msg, current_cnt=None, total_cnt=None):
191
"""Update and redraw progress bar."""
196
if current_cnt > total_cnt:
197
total_cnt = current_cnt
199
old_msg = self.last_msg
200
# save these for the tick() function
202
self.last_cnt = current_cnt
203
self.last_total = total_cnt
205
if old_msg == self.last_msg and self.throttle():
208
if self.show_eta and self.start_time and total_cnt:
209
eta = get_eta(self.start_time, current_cnt, total_cnt,
210
last_updates = self.last_updates)
211
eta_str = " " + str_tdelta(eta)
215
if self.show_spinner:
216
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
220
# always update this; it's also used for the bar
223
if self.show_pct and total_cnt and current_cnt:
224
pct = 100.0 * current_cnt / total_cnt
225
pct_str = ' (%5.1f%%)' % pct
229
if not self.show_count:
231
elif current_cnt is None:
233
elif total_cnt is None:
234
count_str = ' %i' % (current_cnt)
236
# make both fields the same size
237
t = '%i' % (total_cnt)
238
c = '%*i' % (len(t), current_cnt)
239
count_str = ' ' + c + '/' + t
242
# progress bar, if present, soaks up all remaining space
243
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
244
- len(eta_str) - len(count_str) - 3
247
# number of markers highlighted in bar
248
markers = int(round(float(cols) * current_cnt / total_cnt))
249
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
251
# don't know total, so can't show completion.
252
# so just show an expanded spinning thingy
253
m = self.spin_pos % cols
254
ms = (' ' * m + '*').ljust(cols)
256
bar_str = '[' + ms + '] '
262
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
264
assert len(m) < self.width
265
self.to_file.write('\r' + m.ljust(self.width - 1))
266
#self.to_file.flush()
269
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
270
#self.to_file.flush()
201
273
def str_tdelta(delt):
204
276
delt = int(round(delt))
205
return '%d:%02d:%02d' % (delt / 3600,
277
return '%d:%02d:%02d' % (delt/3600,
210
def get_eta(start_time, current, total, enough_samples=3, last_updates=None,
282
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
212
283
if start_time is None:
added
removed
bzrlib/progress.py
