1
# Copyright (C) 2005-2011 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.
114
107
password = password[:-1]
117
def get_password(self, prompt=u'', **kwargs):
110
def get_password(self, prompt='', **kwargs):
118
111
"""Prompt the user for a password.
120
113
:param prompt: The prompt to present the user
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()
198
187
:param kwargs: Dictionary of arguments to insert into the prompt,
199
188
to allow UIs to reformat the prompt.
201
if type(prompt) != unicode:
202
raise ValueError("prompt %r not a unicode string" % prompt)
204
191
# See <https://launchpad.net/bugs/365891>
205
192
prompt = prompt % kwargs
216
203
self._progress_view.show_transport_activity(transport,
217
204
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
206
def show_error(self, msg):
226
207
self.clear_term()
227
208
self.stderr.write("bzr: error: %s\n" % msg)
232
213
def show_warning(self, msg):
233
214
self.clear_term()
234
if isinstance(msg, unicode):
235
te = osutils.get_terminal_encoding()
236
msg = msg.encode(te, 'replace')
237
215
self.stderr.write("bzr: warning: %s\n" % msg)
239
217
def _progress_updated(self, task):
243
221
warnings.warn("%r updated but no tasks are active" %
245
223
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]))
224
warnings.warn("%r is not the top progress task %r" %
225
(task, self._task_stack[-1]))
252
226
self._progress_view.show_progress(task)
254
228
def _progress_all_finished(self):
255
229
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
232
class TextProgressView(object):
271
233
"""Display of progress bar and other information on a tty.
286
248
self._term_file = term_file
287
249
# true when there's output on the screen we may need to clear
288
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()
289
254
self._last_transport_msg = ''
290
255
self._spin_pos = 0
291
256
# time we last repainted the screen
295
260
self._last_task = None
296
261
self._total_byte_count = 0
297
262
self._bytes_since_update = 0
298
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
299
self._first_byte_time = None
300
263
self._fraction = 0
301
264
# force the progress bar to be off, as at the moment it doesn't
302
265
# correspond reliably to overall command progress
303
266
self.enable_bar = False
305
def _avail_width(self):
306
# we need one extra space for terminals that wrap on last char
307
w = osutils.terminal_width()
313
268
def _show_line(self, s):
314
269
# sys.stderr.write("progress %r\n" % s)
315
width = self._avail_width()
316
if width is not None:
317
s = '%-*.*s' % (width, width, s)
270
if self._width is not None:
272
s = '%-*.*s' % (n, n, s)
318
273
self._term_file.write('\r' + s + '\r')
347
302
markers = int(round(float(cols) * completion_fraction)) - 1
348
303
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
350
elif (self._last_task is None) or self._last_task.show_spinner:
305
elif self._last_task.show_spinner:
351
306
# The last task wanted just a spinner, no bar
352
307
spin_str = r'/-\|'[self._spin_pos % 4]
353
308
self._spin_pos += 1
358
313
def _format_task(self, task):
359
"""Format task-specific parts of progress bar.
361
:returns: (text_part, counter_part) both unicode strings.
363
314
if not task.show_count:
365
316
elif task.current_cnt is not None and task.total_cnt is not None:
375
326
t = t._parent_task
377
328
m = t.msg + ':' + m
380
331
def _render_line(self):
381
332
bar_string = self._render_bar()
382
333
if self._last_task:
383
task_part, counter_part = self._format_task(self._last_task)
334
task_msg = self._format_task(self._last_task)
385
task_part = counter_part = ''
386
337
if self._last_task and not self._last_task.show_transport_activity:
389
340
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:
343
return (bar_string + trans + task_msg)
412
345
def _repaint(self):
413
346
s = self._render_line()
437
370
This may update a progress bar, spinner, or similar display.
438
371
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.
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
442
384
self._total_byte_count += byte_count
443
385
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
386
now = time.time()
460
387
if self._total_byte_count < 2000:
461
388
# a little resistance at first, so it doesn't stay stuck at 0
466
393
elif now >= (self._transport_update_time + 0.5):
467
394
# 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,))
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,))
474
399
self._transport_update_time = now
475
400
self._last_repaint = now
476
401
self._bytes_since_update = 0
477
402
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
406
class TextUIOutputStream(object):
514
407
"""Decorates an output stream so that the terminal is cleared before writing.
added
removed
bzrlib/ui/text.py
