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
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):
41
59
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.
60
if not hasattr(f, 'isatty'):
58
64
if os.environ.get('TERM') == 'dumb':
59
65
# 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
# NOTE: This is also deprecated; you should provide a ProgressView instead.
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)
76
return DotsProgressBar(to_file=to_file, **kwargs)
188
79
class _BaseProgressBar(object):
190
80
def __init__(self,
193
83
show_spinner=False,
197
to_messages_file=None,
199
87
object.__init__(self)
202
if to_messages_file is None:
203
to_messages_file = sys.stdout
204
88
self.to_file = to_file
205
self.to_messages_file = to_messages_file
206
90
self.last_msg = None
207
91
self.last_cnt = None
208
92
self.last_total = None
211
95
self.show_eta = show_eta
212
96
self.show_bar = show_bar
213
97
self.show_count = show_count
216
self.MIN_PAUSE = 0.1 # seconds
219
self.start_time = now
220
# next update should not throttle
221
self.last_update = now - self.MIN_PAUSE - 1
224
"""Return this bar to its progress stack."""
226
self._stack.return_pb(self)
228
def note(self, fmt_string, *args, **kwargs):
229
"""Record a note without disrupting the progress bar."""
231
self.to_messages_file.write(fmt_string % args)
232
self.to_messages_file.write('\n')
235
class DummyProgress(object):
101
class DummyProgress(_BaseProgressBar):
236
102
"""Progress-bar standin that does nothing.
238
This was previously often constructed by application code if no progress
239
bar was explicitly passed in. That's no longer recommended: instead, just
240
create a progress task from the ui_factory. This class can be used in
241
test code that needs to fake a progress task for some reason.
104
This can be used as the default argument for methods that
105
take an optional progress indicator."""
247
109
def update(self, msg=None, current=None, total=None):
250
def child_update(self, message, current, total):
256
def note(self, fmt_string, *args, **kwargs):
257
"""See _BaseProgressBar.note()."""
259
def child_progress(self, **kwargs):
260
return DummyProgress(**kwargs)
116
class DotsProgressBar(_BaseProgressBar):
117
def __init__(self, **kwargs):
118
_BaseProgressBar.__init__(self, **kwargs)
125
def update(self, msg=None, current_cnt=None, total_cnt=None):
126
if msg and msg != self.last_msg:
128
self.to_file.write('\n')
130
self.to_file.write(msg + ': ')
133
self.to_file.write('.')
137
self.to_file.write('\n')
140
class TTYProgressBar(_BaseProgressBar):
141
"""Progress bar display object.
143
Several options are available to control the display. These can
144
be passed as parameters to the constructor or assigned at any time:
147
Show percentage complete.
149
Show rotating baton. This ticks over on every update even
150
if the values don't change.
152
Show predicted time-to-completion.
156
Show numerical counts.
158
The output file should be in line-buffered or unbuffered mode.
161
MIN_PAUSE = 0.1 # seconds
164
def __init__(self, **kwargs):
165
_BaseProgressBar.__init__(self, **kwargs)
167
self.width = _width()
168
self.start_time = None
169
self.last_update = None
170
self.last_updates = deque()
174
"""Return True if the bar was updated too recently"""
176
if self.start_time is None:
177
self.start_time = self.last_update = now
180
interval = now - self.last_update
181
if interval > 0 and interval < self.MIN_PAUSE:
184
self.last_updates.append(now - self.last_update)
185
self.last_update = now
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."""
200
if current_cnt > total_cnt:
201
total_cnt = current_cnt
203
# save these for the tick() function
205
self.last_cnt = current_cnt
206
self.last_total = total_cnt
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)
214
eta_str = " " + str_tdelta(eta)
218
if self.show_spinner:
219
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
223
# always update this; it's also used for the bar
226
if self.show_pct and total_cnt and current_cnt:
227
pct = 100.0 * current_cnt / total_cnt
228
pct_str = ' (%5.1f%%)' % pct
232
if not self.show_count:
234
elif current_cnt is None:
236
elif total_cnt is None:
237
count_str = ' %i' % (current_cnt)
239
# make both fields the same size
240
t = '%i' % (total_cnt)
241
c = '%*i' % (len(t), current_cnt)
242
count_str = ' ' + c + '/' + t
245
# progress bar, if present, soaks up all remaining space
246
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
247
- len(eta_str) - len(count_str) - 3
250
# number of markers highlighted in bar
251
markers = int(round(float(cols) * current_cnt / total_cnt))
252
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
254
# don't know total, so can't show completion.
255
# so just show an expanded spinning thingy
256
m = self.spin_pos % cols
257
ms = (' ' * m + '*').ljust(cols)
259
bar_str = '[' + ms + '] '
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()
263
278
def str_tdelta(delt):
added
removed
bzrlib/progress.py
