26
28
from bzrlib.lazy_import import lazy_import
27
29
lazy_import(globals(), """
28
30
from bzrlib import (
36
from bzrlib.ui import CLIUIFactory
39
class TextUIFactory(CLIUIFactory):
40
from bzrlib.ui import (
46
class TextUIFactory(UIFactory):
40
47
"""A UI factory for Text user interefaces."""
47
53
"""Create a TextUIFactory.
49
:param bar_type: The type of progress bar to create. It defaults to
50
letting the bzrlib.progress.ProgressBar factory auto
53
super(TextUIFactory, self).__init__(stdin=stdin,
54
stdout=stdout, stderr=stderr)
56
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 11, 0))
57
% "bar_type parameter")
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...
58
61
# paints progress, network activity, etc
59
self._progress_view = TextProgressView(self.stderr)
62
self._progress_view = self.make_progress_view()
61
64
def clear_term(self):
62
65
"""Prepare the terminal for output.
69
72
# to clear it. We might need to separately check for the case of
70
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)
72
180
def note(self, msg):
73
181
"""Write an already-formatted message, clearing the progress bar if necessary."""
75
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)
77
198
def report_transport_activity(self, transport, byte_count, direction):
78
199
"""Called by transports as they do IO.
80
201
This may update a progress bar, spinner, or similar display.
81
202
By default it does nothing.
83
self._progress_view._show_transport_activity(transport,
204
self._progress_view.show_transport_activity(transport,
84
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)
86
224
def _progress_updated(self, task):
87
225
"""A task has been updated and wants to be displayed.
216
372
self._last_repaint = now
219
def _show_transport_activity(self, transport, direction, byte_count):
375
def show_transport_activity(self, transport, direction, byte_count):
220
376
"""Called by transports via the ui_factory, as they do IO.
222
378
This may update a progress bar, spinner, or similar display.
223
379
By default it does nothing.
225
# XXX: Probably there should be a transport activity model, and that
226
# too should be seen by the progress view, rather than being poked in
381
# XXX: there should be a transport activity model, and that too should
382
# be seen by the progress view, rather than being poked in here.
228
383
self._total_byte_count += byte_count
229
384
self._bytes_since_update += byte_count
385
if self._first_byte_time is None:
386
# Note that this isn't great, as technically it should be the time
387
# when the bytes started transferring, not when they completed.
388
# However, we usually start with a small request anyway.
389
self._first_byte_time = time.time()
390
if direction in self._bytes_by_direction:
391
self._bytes_by_direction[direction] += byte_count
393
self._bytes_by_direction['unknown'] += byte_count
394
if 'no_activity' in debug.debug_flags:
395
# Can be used as a workaround if
396
# <https://launchpad.net/bugs/321935> reappears and transport
397
# activity is cluttering other output. However, thanks to
398
# TextUIOutputStream this shouldn't be a problem any more.
230
400
now = time.time()
401
if self._total_byte_count < 2000:
402
# a little resistance at first, so it doesn't stay stuck at 0
403
# while connecting...
231
405
if self._transport_update_time is None:
232
406
self._transport_update_time = now
233
407
elif now >= (self._transport_update_time + 0.5):
234
408
# guard against clock stepping backwards, and don't update too
236
410
rate = self._bytes_since_update / (now - self._transport_update_time)
237
scheme = getattr(transport, '_scheme', None) or repr(transport)
238
if direction == 'read':
240
elif direction == 'write':
244
msg = ("%.7s %s %6dKB %5dKB/s" %
245
(scheme, dir_char, self._total_byte_count>>10, int(rate)>>10,))
411
msg = ("%6dKB %5dKB/s" %
412
(self._total_byte_count>>10, int(rate)>>10,))
246
413
self._transport_update_time = now
247
414
self._last_repaint = now
248
415
self._bytes_since_update = 0
249
416
self._last_transport_msg = msg
419
def _format_bytes_by_direction(self):
420
if self._first_byte_time is None:
423
transfer_time = time.time() - self._first_byte_time
424
if transfer_time < 0.001:
425
transfer_time = 0.001
426
bps = self._total_byte_count / transfer_time
428
msg = ('Transferred: %.0fKiB'
429
' (%.1fK/s r:%.0fK w:%.0fK'
430
% (self._total_byte_count / 1024.,
432
self._bytes_by_direction['read'] / 1024.,
433
self._bytes_by_direction['write'] / 1024.,
435
if self._bytes_by_direction['unknown'] > 0:
436
msg += ' u:%.0fK)' % (
437
self._bytes_by_direction['unknown'] / 1024.
443
def log_transport_activity(self, display=False):
444
msg = self._format_bytes_by_direction()
446
if display and self._total_byte_count > 0:
448
self._term_file.write(msg + '\n')
451
class TextUIOutputStream(object):
452
"""Decorates an output stream so that the terminal is cleared before writing.
454
This is supposed to ensure that the progress bar does not conflict with bulk
457
# XXX: this does not handle the case of writing part of a line, then doing
458
# progress bar output: the progress bar will probably write over it.
459
# one option is just to buffer that text until we have a full line;
460
# another is to save and restore it
462
# XXX: might need to wrap more methods
464
def __init__(self, ui_factory, wrapped_stream):
465
self.ui_factory = ui_factory
466
self.wrapped_stream = wrapped_stream
467
# this does no transcoding, but it must expose the underlying encoding
468
# because some callers need to know what can be written - see for
469
# example unescape_for_display.
470
self.encoding = getattr(wrapped_stream, 'encoding', None)
473
self.ui_factory.clear_term()
474
self.wrapped_stream.flush()
476
def write(self, to_write):
477
self.ui_factory.clear_term()
478
self.wrapped_stream.write(to_write)
480
def writelines(self, lines):
481
self.ui_factory.clear_term()
482
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
