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
60
self.stderr = stderr
63
61
# paints progress, network activity, etc
64
62
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
64
def clear_term(self):
75
65
"""Prepare the terminal for output.
156
146
def make_progress_view(self):
157
147
"""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':
149
# if the user specifically requests either text or no progress bars,
150
# always do that. otherwise, guess based on $TERM and tty presence.
151
if os.environ.get('BZR_PROGRESS_BAR') == 'text':
166
152
return TextProgressView(self.stderr)
167
153
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
168
154
return NullProgressView()
234
220
def show_warning(self, msg):
235
221
self.clear_term()
236
if isinstance(msg, unicode):
237
te = osutils.get_terminal_encoding()
238
msg = msg.encode(te, 'replace')
239
222
self.stderr.write("bzr: warning: %s\n" % msg)
241
224
def _progress_updated(self, task):
245
228
warnings.warn("%r updated but no tasks are active" %
247
230
elif task != self._task_stack[-1]:
248
# We used to check it was the top task, but it's hard to always
249
# get this right and it's not necessarily useful: any actual
250
# problems will be evident in use
251
#warnings.warn("%r is not the top progress task %r" %
252
# (task, self._task_stack[-1]))
231
warnings.warn("%r is not the top progress task %r" %
232
(task, self._task_stack[-1]))
254
233
self._progress_view.show_progress(task)
256
235
def _progress_all_finished(self):
257
236
self._progress_view.clear()
259
def show_user_warning(self, warning_id, **message_args):
260
"""Show a text message to the user.
262
Explicitly not for warnings about bzr apis, deprecations or internals.
264
# eventually trace.warning should migrate here, to avoid logging and
265
# be easier to test; that has a lot of test fallout so for now just
266
# new code can call this
267
if warning_id not in self.suppressed_warnings:
268
self.stderr.write(self.format_user_warning(warning_id, message_args) +
272
239
class TextProgressView(object):
273
240
"""Display of progress bar and other information on a tty.
343
310
markers = int(round(float(cols) * completion_fraction)) - 1
344
311
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
346
elif (self._last_task is None) or self._last_task.show_spinner:
313
elif self._last_task.show_spinner:
347
314
# The last task wanted just a spinner, no bar
348
315
spin_str = r'/-\|'[self._spin_pos % 4]
349
316
self._spin_pos += 1
411
378
This may update a progress bar, spinner, or similar display.
412
379
By default it does nothing.
414
# XXX: there should be a transport activity model, and that too should
415
# be seen by the progress view, rather than being poked in here.
381
# XXX: Probably there should be a transport activity model, and that
382
# too should be seen by the progress view, rather than being poked in
416
384
self._total_byte_count += byte_count
417
385
self._bytes_since_update += byte_count
418
386
if self._first_byte_time is None:
424
392
self._bytes_by_direction[direction] += byte_count
426
394
self._bytes_by_direction['unknown'] += byte_count
427
if 'no_activity' in debug.debug_flags:
428
# Can be used as a workaround if
429
# <https://launchpad.net/bugs/321935> reappears and transport
430
# activity is cluttering other output. However, thanks to
431
# TextUIOutputStream this shouldn't be a problem any more.
395
if not self._have_output:
396
# As a workaround for <https://launchpad.net/bugs/321935> we only
397
# show transport activity when there's already a progress bar
398
# shown, which time the application code is expected to know to
399
# clear off the progress bar when it's going to send some other
400
# output. Eventually it would be nice to have that automatically
433
403
now = time.time()
434
404
if self._total_byte_count < 2000:
440
410
elif now >= (self._transport_update_time + 0.5):
441
411
# guard against clock stepping backwards, and don't update too
443
rate = (self._bytes_since_update
444
/ (now - self._transport_update_time))
445
# using base-10 units (see HACKING.txt).
446
msg = ("%6dkB %5dkB/s" %
447
(self._total_byte_count / 1000, int(rate) / 1000,))
413
rate = self._bytes_since_update / (now - self._transport_update_time)
414
msg = ("%6dKB %5dKB/s" %
415
(self._total_byte_count>>10, int(rate)>>10,))
448
416
self._transport_update_time = now
449
417
self._last_repaint = now
450
418
self._bytes_since_update = 0
460
428
transfer_time = 0.001
461
429
bps = self._total_byte_count / transfer_time
463
# using base-10 units (see HACKING.txt).
464
msg = ('Transferred: %.0fkB'
465
' (%.1fkB/s r:%.0fkB w:%.0fkB'
466
% (self._total_byte_count / 1000.,
468
self._bytes_by_direction['read'] / 1000.,
469
self._bytes_by_direction['write'] / 1000.,
431
msg = ('Transferred: %.3fMiB'
432
' (%.1fKiB/s r:%.3fMiB w:%.3fMiB'
433
% (self._total_byte_count / 1024. / 1024.,
435
self._bytes_by_direction['read'] / 1024. / 1024.,
436
self._bytes_by_direction['write'] / 1024. / 1024.,
471
438
if self._bytes_by_direction['unknown'] > 0:
472
msg += ' u:%.0fkB)' % (
473
self._bytes_by_direction['unknown'] / 1000.
439
msg += ' u:%.3fMiB)' % (
440
self._bytes_by_direction['unknown'] / 1024. / 1024.
479
446
def log_transport_activity(self, display=False):
480
447
msg = self._format_bytes_by_direction()
481
448
trace.mutter(msg)
482
if display and self._total_byte_count > 0:
484
451
self._term_file.write(msg + '\n')
added
removed
bzrlib/ui/text.py
