1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2008, 2009 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
62
59
self.stderr = stderr
63
60
# paints progress, network activity, etc
64
61
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()
74
63
def clear_term(self):
75
64
"""Prepare the terminal for output.
94
83
# end-of-file; possibly should raise an error here instead
97
def get_integer(self, prompt):
100
line = self.stdin.readline()
106
86
def get_non_echoed_password(self):
107
87
isatty = getattr(self.stdin, 'isatty', None)
108
88
if isatty is not None and isatty():
156
136
def make_progress_view(self):
157
137
"""Construct and return a new ProgressView subclass for this UI.
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':
139
# if the user specifically requests either text or no progress bars,
140
# always do that. otherwise, guess based on $TERM and tty presence.
141
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
166
142
return TextProgressView(self.stderr)
167
143
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
168
144
return NullProgressView()
172
148
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)
150
def _make_output_stream_explicit(self, encoding, encoding_errors):
151
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
152
errors=encoding_errors)
153
return TextUIOutputStream(self, encoded_stdout)
194
155
def note(self, msg):
195
156
"""Write an already-formatted message, clearing the progress bar if necessary."""
218
179
self._progress_view.show_transport_activity(transport,
219
180
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)
227
182
def show_error(self, msg):
228
183
self.clear_term()
229
184
self.stderr.write("bzr: error: %s\n" % msg)
242
197
warnings.warn("%r updated but no tasks are active" %
244
199
elif task != self._task_stack[-1]:
245
# We used to check it was the top task, but it's hard to always
246
# get this right and it's not necessarily useful: any actual
247
# problems will be evident in use
248
#warnings.warn("%r is not the top progress task %r" %
249
# (task, self._task_stack[-1]))
200
warnings.warn("%r is not the top progress task %r" %
201
(task, self._task_stack[-1]))
251
202
self._progress_view.show_progress(task)
253
204
def _progress_all_finished(self):
254
205
self._progress_view.clear()
256
def show_user_warning(self, warning_id, **message_args):
257
"""Show a text message to the user.
259
Explicitly not for warnings about bzr apis, deprecations or internals.
261
# eventually trace.warning should migrate here, to avoid logging and
262
# be easier to test; that has a lot of test fallout so for now just
263
# new code can call this
264
if warning_id not in self.suppressed_warnings:
265
self.stderr.write(self.format_user_warning(warning_id, message_args) +
269
208
class TextProgressView(object):
270
209
"""Display of progress bar and other information on a tty.
285
224
self._term_file = term_file
286
225
# true when there's output on the screen we may need to clear
287
226
self._have_output = False
227
# XXX: We could listen for SIGWINCH and update the terminal width...
228
# https://launchpad.net/bugs/316357
229
self._width = osutils.terminal_width()
288
230
self._last_transport_msg = ''
289
231
self._spin_pos = 0
290
232
# time we last repainted the screen
294
236
self._last_task = None
295
237
self._total_byte_count = 0
296
238
self._bytes_since_update = 0
297
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
298
self._first_byte_time = None
299
239
self._fraction = 0
300
# force the progress bar to be off, as at the moment it doesn't
301
# correspond reliably to overall command progress
302
self.enable_bar = False
304
241
def _show_line(self, s):
305
242
# sys.stderr.write("progress %r\n" % s)
306
width = osutils.terminal_width()
307
if width is not None:
308
# we need one extra space for terminals that wrap on last char
310
s = '%-*.*s' % (width, width, s)
311
self._term_file.write('\r' + s + '\r')
244
self._term_file.write('\r%-*.*s\r' % (n, n, s))
314
247
if self._have_output:
318
251
def _render_bar(self):
319
252
# return a string for the progress bar itself
320
if self.enable_bar and (
321
(self._last_task is None) or self._last_task.show_bar):
253
if (self._last_task is None) or self._last_task.show_bar:
322
254
# If there's no task object, we show space for the bar anyhow.
323
255
# That's because most invocations of bzr will end showing progress
324
256
# at some point, though perhaps only after doing some initial IO.
340
272
markers = int(round(float(cols) * completion_fraction)) - 1
341
273
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
343
elif (self._last_task is None) or self._last_task.show_spinner:
275
elif self._last_task.show_spinner:
344
276
# The last task wanted just a spinner, no bar
345
277
spin_str = r'/-\|'[self._spin_pos % 4]
346
278
self._spin_pos += 1
408
340
This may update a progress bar, spinner, or similar display.
409
341
By default it does nothing.
411
# XXX: there should be a transport activity model, and that too should
412
# be seen by the progress view, rather than being poked in here.
343
# XXX: Probably there should be a transport activity model, and that
344
# too should be seen by the progress view, rather than being poked in
346
if not self._have_output:
347
# As a workaround for <https://launchpad.net/bugs/321935> we only
348
# show transport activity when there's already a progress bar
349
# shown, which time the application code is expected to know to
350
# clear off the progress bar when it's going to send some other
351
# output. Eventually it would be nice to have that automatically
413
354
self._total_byte_count += byte_count
414
355
self._bytes_since_update += byte_count
415
if self._first_byte_time is None:
416
# Note that this isn't great, as technically it should be the time
417
# when the bytes started transferring, not when they completed.
418
# However, we usually start with a small request anyway.
419
self._first_byte_time = time.time()
420
if direction in self._bytes_by_direction:
421
self._bytes_by_direction[direction] += byte_count
423
self._bytes_by_direction['unknown'] += byte_count
424
if 'no_activity' in debug.debug_flags:
425
# Can be used as a workaround if
426
# <https://launchpad.net/bugs/321935> reappears and transport
427
# activity is cluttering other output. However, thanks to
428
# TextUIOutputStream this shouldn't be a problem any more.
430
356
now = time.time()
431
357
if self._total_byte_count < 2000:
432
358
# a little resistance at first, so it doesn't stay stuck at 0
437
363
elif now >= (self._transport_update_time + 0.5):
438
364
# guard against clock stepping backwards, and don't update too
440
rate = (self._bytes_since_update
441
/ (now - self._transport_update_time))
442
# using base-10 units (see HACKING.txt).
443
msg = ("%6dkB %5dkB/s" %
444
(self._total_byte_count / 1000, int(rate) / 1000,))
366
rate = self._bytes_since_update / (now - self._transport_update_time)
367
msg = ("%6dKB %5dKB/s" %
368
(self._total_byte_count>>10, int(rate)>>10,))
445
369
self._transport_update_time = now
446
370
self._last_repaint = now
447
371
self._bytes_since_update = 0
448
372
self._last_transport_msg = msg
451
def _format_bytes_by_direction(self):
452
if self._first_byte_time is None:
455
transfer_time = time.time() - self._first_byte_time
456
if transfer_time < 0.001:
457
transfer_time = 0.001
458
bps = self._total_byte_count / transfer_time
460
# using base-10 units (see HACKING.txt).
461
msg = ('Transferred: %.0fkB'
462
' (%.1fkB/s r:%.0fkB w:%.0fkB'
463
% (self._total_byte_count / 1000.,
465
self._bytes_by_direction['read'] / 1000.,
466
self._bytes_by_direction['write'] / 1000.,
468
if self._bytes_by_direction['unknown'] > 0:
469
msg += ' u:%.0fkB)' % (
470
self._bytes_by_direction['unknown'] / 1000.
476
def log_transport_activity(self, display=False):
477
msg = self._format_bytes_by_direction()
479
if display and self._total_byte_count > 0:
481
self._term_file.write(msg + '\n')
484
376
class TextUIOutputStream(object):
485
377
"""Decorates an output stream so that the terminal is cleared before writing.
497
389
def __init__(self, ui_factory, wrapped_stream):
498
390
self.ui_factory = ui_factory
499
391
self.wrapped_stream = wrapped_stream
500
# this does no transcoding, but it must expose the underlying encoding
501
# because some callers need to know what can be written - see for
502
# example unescape_for_display.
503
self.encoding = getattr(wrapped_stream, 'encoding', None)
506
self.ui_factory.clear_term()
507
self.wrapped_stream.flush()
509
393
def write(self, to_write):
510
394
self.ui_factory.clear_term()
added
removed
bzrlib/ui/text.py
