152
138
def make_progress_view(self):
153
139
"""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':
141
# if the user specifically requests either text or no progress bars,
142
# always do that. otherwise, guess based on $TERM and tty presence.
143
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
162
144
return TextProgressView(self.stderr)
163
145
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
164
146
return NullProgressView()
168
150
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
152
def note(self, msg):
191
153
"""Write an already-formatted message, clearing the progress bar if necessary."""
192
154
self.clear_term()
214
176
self._progress_view.show_transport_activity(transport,
215
177
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
if isinstance(msg, unicode):
233
te = osutils.get_terminal_encoding()
234
msg = msg.encode(te, 'replace')
235
self.stderr.write("bzr: warning: %s\n" % msg)
237
179
def _progress_updated(self, task):
238
180
"""A task has been updated and wants to be displayed.
241
183
warnings.warn("%r updated but no tasks are active" %
243
185
elif task != self._task_stack[-1]:
244
# We used to check it was the top task, but it's hard to always
245
# get this right and it's not necessarily useful: any actual
246
# problems will be evident in use
247
#warnings.warn("%r is not the top progress task %r" %
248
# (task, self._task_stack[-1]))
186
warnings.warn("%r is not the top progress task %r" %
187
(task, self._task_stack[-1]))
250
188
self._progress_view.show_progress(task)
252
190
def _progress_all_finished(self):
253
191
self._progress_view.clear()
255
def show_user_warning(self, warning_id, **message_args):
256
"""Show a text message to the user.
258
Explicitly not for warnings about bzr apis, deprecations or internals.
260
# eventually trace.warning should migrate here, to avoid logging and
261
# be easier to test; that has a lot of test fallout so for now just
262
# new code can call this
263
if warning_id not in self.suppressed_warnings:
264
self.stderr.write(self.format_user_warning(warning_id, message_args) +
268
194
class TextProgressView(object):
269
195
"""Display of progress bar and other information on a tty.
373
275
t = t._parent_task
375
277
m = t.msg + ':' + m
378
280
def _render_line(self):
379
281
bar_string = self._render_bar()
380
282
if self._last_task:
381
task_part, counter_part = self._format_task(self._last_task)
383
task_part = counter_part = ''
384
if self._last_task and not self._last_task.show_transport_activity:
387
trans = self._last_transport_msg
388
# the bar separates the transport activity from the message, so even
389
# if there's no bar or spinner, we must show something if both those
391
if (task_part or trans) and not bar_string:
393
# preferentially truncate the task message if we don't have enough
395
avail_width = self._avail_width()
396
if avail_width is not None:
397
# if terminal avail_width is unknown, don't truncate
398
current_len = len(bar_string) + len(trans) + len(task_part) + len(counter_part)
399
gap = current_len - avail_width
401
task_part = task_part[:-gap-2] + '..'
402
s = trans + bar_string + task_part + counter_part
403
if avail_width is not None:
404
if len(s) < avail_width:
405
s = s.ljust(avail_width)
406
elif len(s) > avail_width:
283
task_msg = self._format_task(self._last_task)
286
trans = self._last_transport_msg
289
return (bar_string + trans + task_msg)
410
291
def _repaint(self):
411
292
s = self._render_line()
435
316
This may update a progress bar, spinner, or similar display.
436
317
By default it does nothing.
438
# XXX: there should be a transport activity model, and that too should
439
# be seen by the progress view, rather than being poked in here.
319
# XXX: Probably there should be a transport activity model, and that
320
# too should be seen by the progress view, rather than being poked in
322
if not self._have_output:
323
# As a workaround for <https://launchpad.net/bugs/321935> we only
324
# show transport activity when there's already a progress bar
325
# shown, which time the application code is expected to know to
326
# clear off the progress bar when it's going to send some other
327
# output. Eventually it would be nice to have that automatically
440
330
self._total_byte_count += byte_count
441
331
self._bytes_since_update += byte_count
442
if self._first_byte_time is None:
443
# Note that this isn't great, as technically it should be the time
444
# when the bytes started transferring, not when they completed.
445
# However, we usually start with a small request anyway.
446
self._first_byte_time = time.time()
447
if direction in self._bytes_by_direction:
448
self._bytes_by_direction[direction] += byte_count
450
self._bytes_by_direction['unknown'] += byte_count
451
if 'no_activity' in debug.debug_flags:
452
# Can be used as a workaround if
453
# <https://launchpad.net/bugs/321935> reappears and transport
454
# activity is cluttering other output. However, thanks to
455
# TextUIOutputStream this shouldn't be a problem any more.
457
332
now = time.time()
458
if self._total_byte_count < 2000:
459
# a little resistance at first, so it doesn't stay stuck at 0
460
# while connecting...
462
333
if self._transport_update_time is None:
463
334
self._transport_update_time = now
464
335
elif now >= (self._transport_update_time + 0.5):
465
336
# guard against clock stepping backwards, and don't update too
467
rate = (self._bytes_since_update
468
/ (now - self._transport_update_time))
469
# using base-10 units (see HACKING.txt).
470
msg = ("%6dkB %5dkB/s " %
471
(self._total_byte_count / 1000, int(rate) / 1000,))
338
rate = self._bytes_since_update / (now - self._transport_update_time)
339
msg = ("%6dKB %5dKB/s" %
340
(self._total_byte_count>>10, int(rate)>>10,))
472
341
self._transport_update_time = now
473
342
self._last_repaint = now
474
343
self._bytes_since_update = 0
475
344
self._last_transport_msg = msg
478
def _format_bytes_by_direction(self):
479
if self._first_byte_time is None:
482
transfer_time = time.time() - self._first_byte_time
483
if transfer_time < 0.001:
484
transfer_time = 0.001
485
bps = self._total_byte_count / transfer_time
487
# using base-10 units (see HACKING.txt).
488
msg = ('Transferred: %.0fkB'
489
' (%.1fkB/s r:%.0fkB w:%.0fkB'
490
% (self._total_byte_count / 1000.,
492
self._bytes_by_direction['read'] / 1000.,
493
self._bytes_by_direction['write'] / 1000.,
495
if self._bytes_by_direction['unknown'] > 0:
496
msg += ' u:%.0fkB)' % (
497
self._bytes_by_direction['unknown'] / 1000.
503
def log_transport_activity(self, display=False):
504
msg = self._format_bytes_by_direction()
506
if display and self._total_byte_count > 0:
508
self._term_file.write(msg + '\n')
511
class TextUIOutputStream(object):
512
"""Decorates an output stream so that the terminal is cleared before writing.
514
This is supposed to ensure that the progress bar does not conflict with bulk
517
# XXX: this does not handle the case of writing part of a line, then doing
518
# progress bar output: the progress bar will probably write over it.
519
# one option is just to buffer that text until we have a full line;
520
# another is to save and restore it
522
# XXX: might need to wrap more methods
524
def __init__(self, ui_factory, wrapped_stream):
525
self.ui_factory = ui_factory
526
self.wrapped_stream = wrapped_stream
527
# this does no transcoding, but it must expose the underlying encoding
528
# because some callers need to know what can be written - see for
529
# example unescape_for_display.
530
self.encoding = getattr(wrapped_stream, 'encoding', None)
533
self.ui_factory.clear_term()
534
self.wrapped_stream.flush()
536
def write(self, to_write):
537
self.ui_factory.clear_term()
538
self.wrapped_stream.write(to_write)
540
def writelines(self, lines):
541
self.ui_factory.clear_term()
542
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
