1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2011 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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
18
"""Text UI, write output to the console.
21
from __future__ import absolute_import
27
from bzrlib.lazy_import import lazy_import
28
lazy_import(globals(), """
25
import bzrlib.progress
26
from bzrlib.symbol_versioning import *
27
from bzrlib.ui import UIFactory
43
from bzrlib.ui import (
49
class _ChooseUI(object):
51
""" Helper class for choose implementation.
54
def __init__(self, ui, msg, choices, default):
57
self._build_alternatives(msg, choices, default)
59
def _setup_mode(self):
60
"""Setup input mode (line-based, char-based) and echo-back.
62
Line-based input is used if the BZR_TEXTUI_INPUT environment
63
variable is set to 'line-based', or if there is no controlling
66
if os.environ.get('BZR_TEXTUI_INPUT') != 'line-based' and \
67
self.ui.stdin == sys.stdin and self.ui.stdin.isatty():
68
self.line_based = False
71
self.line_based = True
72
self.echo_back = not self.ui.stdin.isatty()
74
def _build_alternatives(self, msg, choices, default):
75
"""Parse choices string.
77
Setup final prompt and the lists of choices and associated
82
self.alternatives = {}
83
choices = choices.split('\n')
84
if default is not None and default not in range(0, len(choices)):
85
raise ValueError("invalid default index")
87
name = c.replace('&', '').lower()
88
choice = (name, index)
89
if name in self.alternatives:
90
raise ValueError("duplicated choice: %s" % name)
91
self.alternatives[name] = choice
92
shortcut = c.find('&')
93
if -1 != shortcut and (shortcut + 1) < len(c):
95
help += '[' + c[shortcut + 1] + ']'
96
help += c[(shortcut + 2):]
97
shortcut = c[shortcut + 1]
99
c = c.replace('&', '')
101
help = '[%s]%s' % (shortcut, c[1:])
102
shortcut = shortcut.lower()
103
if shortcut in self.alternatives:
104
raise ValueError("duplicated shortcut: %s" % shortcut)
105
self.alternatives[shortcut] = choice
106
# Add redirections for default.
108
self.alternatives[''] = choice
109
self.alternatives['\r'] = choice
110
help_list.append(help)
113
self.prompt = u'%s (%s): ' % (msg, ', '.join(help_list))
116
line = self.ui.stdin.readline()
122
char = osutils.getchar()
123
if char == chr(3): # INTR
124
raise KeyboardInterrupt
125
if char == chr(4): # EOF (^d, C-d)
130
"""Keep asking the user until a valid choice is made.
133
getchoice = self._getline
135
getchoice = self._getchar
139
if 1 == iter or self.line_based:
140
self.ui.prompt(self.prompt)
144
self.ui.stderr.write('\n')
146
except KeyboardInterrupt:
147
self.ui.stderr.write('\n')
148
raise KeyboardInterrupt
149
choice = choice.lower()
150
if choice not in self.alternatives:
151
# Not a valid choice, keep on asking.
153
name, index = self.alternatives[choice]
155
self.ui.stderr.write(name + '\n')
159
opt_progress_bar = config.Option(
160
'progress_bar', help='Progress bar type.',
161
default_from_env=['BZR_PROGRESS_BAR'], default=None,
30
165
class TextUIFactory(UIFactory):
31
"""A UI factory for Text user interefaces."""
166
"""A UI factory for Text user interfaces."""
33
def __init__(self, bar_type=None):
34
172
"""Create a TextUIFactory.
36
:param bar_type: The type of progress bar to create. It defaults to
37
letting the bzrlib.progress.ProgressBar factory auto
40
174
super(TextUIFactory, self).__init__()
41
self._bar_type = bar_type
43
@deprecated_method(zero_eight)
44
def progress_bar(self):
45
"""See UIFactory.nested_progress_bar()."""
46
# this in turn is abstract, and creates either a tty or dots
47
# bar depending on what we think of the terminal
48
return bzrlib.progress.ProgressBar()
50
def get_password(self, prompt='', **kwargs):
51
"""Prompt the user for a password.
53
:param prompt: The prompt to present the user
54
:param kwargs: Arguments which will be expanded into the prompt.
55
This lets front ends display different things if
57
:return: The password string, return None if the user
60
prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
63
return getpass.getpass(prompt)
64
except KeyboardInterrupt:
67
def nested_progress_bar(self):
68
"""Return a nested progress bar.
70
The actual bar type returned depends on the progress module which
71
may return a tty or dots bar depending on the terminal.
73
if self._progress_bar_stack is None:
74
self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
76
return self._progress_bar_stack.get_nested()
175
# TODO: there's no good reason not to pass all three streams, maybe we
176
# should deprecate the default values...
180
# paints progress, network activity, etc
181
self._progress_view = self.make_progress_view()
183
def choose(self, msg, choices, default=None):
184
"""Prompt the user for a list of alternatives.
186
Support both line-based and char-based editing.
188
In line-based mode, both the shortcut and full choice name are valid
189
answers, e.g. for choose('prompt', '&yes\n&no'): 'y', ' Y ', ' yes',
190
'YES ' are all valid input lines for choosing 'yes'.
192
An empty line, when in line-based mode, or pressing enter in char-based
193
mode will select the default choice (if any).
195
Choice is echoed back if:
196
- input is char-based; which means a controlling terminal is available,
197
and osutils.getchar is used
198
- input is line-based, and no controlling terminal is available
201
choose_ui = _ChooseUI(self, msg, choices, default)
202
return choose_ui.interact()
204
def be_quiet(self, state):
205
if state and not self._quiet:
207
UIFactory.be_quiet(self, state)
208
self._progress_view = self.make_progress_view()
78
210
def clear_term(self):
79
211
"""Prepare the terminal for output.
81
213
This will, clear any progress bars, and leave the cursor at the
82
214
leftmost position."""
83
if self._progress_bar_stack is None:
85
overall_pb = self._progress_bar_stack.bottom()
86
if overall_pb is not None:
215
# XXX: If this is preparing to write to stdout, but that's for example
216
# directed into a file rather than to the terminal, and the progress
217
# bar _is_ going to the terminal, we shouldn't need
218
# to clear it. We might need to separately check for the case of
219
self._progress_view.clear()
221
def get_integer(self, prompt):
224
line = self.stdin.readline()
230
def get_non_echoed_password(self):
231
isatty = getattr(self.stdin, 'isatty', None)
232
if isatty is not None and isatty():
233
# getpass() ensure the password is not echoed and other
234
# cross-platform niceties
235
password = getpass.getpass('')
237
# echo doesn't make sense without a terminal
238
password = self.stdin.readline()
242
password = password.decode(self.stdin.encoding)
244
if password[-1] == '\n':
245
password = password[:-1]
248
def get_password(self, prompt=u'', **kwargs):
249
"""Prompt the user for a password.
251
:param prompt: The prompt to present the user
252
:param kwargs: Arguments which will be expanded into the prompt.
253
This lets front ends display different things if
255
:return: The password string, return None if the user
256
canceled the request.
259
self.prompt(prompt, **kwargs)
260
# There's currently no way to say 'i decline to enter a password'
261
# as opposed to 'my password is empty' -- does it matter?
262
return self.get_non_echoed_password()
264
def get_username(self, prompt, **kwargs):
265
"""Prompt the user for a username.
267
:param prompt: The prompt to present the user
268
:param kwargs: Arguments which will be expanded into the prompt.
269
This lets front ends display different things if
271
:return: The username string, return None if the user
272
canceled the request.
275
self.prompt(prompt, **kwargs)
276
username = self.stdin.readline()
280
username = username.decode(self.stdin.encoding)
281
if username[-1] == '\n':
282
username = username[:-1]
285
def make_progress_view(self):
286
"""Construct and return a new ProgressView subclass for this UI.
288
# with --quiet, never any progress view
289
# <https://bugs.launchpad.net/bzr/+bug/320035>. Otherwise if the
290
# user specifically requests either text or no progress bars, always
291
# do that. otherwise, guess based on $TERM and tty presence.
293
return NullProgressView()
294
pb_type = config.GlobalStack().get('progress_bar')
295
if pb_type == 'none': # Explicit requirement
296
return NullProgressView()
297
if (pb_type == 'text' # Explicit requirement
298
or progress._supports_progress(self.stderr)): # Guess
299
return TextProgressView(self.stderr)
300
# No explicit requirement and no successful guess
301
return NullProgressView()
303
def _make_output_stream_explicit(self, encoding, encoding_type):
304
if encoding_type == 'exact':
305
# force sys.stdout to be binary stream on win32;
306
# NB: this leaves the file set in that mode; may cause problems if
307
# one process tries to do binary and then text output
308
if sys.platform == 'win32':
309
fileno = getattr(self.stdout, 'fileno', None)
312
msvcrt.setmode(fileno(), os.O_BINARY)
313
return TextUIOutputStream(self, self.stdout)
315
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
316
errors=encoding_type)
317
# For whatever reason codecs.getwriter() does not advertise its encoding
318
# it just returns the encoding of the wrapped file, which is completely
319
# bogus. So set the attribute, so we can find the correct encoding later.
320
encoded_stdout.encoding = encoding
321
return TextUIOutputStream(self, encoded_stdout)
324
"""Write an already-formatted message, clearing the progress bar if necessary."""
326
self.stdout.write(msg + '\n')
328
def prompt(self, prompt, **kwargs):
329
"""Emit prompt on the CLI.
331
:param kwargs: Dictionary of arguments to insert into the prompt,
332
to allow UIs to reformat the prompt.
334
if type(prompt) != unicode:
335
raise ValueError("prompt %r not a unicode string" % prompt)
337
# See <https://launchpad.net/bugs/365891>
338
prompt = prompt % kwargs
340
prompt = prompt.encode(self.stderr.encoding)
341
except (UnicodeError, AttributeError):
342
# If stderr has no encoding attribute or can't properly encode,
343
# fallback to terminal encoding for robustness (better display
344
# something to the user than aborting with a traceback).
345
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
348
self.stderr.write(prompt)
350
def report_transport_activity(self, transport, byte_count, direction):
351
"""Called by transports as they do IO.
353
This may update a progress bar, spinner, or similar display.
354
By default it does nothing.
356
self._progress_view.show_transport_activity(transport,
357
direction, byte_count)
359
def log_transport_activity(self, display=False):
360
"""See UIFactory.log_transport_activity()"""
361
log = getattr(self._progress_view, 'log_transport_activity', None)
365
def show_error(self, msg):
367
self.stderr.write("bzr: error: %s\n" % msg)
369
def show_message(self, msg):
372
def show_warning(self, msg):
374
if isinstance(msg, unicode):
375
te = osutils.get_terminal_encoding()
376
msg = msg.encode(te, 'replace')
377
self.stderr.write("bzr: warning: %s\n" % msg)
379
def _progress_updated(self, task):
380
"""A task has been updated and wants to be displayed.
382
if not self._task_stack:
383
warnings.warn("%r updated but no tasks are active" %
385
elif task != self._task_stack[-1]:
386
# We used to check it was the top task, but it's hard to always
387
# get this right and it's not necessarily useful: any actual
388
# problems will be evident in use
389
#warnings.warn("%r is not the top progress task %r" %
390
# (task, self._task_stack[-1]))
392
self._progress_view.show_progress(task)
394
def _progress_all_finished(self):
395
self._progress_view.clear()
397
def show_user_warning(self, warning_id, **message_args):
398
"""Show a text message to the user.
400
Explicitly not for warnings about bzr apis, deprecations or internals.
402
# eventually trace.warning should migrate here, to avoid logging and
403
# be easier to test; that has a lot of test fallout so for now just
404
# new code can call this
405
if warning_id not in self.suppressed_warnings:
406
self.stderr.write(self.format_user_warning(warning_id, message_args) +
410
class TextProgressView(object):
411
"""Display of progress bar and other information on a tty.
413
This shows one line of text, including possibly a network indicator, spinner,
414
progress bar, message, etc.
416
One instance of this is created and held by the UI, and fed updates when a
417
task wants to be painted.
419
Transports feed data to this through the ui_factory object.
421
The Progress views can comprise a tree with _parent_task pointers, but
422
this only prints the stack from the nominated current task up to the root.
425
def __init__(self, term_file, encoding=None, errors="replace"):
426
self._term_file = term_file
428
self._encoding = getattr(term_file, "encoding", None) or "ascii"
430
self._encoding = encoding
431
self._encoding_errors = errors
432
# true when there's output on the screen we may need to clear
433
self._have_output = False
434
self._last_transport_msg = ''
436
# time we last repainted the screen
437
self._last_repaint = 0
438
# time we last got information about transport activity
439
self._transport_update_time = 0
440
self._last_task = None
441
self._total_byte_count = 0
442
self._bytes_since_update = 0
443
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
444
self._first_byte_time = None
446
# force the progress bar to be off, as at the moment it doesn't
447
# correspond reliably to overall command progress
448
self.enable_bar = False
450
def _avail_width(self):
451
# we need one extra space for terminals that wrap on last char
452
w = osutils.terminal_width()
458
def _show_line(self, u):
459
s = u.encode(self._encoding, self._encoding_errors)
460
width = self._avail_width()
461
if width is not None:
462
# GZ 2012-03-28: Counting bytes is wrong for calculating width of
463
# text but better than counting codepoints.
464
s = '%-*.*s' % (width, width, s)
465
self._term_file.write('\r' + s + '\r')
468
if self._have_output:
470
self._have_output = False
472
def _render_bar(self):
473
# return a string for the progress bar itself
474
if self.enable_bar and (
475
(self._last_task is None) or self._last_task.show_bar):
476
# If there's no task object, we show space for the bar anyhow.
477
# That's because most invocations of bzr will end showing progress
478
# at some point, though perhaps only after doing some initial IO.
479
# It looks better to draw the progress bar initially rather than
480
# to have what looks like an incomplete progress bar.
481
spin_str = r'/-\|'[self._spin_pos % 4]
484
if self._last_task is None:
485
completion_fraction = 0
488
completion_fraction = \
489
self._last_task._overall_completion_fraction() or 0
490
if (completion_fraction < self._fraction and 'progress' in
492
import pdb;pdb.set_trace()
493
self._fraction = completion_fraction
494
markers = int(round(float(cols) * completion_fraction)) - 1
495
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
497
elif (self._last_task is None) or self._last_task.show_spinner:
498
# The last task wanted just a spinner, no bar
499
spin_str = r'/-\|'[self._spin_pos % 4]
501
return spin_str + ' '
505
def _format_task(self, task):
506
"""Format task-specific parts of progress bar.
508
:returns: (text_part, counter_part) both unicode strings.
510
if not task.show_count:
512
elif task.current_cnt is not None and task.total_cnt is not None:
513
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
514
elif task.current_cnt is not None:
515
s = ' %d' % (task.current_cnt)
518
# compose all the parent messages
521
while t._parent_task:
527
def _render_line(self):
528
bar_string = self._render_bar()
530
task_part, counter_part = self._format_task(self._last_task)
532
task_part = counter_part = ''
533
if self._last_task and not self._last_task.show_transport_activity:
536
trans = self._last_transport_msg
537
# the bar separates the transport activity from the message, so even
538
# if there's no bar or spinner, we must show something if both those
540
if (task_part or trans) and not bar_string:
542
# preferentially truncate the task message if we don't have enough
544
avail_width = self._avail_width()
545
if avail_width is not None:
546
# if terminal avail_width is unknown, don't truncate
547
current_len = len(bar_string) + len(trans) + len(task_part) + len(counter_part)
548
gap = current_len - avail_width
550
task_part = task_part[:-gap-2] + '..'
551
s = trans + bar_string + task_part + counter_part
552
if avail_width is not None:
553
if len(s) < avail_width:
554
s = s.ljust(avail_width)
555
elif len(s) > avail_width:
560
s = self._render_line()
562
self._have_output = True
564
def show_progress(self, task):
565
"""Called by the task object when it has changed.
567
:param task: The top task object; its parents are also included
570
must_update = task is not self._last_task
571
self._last_task = task
573
if (not must_update) and (now < self._last_repaint + task.update_latency):
575
if now > self._transport_update_time + 10:
576
# no recent activity; expire it
577
self._last_transport_msg = ''
578
self._last_repaint = now
581
def show_transport_activity(self, transport, direction, byte_count):
582
"""Called by transports via the ui_factory, as they do IO.
584
This may update a progress bar, spinner, or similar display.
585
By default it does nothing.
587
# XXX: there should be a transport activity model, and that too should
588
# be seen by the progress view, rather than being poked in here.
589
self._total_byte_count += byte_count
590
self._bytes_since_update += byte_count
591
if self._first_byte_time is None:
592
# Note that this isn't great, as technically it should be the time
593
# when the bytes started transferring, not when they completed.
594
# However, we usually start with a small request anyway.
595
self._first_byte_time = time.time()
596
if direction in self._bytes_by_direction:
597
self._bytes_by_direction[direction] += byte_count
599
self._bytes_by_direction['unknown'] += byte_count
600
if 'no_activity' in debug.debug_flags:
601
# Can be used as a workaround if
602
# <https://launchpad.net/bugs/321935> reappears and transport
603
# activity is cluttering other output. However, thanks to
604
# TextUIOutputStream this shouldn't be a problem any more.
607
if self._total_byte_count < 2000:
608
# a little resistance at first, so it doesn't stay stuck at 0
609
# while connecting...
611
if self._transport_update_time is None:
612
self._transport_update_time = now
613
elif now >= (self._transport_update_time + 0.5):
614
# guard against clock stepping backwards, and don't update too
616
rate = (self._bytes_since_update
617
/ (now - self._transport_update_time))
618
# using base-10 units (see HACKING.txt).
619
msg = ("%6dkB %5dkB/s " %
620
(self._total_byte_count / 1000, int(rate) / 1000,))
621
self._transport_update_time = now
622
self._last_repaint = now
623
self._bytes_since_update = 0
624
self._last_transport_msg = msg
627
def _format_bytes_by_direction(self):
628
if self._first_byte_time is None:
631
transfer_time = time.time() - self._first_byte_time
632
if transfer_time < 0.001:
633
transfer_time = 0.001
634
bps = self._total_byte_count / transfer_time
636
# using base-10 units (see HACKING.txt).
637
msg = ('Transferred: %.0fkB'
638
' (%.1fkB/s r:%.0fkB w:%.0fkB'
639
% (self._total_byte_count / 1000.,
641
self._bytes_by_direction['read'] / 1000.,
642
self._bytes_by_direction['write'] / 1000.,
644
if self._bytes_by_direction['unknown'] > 0:
645
msg += ' u:%.0fkB)' % (
646
self._bytes_by_direction['unknown'] / 1000.
652
def log_transport_activity(self, display=False):
653
msg = self._format_bytes_by_direction()
655
if display and self._total_byte_count > 0:
657
self._term_file.write(msg + '\n')
660
class TextUIOutputStream(object):
661
"""Decorates an output stream so that the terminal is cleared before writing.
663
This is supposed to ensure that the progress bar does not conflict with bulk
666
# XXX: this does not handle the case of writing part of a line, then doing
667
# progress bar output: the progress bar will probably write over it.
668
# one option is just to buffer that text until we have a full line;
669
# another is to save and restore it
671
# XXX: might need to wrap more methods
673
def __init__(self, ui_factory, wrapped_stream):
674
self.ui_factory = ui_factory
675
self.wrapped_stream = wrapped_stream
676
# this does no transcoding, but it must expose the underlying encoding
677
# because some callers need to know what can be written - see for
678
# example unescape_for_display.
679
self.encoding = getattr(wrapped_stream, 'encoding', None)
682
self.ui_factory.clear_term()
683
self.wrapped_stream.flush()
685
def write(self, to_write):
686
self.ui_factory.clear_term()
687
self.wrapped_stream.write(to_write)
689
def writelines(self, lines):
690
self.ui_factory.clear_term()
691
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
