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
# We used to check it was the top task, but it's hard to always
246
# get this right and it's not necessarily useful: any actual
247
# problems will be evident in use
248
#warnings.warn("%r is not the top progress task %r" %
249
# (task, self._task_stack[-1]))
251
self._progress_view.show_progress(task)
253
def _progress_all_finished(self):
254
self._progress_view.clear()
256
def show_user_warning(self, warning_id, **message_args):
257
"""Show a text message to the user.
259
Explicitly not for warnings about bzr apis, deprecations or internals.
261
# eventually trace.warning should migrate here, to avoid logging and
262
# be easier to test; that has a lot of test fallout so for now just
263
# new code can call this
264
if warning_id not in self.suppressed_warnings:
265
self.stderr.write(self.format_user_warning(warning_id, message_args) +
269
class TextProgressView(object):
270
"""Display of progress bar and other information on a tty.
272
This shows one line of text, including possibly a network indicator, spinner,
273
progress bar, message, etc.
275
One instance of this is created and held by the UI, and fed updates when a
276
task wants to be painted.
278
Transports feed data to this through the ui_factory object.
280
The Progress views can comprise a tree with _parent_task pointers, but
281
this only prints the stack from the nominated current task up to the root.
284
def __init__(self, term_file):
285
self._term_file = term_file
286
# true when there's output on the screen we may need to clear
287
self._have_output = False
288
self._last_transport_msg = ''
290
# time we last repainted the screen
291
self._last_repaint = 0
292
# time we last got information about transport activity
293
self._transport_update_time = 0
294
self._last_task = None
295
self._total_byte_count = 0
296
self._bytes_since_update = 0
297
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
298
self._first_byte_time = None
300
# force the progress bar to be off, as at the moment it doesn't
301
# correspond reliably to overall command progress
302
self.enable_bar = False
304
def _show_line(self, s):
305
# sys.stderr.write("progress %r\n" % s)
306
width = osutils.terminal_width()
307
if width is not None:
308
# we need one extra space for terminals that wrap on last char
310
s = '%-*.*s' % (width, width, s)
311
self._term_file.write('\r' + s + '\r')
314
if self._have_output:
316
self._have_output = False
318
def _render_bar(self):
319
# return a string for the progress bar itself
320
if self.enable_bar and (
321
(self._last_task is None) or self._last_task.show_bar):
322
# If there's no task object, we show space for the bar anyhow.
323
# That's because most invocations of bzr will end showing progress
324
# at some point, though perhaps only after doing some initial IO.
325
# It looks better to draw the progress bar initially rather than
326
# to have what looks like an incomplete progress bar.
327
spin_str = r'/-\|'[self._spin_pos % 4]
330
if self._last_task is None:
331
completion_fraction = 0
334
completion_fraction = \
335
self._last_task._overall_completion_fraction() or 0
336
if (completion_fraction < self._fraction and 'progress' in
338
import pdb;pdb.set_trace()
339
self._fraction = completion_fraction
340
markers = int(round(float(cols) * completion_fraction)) - 1
341
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
343
elif (self._last_task is None) or self._last_task.show_spinner:
344
# The last task wanted just a spinner, no bar
345
spin_str = r'/-\|'[self._spin_pos % 4]
347
return spin_str + ' '
351
def _format_task(self, task):
352
if not task.show_count:
354
elif task.current_cnt is not None and task.total_cnt is not None:
355
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
356
elif task.current_cnt is not None:
357
s = ' %d' % (task.current_cnt)
360
# compose all the parent messages
363
while t._parent_task:
369
def _render_line(self):
370
bar_string = self._render_bar()
372
task_msg = self._format_task(self._last_task)
375
if self._last_task and not self._last_task.show_transport_activity:
378
trans = self._last_transport_msg
381
return (bar_string + trans + task_msg)
384
s = self._render_line()
386
self._have_output = True
388
def show_progress(self, task):
389
"""Called by the task object when it has changed.
391
:param task: The top task object; its parents are also included
394
must_update = task is not self._last_task
395
self._last_task = task
397
if (not must_update) and (now < self._last_repaint + task.update_latency):
399
if now > self._transport_update_time + 10:
400
# no recent activity; expire it
401
self._last_transport_msg = ''
402
self._last_repaint = now
405
def show_transport_activity(self, transport, direction, byte_count):
406
"""Called by transports via the ui_factory, as they do IO.
408
This may update a progress bar, spinner, or similar display.
409
By default it does nothing.
411
# XXX: there should be a transport activity model, and that too should
412
# be seen by the progress view, rather than being poked in here.
413
self._total_byte_count += byte_count
414
self._bytes_since_update += byte_count
415
if self._first_byte_time is None:
416
# Note that this isn't great, as technically it should be the time
417
# when the bytes started transferring, not when they completed.
418
# However, we usually start with a small request anyway.
419
self._first_byte_time = time.time()
420
if direction in self._bytes_by_direction:
421
self._bytes_by_direction[direction] += byte_count
423
self._bytes_by_direction['unknown'] += byte_count
424
if 'no_activity' in debug.debug_flags:
425
# Can be used as a workaround if
426
# <https://launchpad.net/bugs/321935> reappears and transport
427
# activity is cluttering other output. However, thanks to
428
# TextUIOutputStream this shouldn't be a problem any more.
431
if self._total_byte_count < 2000:
432
# a little resistance at first, so it doesn't stay stuck at 0
433
# while connecting...
435
if self._transport_update_time is None:
436
self._transport_update_time = now
437
elif now >= (self._transport_update_time + 0.5):
438
# guard against clock stepping backwards, and don't update too
440
rate = (self._bytes_since_update
441
/ (now - self._transport_update_time))
442
# using base-10 units (see HACKING.txt).
443
msg = ("%6dkB %5dkB/s" %
444
(self._total_byte_count / 1000, int(rate) / 1000,))
445
self._transport_update_time = now
446
self._last_repaint = now
447
self._bytes_since_update = 0
448
self._last_transport_msg = msg
451
def _format_bytes_by_direction(self):
452
if self._first_byte_time is None:
455
transfer_time = time.time() - self._first_byte_time
456
if transfer_time < 0.001:
457
transfer_time = 0.001
458
bps = self._total_byte_count / transfer_time
460
# using base-10 units (see HACKING.txt).
461
msg = ('Transferred: %.0fkB'
462
' (%.1fkB/s r:%.0fkB w:%.0fkB'
463
% (self._total_byte_count / 1000.,
465
self._bytes_by_direction['read'] / 1000.,
466
self._bytes_by_direction['write'] / 1000.,
468
if self._bytes_by_direction['unknown'] > 0:
469
msg += ' u:%.0fkB)' % (
470
self._bytes_by_direction['unknown'] / 1000.
476
def log_transport_activity(self, display=False):
477
msg = self._format_bytes_by_direction()
479
if display and self._total_byte_count > 0:
481
self._term_file.write(msg + '\n')
484
class TextUIOutputStream(object):
485
"""Decorates an output stream so that the terminal is cleared before writing.
487
This is supposed to ensure that the progress bar does not conflict with bulk
490
# XXX: this does not handle the case of writing part of a line, then doing
491
# progress bar output: the progress bar will probably write over it.
492
# one option is just to buffer that text until we have a full line;
493
# another is to save and restore it
495
# XXX: might need to wrap more methods
497
def __init__(self, ui_factory, wrapped_stream):
498
self.ui_factory = ui_factory
499
self.wrapped_stream = wrapped_stream
500
# this does no transcoding, but it must expose the underlying encoding
501
# because some callers need to know what can be written - see for
502
# example unescape_for_display.
503
self.encoding = getattr(wrapped_stream, 'encoding', None)
506
self.ui_factory.clear_term()
507
self.wrapped_stream.flush()
509
def write(self, to_write):
510
self.ui_factory.clear_term()
511
self.wrapped_stream.write(to_write)
513
def writelines(self, lines):
514
self.ui_factory.clear_term()
515
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
