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
17
"""Abstraction for interacting with the user.
19
Applications can choose different types of UI, and they deal with displaying
20
messages or progress to the user, and with gathering different types of input.
22
Several levels are supported, and you can also register new factories such as
26
Semi-abstract base class
28
bzrlib.ui.SilentUIFactory
29
Produces no output and cannot take any input; useful for programs using
30
bzrlib in batch mode or for programs such as loggerhead.
32
bzrlib.ui.CannedInputUIFactory
33
For use in testing; the input values to be returned are provided
36
bzrlib.ui.text.TextUIFactory
37
Standard text command-line interface, with stdin, stdout, stderr.
38
May make more or less advanced use of them, eg in drawing progress bars,
39
depending on the detected capabilities of the terminal.
40
GUIs may choose to subclass this so that unimplemented methods fall
41
back to working through the terminal.
47
from bzrlib.lazy_import import lazy_import
48
lazy_import(globals(), """
58
_valid_boolean_strings = dict(yes=True, no=False,
61
true=True, false=False)
62
_valid_boolean_strings['1'] = True
63
_valid_boolean_strings['0'] = False
66
def bool_from_string(s, accepted_values=None):
67
"""Returns a boolean if the string can be interpreted as such.
69
Interpret case insensitive strings as booleans. The default values
70
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
71
'off'. Alternative values can be provided with the 'accepted_values'
74
:param s: A string that should be interpreted as a boolean. It should be of
75
type string or unicode.
77
:param accepted_values: An optional dict with accepted strings as keys and
78
True/False as values. The strings will be tested against a lowered
81
:return: True or False for accepted strings, None otherwise.
83
if accepted_values is None:
84
accepted_values = _valid_boolean_strings
86
if type(s) in (str, unicode):
88
val = accepted_values[s.lower()]
94
class ConfirmationUserInterfacePolicy(object):
95
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
97
def __init__(self, wrapped_ui, default_answer, specific_answers):
98
"""Generate a proxy UI that does no confirmations.
100
:param wrapped_ui: Underlying UIFactory.
101
:param default_answer: Bool for whether requests for
102
confirmation from the user should be noninteractively accepted or
104
:param specific_answers: Map from confirmation_id to bool answer.
106
self.wrapped_ui = wrapped_ui
107
self.default_answer = default_answer
108
self.specific_answers = specific_answers
110
def __getattr__(self, name):
111
return getattr(self.wrapped_ui, name)
114
return '%s(%r, %r, %r)' % (
115
self.__class__.__name__,
118
self.specific_answers)
120
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
121
if confirmation_id in self.specific_answers:
122
return self.specific_answers[confirmation_id]
123
elif self.default_answer is not None:
124
return self.default_answer
126
return self.wrapped_ui.confirm_action(
127
prompt, confirmation_id, prompt_kwargs)
130
class UIFactory(object):
133
This tells the library how to display things to the user. Through this
134
layer different applications can choose the style of UI.
136
UI Factories are also context managers, for some syntactic sugar some users
139
:ivar suppressed_warnings: Identifiers for user warnings that should
143
_user_warning_templates = dict(
144
cross_format_fetch=("Doing on-the-fly conversion from "
145
"%(from_format)s to %(to_format)s.\n"
146
"This may take some time. Upgrade the repositories to the "
147
"same format for better performance."
149
experimental_format_fetch=("Fetching into experimental format "
151
"This format may be unreliable or change in the future "
152
"without an upgrade path.\n"),
154
"The command 'bzr %(deprecated_name)s' "
155
"has been deprecated in bzr %(deprecated_in_version)s. "
156
"Please use 'bzr %(recommended_name)s' instead."),
157
deprecated_command_option=(
158
"The option '%(deprecated_name)s' to 'bzr %(command)s' "
159
"has been deprecated in bzr %(deprecated_in_version)s. "
160
"Please use '%(recommended_name)s' instead."),
161
recommend_upgrade=("%(current_format_name)s is deprecated "
162
"and a better format is available.\n"
163
"It is recommended that you upgrade by "
164
"running the command\n"
165
" bzr upgrade %(basedir)s"),
167
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
171
self._task_stack = []
172
self.suppressed_warnings = set()
176
"""Context manager entry support.
178
Override in a concrete factory class if initialisation before use is
181
return self # This is bound to the 'as' clause in a with statement.
183
def __exit__(self, exc_type, exc_val, exc_tb):
184
"""Context manager exit support.
186
Override in a concrete factory class if more cleanup than a simple
187
self.clear_term() is needed when the UIFactory is finished with.
190
return False # propogate exceptions.
192
def be_quiet(self, state):
193
"""Tell the UI to be more quiet, or not.
195
Typically this suppresses progress bars; the application may also look
196
at ui_factory.is_quiet().
200
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
201
"""Seek user confirmation for an action.
203
If the UI is noninteractive, or the user does not want to be asked
204
about this action, True is returned, indicating bzr should just
207
The confirmation id allows the user to configure certain actions to
208
always be confirmed or always denied, and for UIs to specialize the
209
display of particular confirmations.
211
:param prompt: Suggested text to display to the user.
212
:param prompt_kwargs: A dictionary of arguments that can be
213
string-interpolated into the prompt.
214
:param confirmation_id: Unique string identifier for the confirmation.
216
return self.get_boolean(prompt % prompt_kwargs)
218
def get_password(self, prompt=u'', **kwargs):
219
"""Prompt the user for a password.
221
:param prompt: The prompt to present the user (must be unicode)
222
:param kwargs: Arguments which will be expanded into the prompt.
223
This lets front ends display different things if
226
:return: The password string, return None if the user canceled the
227
request. Note that we do not touch the encoding, users may
228
have whatever they see fit and the password should be
231
raise NotImplementedError(self.get_password)
236
def make_output_stream(self, encoding=None, encoding_type=None):
237
"""Get a stream for sending out bulk text data.
239
This is used for commands that produce bulk text, such as log or diff
240
output, as opposed to user interaction. This should work even for
241
non-interactive user interfaces. Typically this goes to a decorated
242
version of stdout, but in a GUI it might be appropriate to send it to a
243
window displaying the text.
245
:param encoding: Unicode encoding for output; if not specified
246
uses the configured 'output_encoding' if any; otherwise the
248
(See get_terminal_encoding.)
250
:param encoding_type: How to handle encoding errors:
251
replace/strict/escape/exact. Default is replace.
253
# XXX: is the caller supposed to close the resulting object?
255
encoding = config.GlobalStack().get('output_encoding')
257
encoding = osutils.get_terminal_encoding(trace=True)
258
if encoding_type is None:
259
encoding_type = 'replace'
260
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
263
def _make_output_stream_explicit(self, encoding, encoding_type):
264
raise NotImplementedError("%s doesn't support make_output_stream"
265
% (self.__class__.__name__))
267
def nested_progress_bar(self):
268
"""Return a nested progress bar.
270
When the bar has been finished with, it should be released by calling
274
t = progress.ProgressTask(self._task_stack[-1], self)
276
t = progress.ProgressTask(None, self)
277
self._task_stack.append(t)
280
def _progress_finished(self, task):
281
"""Called by the ProgressTask when it finishes"""
282
if not self._task_stack:
283
warnings.warn("%r finished but nothing is active"
285
if task in self._task_stack:
286
self._task_stack.remove(task)
288
warnings.warn("%r is not in active stack %r"
289
% (task, self._task_stack))
290
if not self._task_stack:
291
self._progress_all_finished()
293
def _progress_all_finished(self):
294
"""Called when the top-level progress task finished"""
297
def _progress_updated(self, task):
298
"""Called by the ProgressTask when it changes.
300
Should be specialized to draw the progress.
304
def clear_term(self):
305
"""Prepare the terminal for output.
307
This will, for example, clear text progress bars, and leave the
308
cursor at the leftmost position.
312
def format_user_warning(self, warning_id, message_args):
314
template = self._user_warning_templates[warning_id]
316
fail = "bzr warning: %r, %r" % (warning_id, message_args)
317
warnings.warn("no template for warning: " + fail) # so tests will fail etc
320
return template % message_args
321
except ValueError, e:
322
fail = "bzr unprintable warning: %r, %r, %s" % (
323
warning_id, message_args, e)
324
warnings.warn(fail) # so tests will fail etc
327
def choose(self, msg, choices, default=None):
328
"""Prompt the user for a list of alternatives.
330
:param msg: message to be shown as part of the prompt.
332
:param choices: list of choices, with the individual choices separated
333
by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
334
letter after the '&' is the shortcut key for that choice. Thus you
335
can type 'c' to select "Cancel". Shorcuts are case insensitive.
336
The shortcut does not need to be the first letter. If a shorcut key
337
is not provided, the first letter for the choice will be used.
339
:param default: default choice (index), returned for example when enter
340
is pressed for the console version.
342
:return: the index fo the user choice (so '0', '1' or '2' for
343
respectively yes/no/cancel in the previous example).
345
raise NotImplementedError(self.choose)
347
def get_boolean(self, prompt):
348
"""Get a boolean question answered from the user.
350
:param prompt: a message to prompt the user with. Should be a single
351
line without terminating \\n.
352
:return: True or False for y/yes or n/no.
354
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
357
def get_integer(self, prompt):
358
"""Get an integer from the user.
360
:param prompt: a message to prompt the user with. Could be a multi-line
361
prompt but without a terminating \\n.
363
:return: A signed integer.
365
raise NotImplementedError(self.get_integer)
367
def make_progress_view(self):
368
"""Construct a new ProgressView object for this UI.
370
Application code should normally not call this but instead
371
nested_progress_bar().
373
return NullProgressView()
375
def recommend_upgrade(self, current_format_name, basedir):
376
"""Recommend the user upgrade a control directory.
378
:param current_format_name: Description of the current format
379
:param basedir: Location of the control dir
381
self.show_user_warning('recommend_upgrade',
382
current_format_name=current_format_name, basedir=basedir)
384
def report_transport_activity(self, transport, byte_count, direction):
385
"""Called by transports as they do IO.
387
This may update a progress bar, spinner, or similar display.
388
By default it does nothing.
392
def log_transport_activity(self, display=False):
393
"""Write out whatever transport activity has been measured.
395
Implementations are allowed to do nothing, but it is useful if they can
396
write a line to the log file.
398
:param display: If False, only log to disk, if True also try to display
399
a message to the user.
402
# Default implementation just does nothing
405
def show_user_warning(self, warning_id, **message_args):
406
"""Show a warning to the user.
408
This is specifically for things that are under the user's control (eg
409
outdated formats), not for internal program warnings like deprecated
412
This can be overridden by UIFactory subclasses to show it in some
413
appropriate way; the default UIFactory is noninteractive and does
414
nothing. format_user_warning maps it to a string, though other
415
presentations can be used for particular UIs.
417
:param warning_id: An identifier like 'cross_format_fetch' used to
418
check if the message is suppressed and to look up the string.
419
:param message_args: Arguments to be interpolated into the message.
423
def show_error(self, msg):
424
"""Show an error message (not an exception) to the user.
426
The message should not have an error prefix or trailing newline. That
427
will be added by the factory if appropriate.
429
raise NotImplementedError(self.show_error)
431
def show_message(self, msg):
432
"""Show a message to the user."""
433
raise NotImplementedError(self.show_message)
435
def show_warning(self, msg):
436
"""Show a warning to the user."""
437
raise NotImplementedError(self.show_warning)
440
class NoninteractiveUIFactory(UIFactory):
441
"""Base class for UIs with no user."""
443
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
447
return '%s()' % (self.__class__.__name__, )
450
class SilentUIFactory(NoninteractiveUIFactory):
451
"""A UI Factory which never prints anything.
453
This is the default UI, if another one is never registered by a program
454
using bzrlib, and it's also active for example inside 'bzr serve'.
456
Methods that try to read from the user raise an error; methods that do
461
UIFactory.__init__(self)
466
def get_username(self, prompt, **kwargs):
469
def _make_output_stream_explicit(self, encoding, encoding_type):
470
return NullOutputStream(encoding)
472
def show_error(self, msg):
475
def show_message(self, msg):
478
def show_warning(self, msg):
482
class CannedInputUIFactory(SilentUIFactory):
483
"""A silent UI that return canned input."""
485
def __init__(self, responses):
486
self.responses = responses
489
return "%s(%r)" % (self.__class__.__name__, self.responses)
491
def confirm_action(self, prompt, confirmation_id, args):
492
return self.get_boolean(prompt % args)
494
def get_boolean(self, prompt):
495
return self.responses.pop(0)
497
def get_integer(self, prompt):
498
return self.responses.pop(0)
500
def get_password(self, prompt=u'', **kwargs):
501
return self.responses.pop(0)
503
def get_username(self, prompt, **kwargs):
504
return self.responses.pop(0)
506
def assert_all_input_consumed(self):
508
raise AssertionError("expected all input in %r to be consumed"
512
ui_factory = SilentUIFactory()
513
# IMPORTANT: never import this symbol directly. ONLY ever access it as
514
# ui.ui_factory, so that you refer to the current value.
517
def make_ui_for_terminal(stdin, stdout, stderr):
518
"""Construct and return a suitable UIFactory for a text mode program.
520
# this is now always TextUIFactory, which in turn decides whether it
521
# should display progress bars etc
522
from bzrlib.ui.text import TextUIFactory
523
return TextUIFactory(stdin, stdout, stderr)
526
class NullProgressView(object):
527
"""Soak up and ignore progress information."""
532
def show_progress(self, task):
535
def show_transport_activity(self, transport, direction, byte_count):
538
def log_transport_activity(self, display=False):
542
class NullOutputStream(object):
543
"""Acts like a file, but discard all output."""
545
def __init__(self, encoding):
546
self.encoding = encoding
548
def write(self, data):
551
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
