18
18
"""Text UI, write output to the console.
21
from __future__ import absolute_import
27
28
from bzrlib.lazy_import import lazy_import
28
29
lazy_import(globals(), """
33
30
from bzrlib import (
40
from bzrlib.osutils import watch_sigwinch
43
42
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,
165
48
class TextUIFactory(UIFactory):
166
"""A UI factory for Text user interfaces."""
49
"""A UI factory for Text user interefaces."""
168
51
def __init__(self,
179
62
self.stderr = stderr
180
63
# paints progress, network activity, etc
181
64
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()
65
# hook up the signals to watch for terminal size changes
204
68
def be_quiet(self, state):
205
69
if state and not self._quiet:
218
82
# to clear it. We might need to separately check for the case of
219
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
221
97
def get_integer(self, prompt):
223
99
self.prompt(prompt)
276
149
username = self.stdin.readline()
280
username = username.decode(self.stdin.encoding)
281
if username[-1] == '\n':
282
username = username[:-1]
152
elif username[-1] == '\n':
153
username = username[:-1]
285
156
def make_progress_view(self):
286
157
"""Construct and return a new ProgressView subclass for this UI.
288
159
# with --quiet, never any progress view
289
# <https://bugs.launchpad.net/bzr/+bug/320035>. Otherwise if the
160
# <https://bugs.edge.launchpad.net/bzr/+bug/320035>. Otherwise if the
290
161
# user specifically requests either text or no progress bars, always
291
162
# do that. otherwise, guess based on $TERM and tty presence.
292
163
if self.is_quiet():
293
164
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()
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()
303
174
def _make_output_stream_explicit(self, encoding, encoding_type):
304
175
if encoding_type == 'exact':
331
202
:param kwargs: Dictionary of arguments to insert into the prompt,
332
203
to allow UIs to reformat the prompt.
334
if type(prompt) != unicode:
335
raise ValueError("prompt %r not a unicode string" % prompt)
337
206
# See <https://launchpad.net/bugs/365891>
338
207
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')
208
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
346
209
self.clear_term()
348
210
self.stderr.write(prompt)
350
212
def report_transport_activity(self, transport, byte_count, direction):
394
253
def _progress_all_finished(self):
395
254
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
257
class TextProgressView(object):
411
258
"""Display of progress bar and other information on a tty.
422
269
this only prints the stack from the nominated current task up to the root.
425
def __init__(self, term_file, encoding=None, errors="replace"):
272
def __init__(self, term_file):
426
273
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
274
# true when there's output on the screen we may need to clear
433
275
self._have_output = False
434
276
self._last_transport_msg = ''
447
289
# correspond reliably to overall command progress
448
290
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()
292
def _show_line(self, s):
293
# sys.stderr.write("progress %r\n" % s)
294
width = osutils.terminal_width()
461
295
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.
296
# we need one extra space for terminals that wrap on last char
464
298
s = '%-*.*s' % (width, width, s)
465
299
self._term_file.write('\r' + s + '\r')
522
352
t = t._parent_task
524
354
m = t.msg + ':' + m
527
357
def _render_line(self):
528
358
bar_string = self._render_bar()
529
359
if self._last_task:
530
task_part, counter_part = self._format_task(self._last_task)
360
task_msg = self._format_task(self._last_task)
532
task_part = counter_part = ''
533
363
if self._last_task and not self._last_task.show_transport_activity:
536
366
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:
369
return (bar_string + trans + task_msg)
559
371
def _repaint(self):
560
372
s = self._render_line()
added
removed
bzrlib/ui/text.py
