58
62
self.stderr = stderr
59
63
# paints progress, network activity, etc
60
64
self._progress_view = self.make_progress_view()
65
# hook up the signals to watch for terminal size changes
68
def be_quiet(self, state):
69
if state and not self._quiet:
71
UIFactory.be_quiet(self, state)
72
self._progress_view = self.make_progress_view()
62
74
def clear_term(self):
63
75
"""Prepare the terminal for output.
82
94
# end-of-file; possibly should raise an error here instead
97
def get_integer(self, prompt):
100
line = self.stdin.readline()
85
106
def get_non_echoed_password(self):
86
107
isatty = getattr(self.stdin, 'isatty', None)
87
108
if isatty is not None and isatty():
135
156
def make_progress_view(self):
136
157
"""Construct and return a new ProgressView subclass for this UI.
138
# if the user specifically requests either text or no progress bars,
139
# always do that. otherwise, guess based on $TERM and tty presence.
140
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
159
# with --quiet, never any progress view
160
# <https://bugs.edge.launchpad.net/bzr/+bug/320035>. Otherwise if the
161
# user specifically requests either text or no progress bars, always
162
# do that. otherwise, guess based on $TERM and tty presence.
164
return NullProgressView()
165
elif os.environ.get('BZR_PROGRESS_BAR') == 'text':
141
166
return TextProgressView(self.stderr)
142
167
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
143
168
return NullProgressView()
147
172
return NullProgressView()
174
def _make_output_stream_explicit(self, encoding, encoding_type):
175
if encoding_type == 'exact':
176
# force sys.stdout to be binary stream on win32;
177
# NB: this leaves the file set in that mode; may cause problems if
178
# one process tries to do binary and then text output
179
if sys.platform == 'win32':
180
fileno = getattr(self.stdout, 'fileno', None)
183
msvcrt.setmode(fileno(), os.O_BINARY)
184
return TextUIOutputStream(self, self.stdout)
186
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
187
errors=encoding_type)
188
# For whatever reason codecs.getwriter() does not advertise its encoding
189
# it just returns the encoding of the wrapped file, which is completely
190
# bogus. So set the attribute, so we can find the correct encoding later.
191
encoded_stdout.encoding = encoding
192
return TextUIOutputStream(self, encoded_stdout)
149
194
def note(self, msg):
150
195
"""Write an already-formatted message, clearing the progress bar if necessary."""
151
196
self.clear_term()
173
218
self._progress_view.show_transport_activity(transport,
174
219
direction, byte_count)
221
def log_transport_activity(self, display=False):
222
"""See UIFactory.log_transport_activity()"""
223
log = getattr(self._progress_view, 'log_transport_activity', None)
176
227
def show_error(self, msg):
177
228
self.clear_term()
178
229
self.stderr.write("bzr: error: %s\n" % msg)
218
269
self._term_file = term_file
219
270
# true when there's output on the screen we may need to clear
220
271
self._have_output = False
221
# XXX: We could listen for SIGWINCH and update the terminal width...
222
# https://launchpad.net/bugs/316357
223
self._width = osutils.terminal_width()
224
272
self._last_transport_msg = ''
225
273
self._spin_pos = 0
226
274
# time we last repainted the screen
230
278
self._last_task = None
231
279
self._total_byte_count = 0
232
280
self._bytes_since_update = 0
281
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
282
self._first_byte_time = None
233
283
self._fraction = 0
284
# force the progress bar to be off, as at the moment it doesn't
285
# correspond reliably to overall command progress
286
self.enable_bar = False
235
288
def _show_line(self, s):
236
289
# sys.stderr.write("progress %r\n" % s)
238
self._term_file.write('\r%-*.*s\r' % (n, n, s))
290
width = osutils.terminal_width()
291
if width is not None:
292
# we need one extra space for terminals that wrap on last char
294
s = '%-*.*s' % (width, width, s)
295
self._term_file.write('\r' + s + '\r')
241
298
if self._have_output:
245
302
def _render_bar(self):
246
303
# return a string for the progress bar itself
247
if (self._last_task is None) or self._last_task.show_bar:
304
if self.enable_bar and (
305
(self._last_task is None) or self._last_task.show_bar):
248
306
# If there's no task object, we show space for the bar anyhow.
249
307
# That's because most invocations of bzr will end showing progress
250
308
# at some point, though perhaps only after doing some initial IO.
266
324
markers = int(round(float(cols) * completion_fraction)) - 1
267
325
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
269
elif self._last_task.show_spinner:
327
elif (self._last_task is None) or self._last_task.show_spinner:
270
328
# The last task wanted just a spinner, no bar
271
329
spin_str = r'/-\|'[self._spin_pos % 4]
272
330
self._spin_pos += 1
334
392
This may update a progress bar, spinner, or similar display.
335
393
By default it does nothing.
337
# XXX: Probably there should be a transport activity model, and that
338
# too should be seen by the progress view, rather than being poked in
340
if not self._have_output:
341
# As a workaround for <https://launchpad.net/bugs/321935> we only
342
# show transport activity when there's already a progress bar
343
# shown, which time the application code is expected to know to
344
# clear off the progress bar when it's going to send some other
345
# output. Eventually it would be nice to have that automatically
395
# XXX: there should be a transport activity model, and that too should
396
# be seen by the progress view, rather than being poked in here.
348
397
self._total_byte_count += byte_count
349
398
self._bytes_since_update += byte_count
399
if self._first_byte_time is None:
400
# Note that this isn't great, as technically it should be the time
401
# when the bytes started transferring, not when they completed.
402
# However, we usually start with a small request anyway.
403
self._first_byte_time = time.time()
404
if direction in self._bytes_by_direction:
405
self._bytes_by_direction[direction] += byte_count
407
self._bytes_by_direction['unknown'] += byte_count
408
if 'no_activity' in debug.debug_flags:
409
# Can be used as a workaround if
410
# <https://launchpad.net/bugs/321935> reappears and transport
411
# activity is cluttering other output. However, thanks to
412
# TextUIOutputStream this shouldn't be a problem any more.
350
414
now = time.time()
351
415
if self._total_byte_count < 2000:
352
416
# a little resistance at first, so it doesn't stay stuck at 0
365
429
self._bytes_since_update = 0
366
430
self._last_transport_msg = msg
433
def _format_bytes_by_direction(self):
434
if self._first_byte_time is None:
437
transfer_time = time.time() - self._first_byte_time
438
if transfer_time < 0.001:
439
transfer_time = 0.001
440
bps = self._total_byte_count / transfer_time
442
msg = ('Transferred: %.0fKiB'
443
' (%.1fK/s r:%.0fK w:%.0fK'
444
% (self._total_byte_count / 1024.,
446
self._bytes_by_direction['read'] / 1024.,
447
self._bytes_by_direction['write'] / 1024.,
449
if self._bytes_by_direction['unknown'] > 0:
450
msg += ' u:%.0fK)' % (
451
self._bytes_by_direction['unknown'] / 1024.
457
def log_transport_activity(self, display=False):
458
msg = self._format_bytes_by_direction()
460
if display and self._total_byte_count > 0:
462
self._term_file.write(msg + '\n')
465
class TextUIOutputStream(object):
466
"""Decorates an output stream so that the terminal is cleared before writing.
468
This is supposed to ensure that the progress bar does not conflict with bulk
471
# XXX: this does not handle the case of writing part of a line, then doing
472
# progress bar output: the progress bar will probably write over it.
473
# one option is just to buffer that text until we have a full line;
474
# another is to save and restore it
476
# XXX: might need to wrap more methods
478
def __init__(self, ui_factory, wrapped_stream):
479
self.ui_factory = ui_factory
480
self.wrapped_stream = wrapped_stream
481
# this does no transcoding, but it must expose the underlying encoding
482
# because some callers need to know what can be written - see for
483
# example unescape_for_display.
484
self.encoding = getattr(wrapped_stream, 'encoding', None)
487
self.ui_factory.clear_term()
488
self.wrapped_stream.flush()
490
def write(self, to_write):
491
self.ui_factory.clear_term()
492
self.wrapped_stream.write(to_write)
494
def writelines(self, lines):
495
self.ui_factory.clear_term()
496
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
