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.
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
27
45
def _supports_progress(f):
28
"""Detect if we can use pretty progress bars on file F.
30
If this returns true we expect that a human may be looking at that
31
output, and that we can repaint a line to update it.
33
This doesn't check the policy for whether we *should* use them.
35
isatty = getattr(f, 'isatty', None)
40
# The following case also handles Win32 - on that platform $TERM is
41
# typically never set, so the case None is treated as a smart terminal,
42
# not dumb. <https://bugs.launchpad.net/bugs/334808> win32 files do have
43
# isatty methods that return true.
46
if not hasattr(f, 'isatty'):
44
50
if os.environ.get('TERM') == 'dumb':
45
51
# e.g. emacs compile window
50
class ProgressTask(object):
51
"""Model component of a progress indicator.
53
Most code that needs to indicate progress should update one of these,
54
and it will in turn update the display, if one is present.
56
Code updating the task may also set fields as hints about how to display
57
it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs
58
will not necessarily respect all these fields.
60
The message given when updating a task must be unicode, not bytes.
62
:ivar update_latency: The interval (in seconds) at which the PB should be
63
updated. Setting this to zero suggests every update should be shown
66
:ivar show_transport_activity: If true (default), transport activity
67
will be shown when this task is drawn. Disable it if you're sure
68
that only irrelevant or uninteresting transport activity can occur
72
def __init__(self, parent_task=None, ui_factory=None, progress_view=None):
73
"""Construct a new progress task.
75
:param parent_task: Enclosing ProgressTask or None.
77
:param progress_view: ProgressView to display this ProgressTask.
79
:param ui_factory: The UI factory that will display updates;
80
deprecated in favor of passing progress_view directly.
82
Normally you should not call this directly but rather through
83
`ui_factory.nested_progress_bar`.
85
self._parent_task = parent_task
88
self.current_cnt = None
90
# TODO: deprecate passing ui_factory
91
self.ui_factory = ui_factory
92
self.progress_view = progress_view
94
self.show_spinner = True
95
self.show_eta = False,
96
self.show_count = True
98
self.update_latency = 0.1
99
self.show_transport_activity = True
102
return '%s(%r/%r, msg=%r)' % (
103
self.__class__.__name__,
108
def update(self, msg, current_cnt=None, total_cnt=None):
109
"""Report updated task message and if relevent progress counters
111
The message given must be unicode, not a byte string.
114
self.current_cnt = current_cnt
116
self.total_cnt = total_cnt
117
if self.progress_view:
118
self.progress_view.show_progress(self)
120
self.ui_factory._progress_updated(self)
123
self.update(self.msg)
126
if self.progress_view:
127
self.progress_view.task_finished(self)
129
self.ui_factory._progress_finished(self)
131
def make_sub_task(self):
132
return ProgressTask(self, ui_factory=self.ui_factory,
133
progress_view=self.progress_view)
135
def _overall_completion_fraction(self, child_fraction=0.0):
136
"""Return fractional completion of this task and its parents
138
Returns None if no completion can be computed."""
139
if self.current_cnt is not None and self.total_cnt:
140
own_fraction = (float(self.current_cnt) +
141
child_fraction) / self.total_cnt
143
# if this task has no estimation, it just passes on directly
144
# whatever the child has measured...
145
own_fraction = child_fraction
146
if self._parent_task is None:
149
if own_fraction is None:
151
return self._parent_task._overall_completion_fraction(own_fraction)
154
# TODO: deprecate this method; the model object shouldn't be concerned
155
# with whether it's shown or not. Most callers use this because they
156
# want to write some different non-progress output to the screen, but
157
# they should probably instead use a stream that's synchronized with
158
# the progress output. It may be there is a model-level use for
159
# saying "this task's not active at the moment" but I don't see it. --
161
if self.progress_view:
162
self.progress_view.clear()
164
self.ui_factory.clear_term()
169
def __exit__(self, exc_type, exc_val, exc_tb):
174
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):
74
self.to_file = to_file
78
self.last_total = None
79
self.show_pct = show_pct
80
self.show_spinner = show_spinner
81
self.show_eta = show_eta
82
self.show_bar = show_bar
83
self.show_count = show_count
87
class DummyProgress(_BaseProgressBar):
175
88
"""Progress-bar standin that does nothing.
177
This was previously often constructed by application code if no progress
178
bar was explicitly passed in. That's no longer recommended: instead, just
179
create a progress task from the ui_factory. This class can be used in
180
test code that needs to fake a progress task for some reason.
90
This can be used as the default argument for methods that
91
take an optional progress indicator."""
186
95
def update(self, msg=None, current=None, total=None):
189
def child_update(self, message, current, total):
195
def child_progress(self, **kwargs):
196
return DummyProgress(**kwargs)
102
class DotsProgressBar(_BaseProgressBar):
103
def __init__(self, **kwargs):
104
_BaseProgressBar.__init__(self, **kwargs)
111
def update(self, msg=None, current_cnt=None, total_cnt=None):
112
if msg and msg != self.last_msg:
114
self.to_file.write('\n')
116
self.to_file.write(msg + ': ')
119
self.to_file.write('.')
123
self.to_file.write('\n')
126
class TTYProgressBar(_BaseProgressBar):
127
"""Progress bar display object.
129
Several options are available to control the display. These can
130
be passed as parameters to the constructor or assigned at any time:
133
Show percentage complete.
135
Show rotating baton. This ticks over on every update even
136
if the values don't change.
138
Show predicted time-to-completion.
142
Show numerical counts.
144
The output file should be in line-buffered or unbuffered mode.
147
MIN_PAUSE = 0.1 # seconds
150
def __init__(self, **kwargs):
151
from bzrlib.osutils import terminal_width
152
_BaseProgressBar.__init__(self, **kwargs)
154
self.width = terminal_width()
155
self.start_time = None
156
self.last_update = None
157
self.last_updates = deque()
161
"""Return True if the bar was updated too recently"""
163
if self.start_time is None:
164
self.start_time = self.last_update = now
167
interval = now - self.last_update
168
if interval > 0 and interval < self.MIN_PAUSE:
171
self.last_updates.append(now - self.last_update)
172
self.last_update = now
177
self.update(self.last_msg, self.last_cnt, self.last_total)
181
def update(self, msg, current_cnt=None, total_cnt=None):
182
"""Update and redraw progress bar."""
187
if current_cnt > total_cnt:
188
total_cnt = current_cnt
190
# save these for the tick() function
192
self.last_cnt = current_cnt
193
self.last_total = total_cnt
198
if self.show_eta and self.start_time and total_cnt:
199
eta = get_eta(self.start_time, current_cnt, total_cnt,
200
last_updates = self.last_updates)
201
eta_str = " " + str_tdelta(eta)
205
if self.show_spinner:
206
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
210
# always update this; it's also used for the bar
213
if self.show_pct and total_cnt and current_cnt:
214
pct = 100.0 * current_cnt / total_cnt
215
pct_str = ' (%5.1f%%)' % pct
219
if not self.show_count:
221
elif current_cnt is None:
223
elif total_cnt is None:
224
count_str = ' %i' % (current_cnt)
226
# make both fields the same size
227
t = '%i' % (total_cnt)
228
c = '%*i' % (len(t), current_cnt)
229
count_str = ' ' + c + '/' + t
232
# progress bar, if present, soaks up all remaining space
233
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
234
- len(eta_str) - len(count_str) - 3
237
# number of markers highlighted in bar
238
markers = int(round(float(cols) * current_cnt / total_cnt))
239
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
241
# don't know total, so can't show completion.
242
# so just show an expanded spinning thingy
243
m = self.spin_pos % cols
244
ms = (' ' * m + '*').ljust(cols)
246
bar_str = '[' + ms + '] '
252
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
254
assert len(m) < self.width
255
self.to_file.write('\r' + m.ljust(self.width - 1))
256
#self.to_file.flush()
260
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
261
#self.to_file.flush()
199
265
def str_tdelta(delt):
202
268
delt = int(round(delt))
203
return '%d:%02d:%02d' % (delt / 3600,
269
return '%d:%02d:%02d' % (delt/3600,
208
def get_eta(start_time, current, total, enough_samples=3, last_updates=None,
274
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
210
275
if start_time is None:
added
removed
bzrlib/progress.py
