1
# Copyright (C) 2005-2010 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.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
40
from bzrlib.osutils import watch_sigwinch
42
from bzrlib.ui import (
48
class TextUIFactory(UIFactory):
49
"""A UI factory for Text user interefaces."""
55
"""Create a TextUIFactory.
57
super(TextUIFactory, self).__init__()
58
# TODO: there's no good reason not to pass all three streams, maybe we
59
# should deprecate the default values...
63
# paints progress, network activity, etc
64
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()
75
"""Prepare the terminal for output.
77
This will, clear any progress bars, and leave the cursor at the
79
# XXX: If this is preparing to write to stdout, but that's for example
80
# directed into a file rather than to the terminal, and the progress
81
# bar _is_ going to the terminal, we shouldn't need
82
# to clear it. We might need to separately check for the case of
83
self._progress_view.clear()
85
def get_boolean(self, prompt):
87
self.prompt(prompt + "? [y/n]: ")
88
line = self.stdin.readline().lower()
89
if line in ('y\n', 'yes\n'):
91
elif line in ('n\n', 'no\n'):
93
elif line in ('', None):
94
# end-of-file; possibly should raise an error here instead
97
def get_integer(self, prompt):
100
line = self.stdin.readline()
106
def get_non_echoed_password(self):
107
isatty = getattr(self.stdin, 'isatty', None)
108
if isatty is not None and isatty():
109
# getpass() ensure the password is not echoed and other
110
# cross-platform niceties
111
password = getpass.getpass('')
113
# echo doesn't make sense without a terminal
114
password = self.stdin.readline()
117
elif password[-1] == '\n':
118
password = password[:-1]
121
def get_password(self, prompt='', **kwargs):
122
"""Prompt the user for a password.
124
:param prompt: The prompt to present the user
125
:param kwargs: Arguments which will be expanded into the prompt.
126
This lets front ends display different things if
128
:return: The password string, return None if the user
129
canceled the request.
132
self.prompt(prompt, **kwargs)
133
# There's currently no way to say 'i decline to enter a password'
134
# as opposed to 'my password is empty' -- does it matter?
135
return self.get_non_echoed_password()
137
def get_username(self, prompt, **kwargs):
138
"""Prompt the user for a username.
140
:param prompt: The prompt to present the user
141
:param kwargs: Arguments which will be expanded into the prompt.
142
This lets front ends display different things if
144
:return: The username string, return None if the user
145
canceled the request.
148
self.prompt(prompt, **kwargs)
149
username = self.stdin.readline()
152
elif username[-1] == '\n':
153
username = username[:-1]
156
def make_progress_view(self):
157
"""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':
166
return TextProgressView(self.stderr)
167
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
168
return NullProgressView()
169
elif progress._supports_progress(self.stderr):
170
return TextProgressView(self.stderr)
172
return NullProgressView()
174
def _make_output_stream_explicit(self, encoding, encoding_type):
175
if encoding_type == 'exact':
176
# force sys.stdout to be binary stream on win32;
177
# NB: this leaves the file set in that mode; may cause problems if
178
# one process tries to do binary and then text output
179
if sys.platform == 'win32':
180
fileno = getattr(self.stdout, 'fileno', None)
183
msvcrt.setmode(fileno(), os.O_BINARY)
184
return TextUIOutputStream(self, self.stdout)
186
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
187
errors=encoding_type)
188
# For whatever reason codecs.getwriter() does not advertise its encoding
189
# it just returns the encoding of the wrapped file, which is completely
190
# bogus. So set the attribute, so we can find the correct encoding later.
191
encoded_stdout.encoding = encoding
192
return TextUIOutputStream(self, encoded_stdout)
195
"""Write an already-formatted message, clearing the progress bar if necessary."""
197
self.stdout.write(msg + '\n')
199
def prompt(self, prompt, **kwargs):
200
"""Emit prompt on the CLI.
202
:param kwargs: Dictionary of arguments to insert into the prompt,
203
to allow UIs to reformat the prompt.
206
# See <https://launchpad.net/bugs/365891>
207
prompt = prompt % kwargs
208
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
210
self.stderr.write(prompt)
212
def report_transport_activity(self, transport, byte_count, direction):
213
"""Called by transports as they do IO.
215
This may update a progress bar, spinner, or similar display.
216
By default it does nothing.
218
self._progress_view.show_transport_activity(transport,
219
direction, byte_count)
221
def log_transport_activity(self, display=False):
222
"""See UIFactory.log_transport_activity()"""
223
log = getattr(self._progress_view, 'log_transport_activity', None)
227
def show_error(self, msg):
229
self.stderr.write("bzr: error: %s\n" % msg)
231
def show_message(self, msg):
234
def show_warning(self, msg):
236
self.stderr.write("bzr: warning: %s\n" % msg)
238
def _progress_updated(self, task):
239
"""A task has been updated and wants to be displayed.
241
if not self._task_stack:
242
warnings.warn("%r updated but no tasks are active" %
244
elif task != self._task_stack[-1]:
245
warnings.warn("%r is not the top progress task %r" %
246
(task, self._task_stack[-1]))
247
self._progress_view.show_progress(task)
249
def _progress_all_finished(self):
250
self._progress_view.clear()
252
def show_user_warning(self, warning_id, **message_args):
253
"""Show a text message to the user.
255
Explicitly not for warnings about bzr apis, deprecations or internals.
257
# eventually trace.warning should migrate here, to avoid logging and
258
# be easier to test; that has a lot of test fallout so for now just
259
# new code can call this
260
if warning_id not in self.suppressed_warnings:
261
self.stderr.write(self.format_user_warning(warning_id, message_args) +
265
class TextProgressView(object):
266
"""Display of progress bar and other information on a tty.
268
This shows one line of text, including possibly a network indicator, spinner,
269
progress bar, message, etc.
271
One instance of this is created and held by the UI, and fed updates when a
272
task wants to be painted.
274
Transports feed data to this through the ui_factory object.
276
The Progress views can comprise a tree with _parent_task pointers, but
277
this only prints the stack from the nominated current task up to the root.
280
def __init__(self, term_file):
281
self._term_file = term_file
282
# true when there's output on the screen we may need to clear
283
self._have_output = False
284
self._last_transport_msg = ''
286
# time we last repainted the screen
287
self._last_repaint = 0
288
# time we last got information about transport activity
289
self._transport_update_time = 0
290
self._last_task = None
291
self._total_byte_count = 0
292
self._bytes_since_update = 0
293
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
294
self._first_byte_time = None
296
# force the progress bar to be off, as at the moment it doesn't
297
# correspond reliably to overall command progress
298
self.enable_bar = False
300
def _show_line(self, s):
301
# sys.stderr.write("progress %r\n" % s)
302
width = osutils.terminal_width()
303
if width is not None:
304
# we need one extra space for terminals that wrap on last char
306
s = '%-*.*s' % (width, width, s)
307
self._term_file.write('\r' + s + '\r')
310
if self._have_output:
312
self._have_output = False
314
def _render_bar(self):
315
# return a string for the progress bar itself
316
if self.enable_bar and (
317
(self._last_task is None) or self._last_task.show_bar):
318
# If there's no task object, we show space for the bar anyhow.
319
# That's because most invocations of bzr will end showing progress
320
# at some point, though perhaps only after doing some initial IO.
321
# It looks better to draw the progress bar initially rather than
322
# to have what looks like an incomplete progress bar.
323
spin_str = r'/-\|'[self._spin_pos % 4]
326
if self._last_task is None:
327
completion_fraction = 0
330
completion_fraction = \
331
self._last_task._overall_completion_fraction() or 0
332
if (completion_fraction < self._fraction and 'progress' in
334
import pdb;pdb.set_trace()
335
self._fraction = completion_fraction
336
markers = int(round(float(cols) * completion_fraction)) - 1
337
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
339
elif (self._last_task is None) or self._last_task.show_spinner:
340
# The last task wanted just a spinner, no bar
341
spin_str = r'/-\|'[self._spin_pos % 4]
343
return spin_str + ' '
347
def _format_task(self, task):
348
if not task.show_count:
350
elif task.current_cnt is not None and task.total_cnt is not None:
351
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
352
elif task.current_cnt is not None:
353
s = ' %d' % (task.current_cnt)
356
# compose all the parent messages
359
while t._parent_task:
365
def _render_line(self):
366
bar_string = self._render_bar()
368
task_msg = self._format_task(self._last_task)
371
if self._last_task and not self._last_task.show_transport_activity:
374
trans = self._last_transport_msg
377
return (bar_string + trans + task_msg)
380
s = self._render_line()
382
self._have_output = True
384
def show_progress(self, task):
385
"""Called by the task object when it has changed.
387
:param task: The top task object; its parents are also included
390
must_update = task is not self._last_task
391
self._last_task = task
393
if (not must_update) and (now < self._last_repaint + task.update_latency):
395
if now > self._transport_update_time + 10:
396
# no recent activity; expire it
397
self._last_transport_msg = ''
398
self._last_repaint = now
401
def show_transport_activity(self, transport, direction, byte_count):
402
"""Called by transports via the ui_factory, as they do IO.
404
This may update a progress bar, spinner, or similar display.
405
By default it does nothing.
407
# XXX: there should be a transport activity model, and that too should
408
# be seen by the progress view, rather than being poked in here.
409
self._total_byte_count += byte_count
410
self._bytes_since_update += byte_count
411
if self._first_byte_time is None:
412
# Note that this isn't great, as technically it should be the time
413
# when the bytes started transferring, not when they completed.
414
# However, we usually start with a small request anyway.
415
self._first_byte_time = time.time()
416
if direction in self._bytes_by_direction:
417
self._bytes_by_direction[direction] += byte_count
419
self._bytes_by_direction['unknown'] += byte_count
420
if 'no_activity' in debug.debug_flags:
421
# Can be used as a workaround if
422
# <https://launchpad.net/bugs/321935> reappears and transport
423
# activity is cluttering other output. However, thanks to
424
# TextUIOutputStream this shouldn't be a problem any more.
427
if self._total_byte_count < 2000:
428
# a little resistance at first, so it doesn't stay stuck at 0
429
# while connecting...
431
if self._transport_update_time is None:
432
self._transport_update_time = now
433
elif now >= (self._transport_update_time + 0.5):
434
# guard against clock stepping backwards, and don't update too
436
rate = self._bytes_since_update / (now - self._transport_update_time)
437
msg = ("%6dKB %5dKB/s" %
438
(self._total_byte_count>>10, int(rate)>>10,))
439
self._transport_update_time = now
440
self._last_repaint = now
441
self._bytes_since_update = 0
442
self._last_transport_msg = msg
445
def _format_bytes_by_direction(self):
446
if self._first_byte_time is None:
449
transfer_time = time.time() - self._first_byte_time
450
if transfer_time < 0.001:
451
transfer_time = 0.001
452
bps = self._total_byte_count / transfer_time
454
msg = ('Transferred: %.0fKiB'
455
' (%.1fK/s r:%.0fK w:%.0fK'
456
% (self._total_byte_count / 1024.,
458
self._bytes_by_direction['read'] / 1024.,
459
self._bytes_by_direction['write'] / 1024.,
461
if self._bytes_by_direction['unknown'] > 0:
462
msg += ' u:%.0fK)' % (
463
self._bytes_by_direction['unknown'] / 1024.
469
def log_transport_activity(self, display=False):
470
msg = self._format_bytes_by_direction()
472
if display and self._total_byte_count > 0:
474
self._term_file.write(msg + '\n')
477
class TextUIOutputStream(object):
478
"""Decorates an output stream so that the terminal is cleared before writing.
480
This is supposed to ensure that the progress bar does not conflict with bulk
483
# XXX: this does not handle the case of writing part of a line, then doing
484
# progress bar output: the progress bar will probably write over it.
485
# one option is just to buffer that text until we have a full line;
486
# another is to save and restore it
488
# XXX: might need to wrap more methods
490
def __init__(self, ui_factory, wrapped_stream):
491
self.ui_factory = ui_factory
492
self.wrapped_stream = wrapped_stream
493
# this does no transcoding, but it must expose the underlying encoding
494
# because some callers need to know what can be written - see for
495
# example unescape_for_display.
496
self.encoding = getattr(wrapped_stream, 'encoding', None)
499
self.ui_factory.clear_term()
500
self.wrapped_stream.flush()
502
def write(self, to_write):
503
self.ui_factory.clear_term()
504
self.wrapped_stream.write(to_write)
506
def writelines(self, lines):
507
self.ui_factory.clear_term()
508
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
