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
18
"""Text UI, write output to the console.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
40
from bzrlib.ui import (
46
class TextUIFactory(UIFactory):
47
"""A UI factory for Text user interefaces."""
53
"""Create a TextUIFactory.
55
super(TextUIFactory, self).__init__()
56
# TODO: there's no good reason not to pass all three streams, maybe we
57
# should deprecate the default values...
61
# paints progress, network activity, etc
62
self._progress_view = self.make_progress_view()
65
"""Prepare the terminal for output.
67
This will, clear any progress bars, and leave the cursor at the
69
# XXX: If this is preparing to write to stdout, but that's for example
70
# directed into a file rather than to the terminal, and the progress
71
# bar _is_ going to the terminal, we shouldn't need
72
# to clear it. We might need to separately check for the case of
73
self._progress_view.clear()
75
def get_boolean(self, prompt):
77
self.prompt(prompt + "? [y/n]: ")
78
line = self.stdin.readline().lower()
79
if line in ('y\n', 'yes\n'):
81
elif line in ('n\n', 'no\n'):
83
elif line in ('', None):
84
# end-of-file; possibly should raise an error here instead
87
def get_integer(self, prompt):
90
line = self.stdin.readline()
96
def get_non_echoed_password(self):
97
isatty = getattr(self.stdin, 'isatty', None)
98
if isatty is not None and isatty():
99
# getpass() ensure the password is not echoed and other
100
# cross-platform niceties
101
password = getpass.getpass('')
103
# echo doesn't make sense without a terminal
104
password = self.stdin.readline()
107
elif password[-1] == '\n':
108
password = password[:-1]
111
def get_password(self, prompt='', **kwargs):
112
"""Prompt the user for a password.
114
:param prompt: The prompt to present the user
115
:param kwargs: Arguments which will be expanded into the prompt.
116
This lets front ends display different things if
118
:return: The password string, return None if the user
119
canceled the request.
122
self.prompt(prompt, **kwargs)
123
# There's currently no way to say 'i decline to enter a password'
124
# as opposed to 'my password is empty' -- does it matter?
125
return self.get_non_echoed_password()
127
def get_username(self, prompt, **kwargs):
128
"""Prompt the user for a username.
130
:param prompt: The prompt to present the user
131
:param kwargs: Arguments which will be expanded into the prompt.
132
This lets front ends display different things if
134
:return: The username string, return None if the user
135
canceled the request.
138
self.prompt(prompt, **kwargs)
139
username = self.stdin.readline()
142
elif username[-1] == '\n':
143
username = username[:-1]
146
def make_progress_view(self):
147
"""Construct and return a new ProgressView subclass for this UI.
149
# if the user specifically requests either text or no progress bars,
150
# always do that. otherwise, guess based on $TERM and tty presence.
151
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
152
return TextProgressView(self.stderr)
153
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
154
return NullProgressView()
155
elif progress._supports_progress(self.stderr):
156
return TextProgressView(self.stderr)
158
return NullProgressView()
160
def _make_output_stream_explicit(self, encoding, encoding_type):
161
if encoding_type == 'exact':
162
# force sys.stdout to be binary stream on win32;
163
# NB: this leaves the file set in that mode; may cause problems if
164
# one process tries to do binary and then text output
165
if sys.platform == 'win32':
166
fileno = getattr(self.stdout, 'fileno', None)
169
msvcrt.setmode(fileno(), os.O_BINARY)
170
return TextUIOutputStream(self, self.stdout)
172
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
173
errors=encoding_type)
174
# For whatever reason codecs.getwriter() does not advertise its encoding
175
# it just returns the encoding of the wrapped file, which is completely
176
# bogus. So set the attribute, so we can find the correct encoding later.
177
encoded_stdout.encoding = encoding
178
return TextUIOutputStream(self, encoded_stdout)
181
"""Write an already-formatted message, clearing the progress bar if necessary."""
183
self.stdout.write(msg + '\n')
185
def prompt(self, prompt, **kwargs):
186
"""Emit prompt on the CLI.
188
:param kwargs: Dictionary of arguments to insert into the prompt,
189
to allow UIs to reformat the prompt.
192
# See <https://launchpad.net/bugs/365891>
193
prompt = prompt % kwargs
194
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
196
self.stderr.write(prompt)
198
def report_transport_activity(self, transport, byte_count, direction):
199
"""Called by transports as they do IO.
201
This may update a progress bar, spinner, or similar display.
202
By default it does nothing.
204
self._progress_view.show_transport_activity(transport,
205
direction, byte_count)
207
def log_transport_activity(self, display=False):
208
"""See UIFactory.log_transport_activity()"""
209
log = getattr(self._progress_view, 'log_transport_activity', None)
213
def show_error(self, msg):
215
self.stderr.write("bzr: error: %s\n" % msg)
217
def show_message(self, msg):
220
def show_warning(self, msg):
222
self.stderr.write("bzr: warning: %s\n" % msg)
224
def _progress_updated(self, task):
225
"""A task has been updated and wants to be displayed.
227
if not self._task_stack:
228
warnings.warn("%r updated but no tasks are active" %
230
elif task != self._task_stack[-1]:
231
warnings.warn("%r is not the top progress task %r" %
232
(task, self._task_stack[-1]))
233
self._progress_view.show_progress(task)
235
def _progress_all_finished(self):
236
self._progress_view.clear()
239
class TextProgressView(object):
240
"""Display of progress bar and other information on a tty.
242
This shows one line of text, including possibly a network indicator, spinner,
243
progress bar, message, etc.
245
One instance of this is created and held by the UI, and fed updates when a
246
task wants to be painted.
248
Transports feed data to this through the ui_factory object.
250
The Progress views can comprise a tree with _parent_task pointers, but
251
this only prints the stack from the nominated current task up to the root.
254
def __init__(self, term_file):
255
self._term_file = term_file
256
# true when there's output on the screen we may need to clear
257
self._have_output = False
258
self._last_transport_msg = ''
260
# time we last repainted the screen
261
self._last_repaint = 0
262
# time we last got information about transport activity
263
self._transport_update_time = 0
264
self._last_task = None
265
self._total_byte_count = 0
266
self._bytes_since_update = 0
267
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
268
self._first_byte_time = None
270
# force the progress bar to be off, as at the moment it doesn't
271
# correspond reliably to overall command progress
272
self.enable_bar = False
274
def _show_line(self, s):
275
# sys.stderr.write("progress %r\n" % s)
276
width = osutils.terminal_width()
277
if width is not None:
278
# we need one extra space for terminals that wrap on last char
280
s = '%-*.*s' % (width, width, s)
281
self._term_file.write('\r' + s + '\r')
284
if self._have_output:
286
self._have_output = False
288
def _render_bar(self):
289
# return a string for the progress bar itself
290
if self.enable_bar and (
291
(self._last_task is None) or self._last_task.show_bar):
292
# If there's no task object, we show space for the bar anyhow.
293
# That's because most invocations of bzr will end showing progress
294
# at some point, though perhaps only after doing some initial IO.
295
# It looks better to draw the progress bar initially rather than
296
# to have what looks like an incomplete progress bar.
297
spin_str = r'/-\|'[self._spin_pos % 4]
300
if self._last_task is None:
301
completion_fraction = 0
304
completion_fraction = \
305
self._last_task._overall_completion_fraction() or 0
306
if (completion_fraction < self._fraction and 'progress' in
308
import pdb;pdb.set_trace()
309
self._fraction = completion_fraction
310
markers = int(round(float(cols) * completion_fraction)) - 1
311
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
313
elif self._last_task.show_spinner:
314
# The last task wanted just a spinner, no bar
315
spin_str = r'/-\|'[self._spin_pos % 4]
317
return spin_str + ' '
321
def _format_task(self, task):
322
if not task.show_count:
324
elif task.current_cnt is not None and task.total_cnt is not None:
325
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
326
elif task.current_cnt is not None:
327
s = ' %d' % (task.current_cnt)
330
# compose all the parent messages
333
while t._parent_task:
339
def _render_line(self):
340
bar_string = self._render_bar()
342
task_msg = self._format_task(self._last_task)
345
if self._last_task and not self._last_task.show_transport_activity:
348
trans = self._last_transport_msg
351
return (bar_string + trans + task_msg)
354
s = self._render_line()
356
self._have_output = True
358
def show_progress(self, task):
359
"""Called by the task object when it has changed.
361
:param task: The top task object; its parents are also included
364
must_update = task is not self._last_task
365
self._last_task = task
367
if (not must_update) and (now < self._last_repaint + task.update_latency):
369
if now > self._transport_update_time + 10:
370
# no recent activity; expire it
371
self._last_transport_msg = ''
372
self._last_repaint = now
375
def show_transport_activity(self, transport, direction, byte_count):
376
"""Called by transports via the ui_factory, as they do IO.
378
This may update a progress bar, spinner, or similar display.
379
By default it does nothing.
381
# XXX: Probably there should be a transport activity model, and that
382
# too should be seen by the progress view, rather than being poked in
384
self._total_byte_count += byte_count
385
self._bytes_since_update += byte_count
386
if self._first_byte_time is None:
387
# Note that this isn't great, as technically it should be the time
388
# when the bytes started transferring, not when they completed.
389
# However, we usually start with a small request anyway.
390
self._first_byte_time = time.time()
391
if direction in self._bytes_by_direction:
392
self._bytes_by_direction[direction] += byte_count
394
self._bytes_by_direction['unknown'] += byte_count
395
if not self._have_output:
396
# As a workaround for <https://launchpad.net/bugs/321935> we only
397
# show transport activity when there's already a progress bar
398
# shown, which time the application code is expected to know to
399
# clear off the progress bar when it's going to send some other
400
# output. Eventually it would be nice to have that automatically
404
if self._total_byte_count < 2000:
405
# a little resistance at first, so it doesn't stay stuck at 0
406
# while connecting...
408
if self._transport_update_time is None:
409
self._transport_update_time = now
410
elif now >= (self._transport_update_time + 0.5):
411
# guard against clock stepping backwards, and don't update too
413
rate = self._bytes_since_update / (now - self._transport_update_time)
414
msg = ("%6dKB %5dKB/s" %
415
(self._total_byte_count>>10, int(rate)>>10,))
416
self._transport_update_time = now
417
self._last_repaint = now
418
self._bytes_since_update = 0
419
self._last_transport_msg = msg
422
def _format_bytes_by_direction(self):
423
if self._first_byte_time is None:
426
transfer_time = time.time() - self._first_byte_time
427
if transfer_time < 0.001:
428
transfer_time = 0.001
429
bps = self._total_byte_count / transfer_time
431
msg = ('Transferred: %.3fMiB'
432
' (%.1fKiB/s r:%.3fMiB w:%.3fMiB'
433
% (self._total_byte_count / 1024. / 1024.,
435
self._bytes_by_direction['read'] / 1024. / 1024.,
436
self._bytes_by_direction['write'] / 1024. / 1024.,
438
if self._bytes_by_direction['unknown'] > 0:
439
msg += ' u:%.3fMiB)' % (
440
self._bytes_by_direction['unknown'] / 1024. / 1024.
446
def log_transport_activity(self, display=False):
447
msg = self._format_bytes_by_direction()
451
self._term_file.write(msg + '\n')
454
class TextUIOutputStream(object):
455
"""Decorates an output stream so that the terminal is cleared before writing.
457
This is supposed to ensure that the progress bar does not conflict with bulk
460
# XXX: this does not handle the case of writing part of a line, then doing
461
# progress bar output: the progress bar will probably write over it.
462
# one option is just to buffer that text until we have a full line;
463
# another is to save and restore it
465
# XXX: might need to wrap more methods
467
def __init__(self, ui_factory, wrapped_stream):
468
self.ui_factory = ui_factory
469
self.wrapped_stream = wrapped_stream
470
# this does no transcoding, but it must expose the underlying encoding
471
# because some callers need to know what can be written - see for
472
# example unescape_for_display.
473
self.encoding = getattr(wrapped_stream, 'encoding', None)
476
self.ui_factory.clear_term()
477
self.wrapped_stream.flush()
479
def write(self, to_write):
480
self.ui_factory.clear_term()
481
self.wrapped_stream.write(to_write)
483
def writelines(self, lines):
484
self.ui_factory.clear_term()
485
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
