1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Text UI, write output to the console.
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
40
from bzrlib.ui import (
46
class TextUIFactory(UIFactory):
47
"""A UI factory for Text user interefaces."""
53
"""Create a TextUIFactory.
55
super(TextUIFactory, self).__init__()
56
# TODO: there's no good reason not to pass all three streams, maybe we
57
# should deprecate the default values...
61
# paints progress, network activity, etc
62
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()
71
"""Prepare the terminal for output.
73
This will, clear any progress bars, and leave the cursor at the
75
# XXX: If this is preparing to write to stdout, but that's for example
76
# directed into a file rather than to the terminal, and the progress
77
# bar _is_ going to the terminal, we shouldn't need
78
# to clear it. We might need to separately check for the case of
79
self._progress_view.clear()
81
def get_boolean(self, prompt):
83
self.prompt(prompt + "? [y/n]: ")
84
line = self.stdin.readline().lower()
85
if line in ('y\n', 'yes\n'):
87
elif line in ('n\n', 'no\n'):
89
elif line in ('', None):
90
# end-of-file; possibly should raise an error here instead
93
def get_integer(self, prompt):
96
line = self.stdin.readline()
102
def get_non_echoed_password(self):
103
isatty = getattr(self.stdin, 'isatty', None)
104
if isatty is not None and isatty():
105
# getpass() ensure the password is not echoed and other
106
# cross-platform niceties
107
password = getpass.getpass('')
109
# echo doesn't make sense without a terminal
110
password = self.stdin.readline()
113
elif password[-1] == '\n':
114
password = password[:-1]
117
def get_password(self, prompt=u'', **kwargs):
118
"""Prompt the user for a password.
120
:param prompt: The prompt to present the user
121
:param kwargs: Arguments which will be expanded into the prompt.
122
This lets front ends display different things if
124
:return: The password string, return None if the user
125
canceled the request.
128
self.prompt(prompt, **kwargs)
129
# There's currently no way to say 'i decline to enter a password'
130
# as opposed to 'my password is empty' -- does it matter?
131
return self.get_non_echoed_password()
133
def get_username(self, prompt, **kwargs):
134
"""Prompt the user for a username.
136
:param prompt: The prompt to present the user
137
:param kwargs: Arguments which will be expanded into the prompt.
138
This lets front ends display different things if
140
:return: The username string, return None if the user
141
canceled the request.
144
self.prompt(prompt, **kwargs)
145
username = self.stdin.readline()
148
elif username[-1] == '\n':
149
username = username[:-1]
152
def make_progress_view(self):
153
"""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':
162
return TextProgressView(self.stderr)
163
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
164
return NullProgressView()
165
elif progress._supports_progress(self.stderr):
166
return TextProgressView(self.stderr)
168
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)
191
"""Write an already-formatted message, clearing the progress bar if necessary."""
193
self.stdout.write(msg + '\n')
195
def prompt(self, prompt, **kwargs):
196
"""Emit prompt on the CLI.
198
:param kwargs: Dictionary of arguments to insert into the prompt,
199
to allow UIs to reformat the prompt.
201
if type(prompt) != unicode:
202
raise ValueError("prompt %r not a unicode string" % prompt)
204
# See <https://launchpad.net/bugs/365891>
205
prompt = prompt % kwargs
206
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
208
self.stderr.write(prompt)
210
def report_transport_activity(self, transport, byte_count, direction):
211
"""Called by transports as they do IO.
213
This may update a progress bar, spinner, or similar display.
214
By default it does nothing.
216
self._progress_view.show_transport_activity(transport,
217
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
def _progress_updated(self, task):
240
"""A task has been updated and wants to be displayed.
242
if not self._task_stack:
243
warnings.warn("%r updated but no tasks are active" %
245
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]))
252
self._progress_view.show_progress(task)
254
def _progress_all_finished(self):
255
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
class TextProgressView(object):
271
"""Display of progress bar and other information on a tty.
273
This shows one line of text, including possibly a network indicator, spinner,
274
progress bar, message, etc.
276
One instance of this is created and held by the UI, and fed updates when a
277
task wants to be painted.
279
Transports feed data to this through the ui_factory object.
281
The Progress views can comprise a tree with _parent_task pointers, but
282
this only prints the stack from the nominated current task up to the root.
285
def __init__(self, term_file):
286
self._term_file = term_file
287
# true when there's output on the screen we may need to clear
288
self._have_output = False
289
self._last_transport_msg = ''
291
# time we last repainted the screen
292
self._last_repaint = 0
293
# time we last got information about transport activity
294
self._transport_update_time = 0
295
self._last_task = None
296
self._total_byte_count = 0
297
self._bytes_since_update = 0
298
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
299
self._first_byte_time = None
301
# force the progress bar to be off, as at the moment it doesn't
302
# correspond reliably to overall command progress
303
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
def _show_line(self, s):
314
# sys.stderr.write("progress %r\n" % s)
315
width = self._avail_width()
316
if width is not None:
317
s = '%-*.*s' % (width, width, s)
318
self._term_file.write('\r' + s + '\r')
321
if self._have_output:
323
self._have_output = False
325
def _render_bar(self):
326
# return a string for the progress bar itself
327
if self.enable_bar and (
328
(self._last_task is None) or self._last_task.show_bar):
329
# If there's no task object, we show space for the bar anyhow.
330
# That's because most invocations of bzr will end showing progress
331
# at some point, though perhaps only after doing some initial IO.
332
# It looks better to draw the progress bar initially rather than
333
# to have what looks like an incomplete progress bar.
334
spin_str = r'/-\|'[self._spin_pos % 4]
337
if self._last_task is None:
338
completion_fraction = 0
341
completion_fraction = \
342
self._last_task._overall_completion_fraction() or 0
343
if (completion_fraction < self._fraction and 'progress' in
345
import pdb;pdb.set_trace()
346
self._fraction = completion_fraction
347
markers = int(round(float(cols) * completion_fraction)) - 1
348
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
350
elif (self._last_task is None) or self._last_task.show_spinner:
351
# The last task wanted just a spinner, no bar
352
spin_str = r'/-\|'[self._spin_pos % 4]
354
return spin_str + ' '
358
def _format_task(self, task):
359
"""Format task-specific parts of progress bar.
361
:returns: (text_part, counter_part) both unicode strings.
363
if not task.show_count:
365
elif task.current_cnt is not None and task.total_cnt is not None:
366
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
367
elif task.current_cnt is not None:
368
s = ' %d' % (task.current_cnt)
371
# compose all the parent messages
374
while t._parent_task:
380
def _render_line(self):
381
bar_string = self._render_bar()
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:
413
s = self._render_line()
415
self._have_output = True
417
def show_progress(self, task):
418
"""Called by the task object when it has changed.
420
:param task: The top task object; its parents are also included
423
must_update = task is not self._last_task
424
self._last_task = task
426
if (not must_update) and (now < self._last_repaint + task.update_latency):
428
if now > self._transport_update_time + 10:
429
# no recent activity; expire it
430
self._last_transport_msg = ''
431
self._last_repaint = now
434
def show_transport_activity(self, transport, direction, byte_count):
435
"""Called by transports via the ui_factory, as they do IO.
437
This may update a progress bar, spinner, or similar display.
438
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.
442
self._total_byte_count += byte_count
443
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.
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
if self._transport_update_time is None:
465
self._transport_update_time = now
466
elif now >= (self._transport_update_time + 0.5):
467
# 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,))
474
self._transport_update_time = now
475
self._last_repaint = now
476
self._bytes_since_update = 0
477
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
