152
137
def make_progress_view(self):
153
138
"""Construct and return a new ProgressView subclass for this UI.
155
# with --quiet, never any progress view
156
# <https://bugs.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':
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':
162
143
return TextProgressView(self.stderr)
163
144
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
164
145
return NullProgressView()
168
149
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)
190
151
def note(self, msg):
191
152
"""Write an already-formatted message, clearing the progress bar if necessary."""
192
153
self.clear_term()
216
175
self._progress_view.show_transport_activity(transport,
217
176
direction, byte_count)
219
def log_transport_activity(self, display=False):
220
"""See UIFactory.log_transport_activity()"""
221
log = getattr(self._progress_view, 'log_transport_activity', None)
225
def show_error(self, msg):
227
self.stderr.write("bzr: error: %s\n" % msg)
229
def show_message(self, msg):
232
def show_warning(self, msg):
234
if isinstance(msg, unicode):
235
te = osutils.get_terminal_encoding()
236
msg = msg.encode(te, 'replace')
237
self.stderr.write("bzr: warning: %s\n" % msg)
239
178
def _progress_updated(self, task):
240
179
"""A task has been updated and wants to be displayed.
243
182
warnings.warn("%r updated but no tasks are active" %
245
184
elif task != self._task_stack[-1]:
246
# We used to check it was the top task, but it's hard to always
247
# get this right and it's not necessarily useful: any actual
248
# problems will be evident in use
249
#warnings.warn("%r is not the top progress task %r" %
250
# (task, self._task_stack[-1]))
185
warnings.warn("%r is not the top progress task %r" %
186
(task, self._task_stack[-1]))
252
187
self._progress_view.show_progress(task)
254
189
def _progress_all_finished(self):
255
190
self._progress_view.clear()
257
def show_user_warning(self, warning_id, **message_args):
258
"""Show a text message to the user.
260
Explicitly not for warnings about bzr apis, deprecations or internals.
262
# eventually trace.warning should migrate here, to avoid logging and
263
# be easier to test; that has a lot of test fallout so for now just
264
# new code can call this
265
if warning_id not in self.suppressed_warnings:
266
self.stderr.write(self.format_user_warning(warning_id, message_args) +
270
193
class TextProgressView(object):
271
194
"""Display of progress bar and other information on a tty.
375
274
t = t._parent_task
377
276
m = t.msg + ':' + m
380
279
def _render_line(self):
381
280
bar_string = self._render_bar()
382
281
if self._last_task:
383
task_part, counter_part = self._format_task(self._last_task)
385
task_part = counter_part = ''
386
if self._last_task and not self._last_task.show_transport_activity:
389
trans = self._last_transport_msg
390
# the bar separates the transport activity from the message, so even
391
# if there's no bar or spinner, we must show something if both those
393
if (task_part or trans) and not bar_string:
395
# preferentially truncate the task message if we don't have enough
397
avail_width = self._avail_width()
398
if avail_width is not None:
399
# if terminal avail_width is unknown, don't truncate
400
current_len = len(bar_string) + len(trans) + len(task_part) + len(counter_part)
401
gap = current_len - avail_width
403
task_part = task_part[:-gap-2] + '..'
404
s = trans + bar_string + task_part + counter_part
405
if avail_width is not None:
406
if len(s) < avail_width:
407
s = s.ljust(avail_width)
408
elif len(s) > avail_width:
282
task_msg = self._format_task(self._last_task)
285
trans = self._last_transport_msg
288
return (bar_string + trans + task_msg)
412
290
def _repaint(self):
413
291
s = self._render_line()
437
315
This may update a progress bar, spinner, or similar display.
438
316
By default it does nothing.
440
# XXX: there should be a transport activity model, and that too should
441
# be seen by the progress view, rather than being poked in here.
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
442
329
self._total_byte_count += byte_count
443
330
self._bytes_since_update += byte_count
444
if self._first_byte_time is None:
445
# Note that this isn't great, as technically it should be the time
446
# when the bytes started transferring, not when they completed.
447
# However, we usually start with a small request anyway.
448
self._first_byte_time = time.time()
449
if direction in self._bytes_by_direction:
450
self._bytes_by_direction[direction] += byte_count
452
self._bytes_by_direction['unknown'] += byte_count
453
if 'no_activity' in debug.debug_flags:
454
# Can be used as a workaround if
455
# <https://launchpad.net/bugs/321935> reappears and transport
456
# activity is cluttering other output. However, thanks to
457
# TextUIOutputStream this shouldn't be a problem any more.
459
331
now = time.time()
460
if self._total_byte_count < 2000:
461
# a little resistance at first, so it doesn't stay stuck at 0
462
# while connecting...
464
332
if self._transport_update_time is None:
465
333
self._transport_update_time = now
466
334
elif now >= (self._transport_update_time + 0.5):
467
335
# guard against clock stepping backwards, and don't update too
469
rate = (self._bytes_since_update
470
/ (now - self._transport_update_time))
471
# using base-10 units (see HACKING.txt).
472
msg = ("%6dkB %5dkB/s " %
473
(self._total_byte_count / 1000, int(rate) / 1000,))
337
rate = self._bytes_since_update / (now - self._transport_update_time)
338
msg = ("%6dKB %5dKB/s" %
339
(self._total_byte_count>>10, int(rate)>>10,))
474
340
self._transport_update_time = now
475
341
self._last_repaint = now
476
342
self._bytes_since_update = 0
477
343
self._last_transport_msg = msg
480
def _format_bytes_by_direction(self):
481
if self._first_byte_time is None:
484
transfer_time = time.time() - self._first_byte_time
485
if transfer_time < 0.001:
486
transfer_time = 0.001
487
bps = self._total_byte_count / transfer_time
489
# using base-10 units (see HACKING.txt).
490
msg = ('Transferred: %.0fkB'
491
' (%.1fkB/s r:%.0fkB w:%.0fkB'
492
% (self._total_byte_count / 1000.,
494
self._bytes_by_direction['read'] / 1000.,
495
self._bytes_by_direction['write'] / 1000.,
497
if self._bytes_by_direction['unknown'] > 0:
498
msg += ' u:%.0fkB)' % (
499
self._bytes_by_direction['unknown'] / 1000.
505
def log_transport_activity(self, display=False):
506
msg = self._format_bytes_by_direction()
508
if display and self._total_byte_count > 0:
510
self._term_file.write(msg + '\n')
513
class TextUIOutputStream(object):
514
"""Decorates an output stream so that the terminal is cleared before writing.
516
This is supposed to ensure that the progress bar does not conflict with bulk
519
# XXX: this does not handle the case of writing part of a line, then doing
520
# progress bar output: the progress bar will probably write over it.
521
# one option is just to buffer that text until we have a full line;
522
# another is to save and restore it
524
# XXX: might need to wrap more methods
526
def __init__(self, ui_factory, wrapped_stream):
527
self.ui_factory = ui_factory
528
self.wrapped_stream = wrapped_stream
529
# this does no transcoding, but it must expose the underlying encoding
530
# because some callers need to know what can be written - see for
531
# example unescape_for_display.
532
self.encoding = getattr(wrapped_stream, 'encoding', None)
535
self.ui_factory.clear_term()
536
self.wrapped_stream.flush()
538
def write(self, to_write):
539
self.ui_factory.clear_term()
540
self.wrapped_stream.write(to_write)
542
def writelines(self, lines):
543
self.ui_factory.clear_term()
544
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
