1
# Copyright (C) 2005, 2008, 2009 Canonical Ltd
1
# Copyright (C) 2005, 2008, 2009, 2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
49
53
"""Create a TextUIFactory.
51
:param bar_type: The type of progress bar to create. It defaults to
52
letting the bzrlib.progress.ProgressBar factory auto
55
55
super(TextUIFactory, self).__init__()
56
56
# TODO: there's no good reason not to pass all three streams, maybe we
61
61
# paints progress, network activity, etc
62
62
self._progress_view = self.make_progress_view()
64
def be_quiet(self, state):
65
if state and not self._quiet:
67
UIFactory.be_quiet(self, state)
68
self._progress_view = self.make_progress_view()
64
70
def clear_term(self):
65
71
"""Prepare the terminal for output.
84
90
# end-of-file; possibly should raise an error here instead
93
def get_integer(self, prompt):
96
line = self.stdin.readline()
87
102
def get_non_echoed_password(self):
88
103
isatty = getattr(self.stdin, 'isatty', None)
89
104
if isatty is not None and isatty():
137
152
def make_progress_view(self):
138
153
"""Construct and return a new ProgressView subclass for this UI.
140
# if the user specifically requests either text or no progress bars,
141
# always do that. otherwise, guess based on $TERM and tty presence.
142
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
155
# with --quiet, never any progress view
156
# <https://bugs.edge.launchpad.net/bzr/+bug/320035>. Otherwise if the
157
# user specifically requests either text or no progress bars, always
158
# do that. otherwise, guess based on $TERM and tty presence.
160
return NullProgressView()
161
elif os.environ.get('BZR_PROGRESS_BAR') == 'text':
143
162
return TextProgressView(self.stderr)
144
163
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
145
164
return NullProgressView()
149
168
return NullProgressView()
170
def _make_output_stream_explicit(self, encoding, encoding_type):
171
if encoding_type == 'exact':
172
# force sys.stdout to be binary stream on win32;
173
# NB: this leaves the file set in that mode; may cause problems if
174
# one process tries to do binary and then text output
175
if sys.platform == 'win32':
176
fileno = getattr(self.stdout, 'fileno', None)
179
msvcrt.setmode(fileno(), os.O_BINARY)
180
return TextUIOutputStream(self, self.stdout)
182
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
183
errors=encoding_type)
184
# For whatever reason codecs.getwriter() does not advertise its encoding
185
# it just returns the encoding of the wrapped file, which is completely
186
# bogus. So set the attribute, so we can find the correct encoding later.
187
encoded_stdout.encoding = encoding
188
return TextUIOutputStream(self, encoded_stdout)
151
190
def note(self, msg):
152
191
"""Write an already-formatted message, clearing the progress bar if necessary."""
153
192
self.clear_term()
175
214
self._progress_view.show_transport_activity(transport,
176
215
direction, byte_count)
217
def log_transport_activity(self, display=False):
218
"""See UIFactory.log_transport_activity()"""
219
log = getattr(self._progress_view, 'log_transport_activity', None)
223
def show_error(self, msg):
225
self.stderr.write("bzr: error: %s\n" % msg)
227
def show_message(self, msg):
230
def show_warning(self, msg):
232
self.stderr.write("bzr: warning: %s\n" % msg)
178
234
def _progress_updated(self, task):
179
235
"""A task has been updated and wants to be displayed.
209
265
self._term_file = term_file
210
266
# true when there's output on the screen we may need to clear
211
267
self._have_output = False
212
# XXX: We could listen for SIGWINCH and update the terminal width...
213
# https://launchpad.net/bugs/316357
214
self._width = osutils.terminal_width()
215
268
self._last_transport_msg = ''
216
269
self._spin_pos = 0
217
270
# time we last repainted the screen
221
274
self._last_task = None
222
275
self._total_byte_count = 0
223
276
self._bytes_since_update = 0
277
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
278
self._first_byte_time = None
280
# force the progress bar to be off, as at the moment it doesn't
281
# correspond reliably to overall command progress
282
self.enable_bar = False
225
284
def _show_line(self, s):
227
self._term_file.write('\r%-*.*s\r' % (n, n, s))
285
# sys.stderr.write("progress %r\n" % s)
286
width = osutils.terminal_width()
287
if width is not None:
288
# we need one extra space for terminals that wrap on last char
290
s = '%-*.*s' % (width, width, s)
291
self._term_file.write('\r' + s + '\r')
230
294
if self._have_output:
234
298
def _render_bar(self):
235
299
# return a string for the progress bar itself
236
if (self._last_task is None) or self._last_task.show_bar:
300
if self.enable_bar and (
301
(self._last_task is None) or self._last_task.show_bar):
237
302
# If there's no task object, we show space for the bar anyhow.
238
303
# That's because most invocations of bzr will end showing progress
239
304
# at some point, though perhaps only after doing some initial IO.
245
310
if self._last_task is None:
246
311
completion_fraction = 0
248
314
completion_fraction = \
249
315
self._last_task._overall_completion_fraction() or 0
316
if (completion_fraction < self._fraction and 'progress' in
318
import pdb;pdb.set_trace()
319
self._fraction = completion_fraction
250
320
markers = int(round(float(cols) * completion_fraction)) - 1
251
321
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
253
elif self._last_task.show_spinner:
323
elif (self._last_task is None) or self._last_task.show_spinner:
254
324
# The last task wanted just a spinner, no bar
255
325
spin_str = r'/-\|'[self._spin_pos % 4]
256
326
self._spin_pos += 1
315
388
This may update a progress bar, spinner, or similar display.
316
389
By default it does nothing.
318
# XXX: Probably there should be a transport activity model, and that
319
# too should be seen by the progress view, rather than being poked in
321
if not self._have_output:
322
# As a workaround for <https://launchpad.net/bugs/321935> we only
323
# show transport activity when there's already a progress bar
324
# shown, which time the application code is expected to know to
325
# clear off the progress bar when it's going to send some other
326
# output. Eventually it would be nice to have that automatically
391
# XXX: there should be a transport activity model, and that too should
392
# be seen by the progress view, rather than being poked in here.
329
393
self._total_byte_count += byte_count
330
394
self._bytes_since_update += byte_count
395
if self._first_byte_time is None:
396
# Note that this isn't great, as technically it should be the time
397
# when the bytes started transferring, not when they completed.
398
# However, we usually start with a small request anyway.
399
self._first_byte_time = time.time()
400
if direction in self._bytes_by_direction:
401
self._bytes_by_direction[direction] += byte_count
403
self._bytes_by_direction['unknown'] += byte_count
404
if 'no_activity' in debug.debug_flags:
405
# Can be used as a workaround if
406
# <https://launchpad.net/bugs/321935> reappears and transport
407
# activity is cluttering other output. However, thanks to
408
# TextUIOutputStream this shouldn't be a problem any more.
331
410
now = time.time()
411
if self._total_byte_count < 2000:
412
# a little resistance at first, so it doesn't stay stuck at 0
413
# while connecting...
332
415
if self._transport_update_time is None:
333
416
self._transport_update_time = now
334
417
elif now >= (self._transport_update_time + 0.5):
342
425
self._bytes_since_update = 0
343
426
self._last_transport_msg = msg
429
def _format_bytes_by_direction(self):
430
if self._first_byte_time is None:
433
transfer_time = time.time() - self._first_byte_time
434
if transfer_time < 0.001:
435
transfer_time = 0.001
436
bps = self._total_byte_count / transfer_time
438
msg = ('Transferred: %.0fKiB'
439
' (%.1fK/s r:%.0fK w:%.0fK'
440
% (self._total_byte_count / 1024.,
442
self._bytes_by_direction['read'] / 1024.,
443
self._bytes_by_direction['write'] / 1024.,
445
if self._bytes_by_direction['unknown'] > 0:
446
msg += ' u:%.0fK)' % (
447
self._bytes_by_direction['unknown'] / 1024.
453
def log_transport_activity(self, display=False):
454
msg = self._format_bytes_by_direction()
456
if display and self._total_byte_count > 0:
458
self._term_file.write(msg + '\n')
461
class TextUIOutputStream(object):
462
"""Decorates an output stream so that the terminal is cleared before writing.
464
This is supposed to ensure that the progress bar does not conflict with bulk
467
# XXX: this does not handle the case of writing part of a line, then doing
468
# progress bar output: the progress bar will probably write over it.
469
# one option is just to buffer that text until we have a full line;
470
# another is to save and restore it
472
# XXX: might need to wrap more methods
474
def __init__(self, ui_factory, wrapped_stream):
475
self.ui_factory = ui_factory
476
self.wrapped_stream = wrapped_stream
477
# this does no transcoding, but it must expose the underlying encoding
478
# because some callers need to know what can be written - see for
479
# example unescape_for_display.
480
self.encoding = getattr(wrapped_stream, 'encoding', None)
483
self.ui_factory.clear_term()
484
self.wrapped_stream.flush()
486
def write(self, to_write):
487
self.ui_factory.clear_term()
488
self.wrapped_stream.write(to_write)
490
def writelines(self, lines):
491
self.ui_factory.clear_term()
492
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
