1
# Copyright (C) 2005, 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
19
"""Text UI, write output to the console.
27
from bzrlib.lazy_import import lazy_import
28
lazy_import(globals(), """
37
from bzrlib.ui import CLIUIFactory
40
class TextUIFactory(CLIUIFactory):
41
"""A UI factory for Text user interefaces."""
48
"""Create a TextUIFactory.
50
:param bar_type: The type of progress bar to create. It defaults to
51
letting the bzrlib.progress.ProgressBar factory auto
54
super(TextUIFactory, self).__init__(stdin=stdin,
55
stdout=stdout, stderr=stderr)
57
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 11, 0))
58
% "bar_type parameter")
59
# paints progress, network activity, etc
60
self._progress_view = self._make_progress_view()
63
"""Prepare the terminal for output.
65
This will, clear any progress bars, and leave the cursor at the
67
# XXX: If this is preparing to write to stdout, but that's for example
68
# directed into a file rather than to the terminal, and the progress
69
# bar _is_ going to the terminal, we shouldn't need
70
# to clear it. We might need to separately check for the case of
71
self._progress_view.clear()
73
def _make_progress_view(self):
74
if os.environ.get('BZR_PROGRESS_BAR') in ('text', None, ''):
75
return TextProgressView(self.stderr)
77
return NullProgressView()
80
"""Write an already-formatted message, clearing the progress bar if necessary."""
82
self.stdout.write(msg + '\n')
84
def report_transport_activity(self, transport, byte_count, direction):
85
"""Called by transports as they do IO.
87
This may update a progress bar, spinner, or similar display.
88
By default it does nothing.
90
self._progress_view.show_transport_activity(transport,
91
direction, byte_count)
93
def _progress_updated(self, task):
94
"""A task has been updated and wants to be displayed.
96
if not self._task_stack:
97
warnings.warn("%r updated but no tasks are active" %
99
elif task != self._task_stack[-1]:
100
warnings.warn("%r is not the top progress task %r" %
101
(task, self._task_stack[-1]))
102
self._progress_view.show_progress(task)
104
def _progress_all_finished(self):
105
self._progress_view.clear()
108
class NullProgressView(object):
109
"""Soak up and ignore progress information."""
114
def show_progress(self, task):
117
def show_transport_activity(self, transport, direction, byte_count):
121
class TextProgressView(object):
122
"""Display of progress bar and other information on a tty.
124
This shows one line of text, including possibly a network indicator, spinner,
125
progress bar, message, etc.
127
One instance of this is created and held by the UI, and fed updates when a
128
task wants to be painted.
130
Transports feed data to this through the ui_factory object.
132
The Progress views can comprise a tree with _parent_task pointers, but
133
this only prints the stack from the nominated current task up to the root.
136
def __init__(self, term_file):
137
self._term_file = term_file
138
# true when there's output on the screen we may need to clear
139
self._have_output = False
140
# XXX: We could listen for SIGWINCH and update the terminal width...
141
# https://launchpad.net/bugs/316357
142
self._width = osutils.terminal_width()
143
self._last_transport_msg = ''
145
# time we last repainted the screen
146
self._last_repaint = 0
147
# time we last got information about transport activity
148
self._transport_update_time = 0
149
self._last_task = None
150
self._total_byte_count = 0
151
self._bytes_since_update = 0
153
def _show_line(self, s):
155
self._term_file.write('\r%-*.*s\r' % (n, n, s))
158
if self._have_output:
160
self._have_output = False
162
def _render_bar(self):
163
# return a string for the progress bar itself
164
if (self._last_task is None) or self._last_task.show_bar:
165
# If there's no task object, we show space for the bar anyhow.
166
# That's because most invocations of bzr will end showing progress
167
# at some point, though perhaps only after doing some initial IO.
168
# It looks better to draw the progress bar initially rather than
169
# to have what looks like an incomplete progress bar.
170
spin_str = r'/-\|'[self._spin_pos % 4]
173
if self._last_task is None:
174
completion_fraction = 0
176
completion_fraction = \
177
self._last_task._overall_completion_fraction() or 0
178
markers = int(round(float(cols) * completion_fraction)) - 1
179
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
181
elif self._last_task.show_spinner:
182
# The last task wanted just a spinner, no bar
183
spin_str = r'/-\|'[self._spin_pos % 4]
185
return spin_str + ' '
189
def _format_task(self, task):
190
if not task.show_count:
192
elif task.current_cnt is not None and task.total_cnt is not None:
193
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
194
elif task.current_cnt is not None:
195
s = ' %d' % (task.current_cnt)
198
# compose all the parent messages
201
while t._parent_task:
207
def _render_line(self):
208
bar_string = self._render_bar()
210
task_msg = self._format_task(self._last_task)
213
trans = self._last_transport_msg
216
return (bar_string + trans + task_msg)
219
s = self._render_line()
221
self._have_output = True
223
def show_progress(self, task):
224
"""Called by the task object when it has changed.
226
:param task: The top task object; its parents are also included
229
must_update = task is not self._last_task
230
self._last_task = task
232
if (not must_update) and (now < self._last_repaint + 0.1):
234
if now > self._transport_update_time + 10:
235
# no recent activity; expire it
236
self._last_transport_msg = ''
237
self._last_repaint = now
240
def show_transport_activity(self, transport, direction, byte_count):
241
"""Called by transports via the ui_factory, as they do IO.
243
This may update a progress bar, spinner, or similar display.
244
By default it does nothing.
246
# XXX: Probably there should be a transport activity model, and that
247
# too should be seen by the progress view, rather than being poked in
249
if not self._have_output:
250
# As a workaround for <https://launchpad.net/bugs/321935> we only
251
# show transport activity when there's already a progress bar
252
# shown, which time the application code is expected to know to
253
# clear off the progress bar when it's going to send some other
254
# output. Eventually it would be nice to have that automatically
257
self._total_byte_count += byte_count
258
self._bytes_since_update += byte_count
260
if self._transport_update_time is None:
261
self._transport_update_time = now
262
elif now >= (self._transport_update_time + 0.5):
263
# guard against clock stepping backwards, and don't update too
265
rate = self._bytes_since_update / (now - self._transport_update_time)
266
msg = ("%6dKB %5dKB/s" %
267
(self._total_byte_count>>10, int(rate)>>10,))
268
self._transport_update_time = now
269
self._last_repaint = now
270
self._bytes_since_update = 0
271
self._last_transport_msg = msg
added
removed
bzrlib/ui/text.py
