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
60
59
self.stderr = stderr
61
60
# paints progress, network activity, etc
62
61
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()
70
63
def clear_term(self):
71
64
"""Prepare the terminal for output.
152
145
def make_progress_view(self):
153
146
"""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':
148
# if the user specifically requests either text or no progress bars,
149
# always do that. otherwise, guess based on $TERM and tty presence.
150
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
162
151
return TextProgressView(self.stderr)
163
152
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
164
153
return NullProgressView()
214
203
self._progress_view.show_transport_activity(transport,
215
204
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
206
def show_error(self, msg):
224
207
self.clear_term()
225
208
self.stderr.write("bzr: error: %s\n" % msg)
230
213
def show_warning(self, msg):
231
214
self.clear_term()
232
if isinstance(msg, unicode):
233
te = osutils.get_terminal_encoding()
234
msg = msg.encode(te, 'replace')
235
215
self.stderr.write("bzr: warning: %s\n" % msg)
237
217
def _progress_updated(self, task):
241
221
warnings.warn("%r updated but no tasks are active" %
243
223
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]))
224
warnings.warn("%r is not the top progress task %r" %
225
(task, self._task_stack[-1]))
250
226
self._progress_view.show_progress(task)
252
228
def _progress_all_finished(self):
253
229
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
232
class TextProgressView(object):
269
233
"""Display of progress bar and other information on a tty.
284
248
self._term_file = term_file
285
249
# true when there's output on the screen we may need to clear
286
250
self._have_output = False
251
# XXX: We could listen for SIGWINCH and update the terminal width...
252
# https://launchpad.net/bugs/316357
253
self._width = osutils.terminal_width()
287
254
self._last_transport_msg = ''
288
255
self._spin_pos = 0
289
256
# time we last repainted the screen
293
260
self._last_task = None
294
261
self._total_byte_count = 0
295
262
self._bytes_since_update = 0
296
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
297
self._first_byte_time = None
298
263
self._fraction = 0
299
264
# force the progress bar to be off, as at the moment it doesn't
300
265
# correspond reliably to overall command progress
303
268
def _show_line(self, s):
304
269
# sys.stderr.write("progress %r\n" % s)
305
width = osutils.terminal_width()
306
if width is not None:
307
# we need one extra space for terminals that wrap on last char
309
s = '%-*.*s' % (width, width, s)
270
if self._width is not None:
272
s = '%-*.*s' % (n, n, s)
310
273
self._term_file.write('\r' + s + '\r')
339
302
markers = int(round(float(cols) * completion_fraction)) - 1
340
303
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
342
elif (self._last_task is None) or self._last_task.show_spinner:
305
elif self._last_task.show_spinner:
343
306
# The last task wanted just a spinner, no bar
344
307
spin_str = r'/-\|'[self._spin_pos % 4]
345
308
self._spin_pos += 1
407
370
This may update a progress bar, spinner, or similar display.
408
371
By default it does nothing.
410
# XXX: there should be a transport activity model, and that too should
411
# be seen by the progress view, rather than being poked in here.
373
# XXX: Probably there should be a transport activity model, and that
374
# too should be seen by the progress view, rather than being poked in
376
if not self._have_output:
377
# As a workaround for <https://launchpad.net/bugs/321935> we only
378
# show transport activity when there's already a progress bar
379
# shown, which time the application code is expected to know to
380
# clear off the progress bar when it's going to send some other
381
# output. Eventually it would be nice to have that automatically
412
384
self._total_byte_count += byte_count
413
385
self._bytes_since_update += byte_count
414
if self._first_byte_time is None:
415
# Note that this isn't great, as technically it should be the time
416
# when the bytes started transferring, not when they completed.
417
# However, we usually start with a small request anyway.
418
self._first_byte_time = time.time()
419
if direction in self._bytes_by_direction:
420
self._bytes_by_direction[direction] += byte_count
422
self._bytes_by_direction['unknown'] += byte_count
423
if 'no_activity' in debug.debug_flags:
424
# Can be used as a workaround if
425
# <https://launchpad.net/bugs/321935> reappears and transport
426
# activity is cluttering other output. However, thanks to
427
# TextUIOutputStream this shouldn't be a problem any more.
429
386
now = time.time()
430
387
if self._total_byte_count < 2000:
431
388
# a little resistance at first, so it doesn't stay stuck at 0
436
393
elif now >= (self._transport_update_time + 0.5):
437
394
# guard against clock stepping backwards, and don't update too
439
rate = (self._bytes_since_update
440
/ (now - self._transport_update_time))
441
# using base-10 units (see HACKING.txt).
442
msg = ("%6dkB %5dkB/s" %
443
(self._total_byte_count / 1000, int(rate) / 1000,))
396
rate = self._bytes_since_update / (now - self._transport_update_time)
397
msg = ("%6dKB %5dKB/s" %
398
(self._total_byte_count>>10, int(rate)>>10,))
444
399
self._transport_update_time = now
445
400
self._last_repaint = now
446
401
self._bytes_since_update = 0
447
402
self._last_transport_msg = msg
450
def _format_bytes_by_direction(self):
451
if self._first_byte_time is None:
454
transfer_time = time.time() - self._first_byte_time
455
if transfer_time < 0.001:
456
transfer_time = 0.001
457
bps = self._total_byte_count / transfer_time
459
# using base-10 units (see HACKING.txt).
460
msg = ('Transferred: %.0fkB'
461
' (%.1fkB/s r:%.0fkB w:%.0fkB'
462
% (self._total_byte_count / 1000.,
464
self._bytes_by_direction['read'] / 1000.,
465
self._bytes_by_direction['write'] / 1000.,
467
if self._bytes_by_direction['unknown'] > 0:
468
msg += ' u:%.0fkB)' % (
469
self._bytes_by_direction['unknown'] / 1000.
475
def log_transport_activity(self, display=False):
476
msg = self._format_bytes_by_direction()
478
if display and self._total_byte_count > 0:
480
self._term_file.write(msg + '\n')
483
406
class TextUIOutputStream(object):
484
407
"""Decorates an output stream so that the terminal is cleared before writing.
added
removed
bzrlib/ui/text.py
