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.
44
from __future__ import absolute_import
48
from bzrlib.lazy_import import lazy_import
49
lazy_import(globals(), """
59
_valid_boolean_strings = dict(yes=True, no=False,
62
true=True, false=False)
63
_valid_boolean_strings['1'] = True
64
_valid_boolean_strings['0'] = False
67
def bool_from_string(s, accepted_values=None):
68
"""Returns a boolean if the string can be interpreted as such.
70
Interpret case insensitive strings as booleans. The default values
71
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
72
'off'. Alternative values can be provided with the 'accepted_values'
75
:param s: A string that should be interpreted as a boolean. It should be of
76
type string or unicode.
78
:param accepted_values: An optional dict with accepted strings as keys and
79
True/False as values. The strings will be tested against a lowered
82
:return: True or False for accepted strings, None otherwise.
84
if accepted_values is None:
85
accepted_values = _valid_boolean_strings
87
if type(s) in (str, unicode):
89
val = accepted_values[s.lower()]
95
class ConfirmationUserInterfacePolicy(object):
96
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
98
def __init__(self, wrapped_ui, default_answer, specific_answers):
99
"""Generate a proxy UI that does no confirmations.
101
:param wrapped_ui: Underlying UIFactory.
102
:param default_answer: Bool for whether requests for
103
confirmation from the user should be noninteractively accepted or
105
:param specific_answers: Map from confirmation_id to bool answer.
107
self.wrapped_ui = wrapped_ui
108
self.default_answer = default_answer
109
self.specific_answers = specific_answers
111
def __getattr__(self, name):
112
return getattr(self.wrapped_ui, name)
115
return '%s(%r, %r, %r)' % (
116
self.__class__.__name__,
119
self.specific_answers)
121
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
122
if confirmation_id in self.specific_answers:
123
return self.specific_answers[confirmation_id]
124
elif self.default_answer is not None:
125
return self.default_answer
127
return self.wrapped_ui.confirm_action(
128
prompt, confirmation_id, prompt_kwargs)
131
class UIFactory(object):
134
This tells the library how to display things to the user. Through this
135
layer different applications can choose the style of UI.
137
UI Factories are also context managers, for some syntactic sugar some users
140
:ivar suppressed_warnings: Identifiers for user warnings that should
144
_user_warning_templates = dict(
145
cross_format_fetch=("Doing on-the-fly conversion from "
146
"%(from_format)s to %(to_format)s.\n"
147
"This may take some time. Upgrade the repositories to the "
148
"same format for better performance."
150
experimental_format_fetch=("Fetching into experimental format "
152
"This format may be unreliable or change in the future "
153
"without an upgrade path.\n"),
155
"The command 'bzr %(deprecated_name)s' "
156
"has been deprecated in bzr %(deprecated_in_version)s. "
157
"Please use 'bzr %(recommended_name)s' instead."),
158
deprecated_command_option=(
159
"The option '%(deprecated_name)s' to 'bzr %(command)s' "
160
"has been deprecated in bzr %(deprecated_in_version)s. "
161
"Please use '%(recommended_name)s' instead."),
162
recommend_upgrade=("%(current_format_name)s is deprecated "
163
"and a better format is available.\n"
164
"It is recommended that you upgrade by "
165
"running the command\n"
166
" bzr upgrade %(basedir)s"),
168
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
172
self._task_stack = []
173
self.suppressed_warnings = set()
177
"""Context manager entry support.
179
Override in a concrete factory class if initialisation before use is
182
return self # This is bound to the 'as' clause in a with statement.
184
def __exit__(self, exc_type, exc_val, exc_tb):
185
"""Context manager exit support.
187
Override in a concrete factory class if more cleanup than a simple
188
self.clear_term() is needed when the UIFactory is finished with.
191
return False # propogate exceptions.
193
def be_quiet(self, state):
194
"""Tell the UI to be more quiet, or not.
196
Typically this suppresses progress bars; the application may also look
197
at ui_factory.is_quiet().
201
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
202
"""Seek user confirmation for an action.
204
If the UI is noninteractive, or the user does not want to be asked
205
about this action, True is returned, indicating bzr should just
208
The confirmation id allows the user to configure certain actions to
209
always be confirmed or always denied, and for UIs to specialize the
210
display of particular confirmations.
212
:param prompt: Suggested text to display to the user.
213
:param prompt_kwargs: A dictionary of arguments that can be
214
string-interpolated into the prompt.
215
:param confirmation_id: Unique string identifier for the confirmation.
217
return self.get_boolean(prompt % prompt_kwargs)
219
def get_password(self, prompt=u'', **kwargs):
220
"""Prompt the user for a password.
222
:param prompt: The prompt to present the user (must be unicode)
223
:param kwargs: Arguments which will be expanded into the prompt.
224
This lets front ends display different things if
227
:return: The password string, return None if the user canceled the
228
request. Note that we do not touch the encoding, users may
229
have whatever they see fit and the password should be
232
raise NotImplementedError(self.get_password)
237
def make_output_stream(self, encoding=None, encoding_type=None):
238
"""Get a stream for sending out bulk text data.
240
This is used for commands that produce bulk text, such as log or diff
241
output, as opposed to user interaction. This should work even for
242
non-interactive user interfaces. Typically this goes to a decorated
243
version of stdout, but in a GUI it might be appropriate to send it to a
244
window displaying the text.
246
:param encoding: Unicode encoding for output; if not specified
247
uses the configured 'output_encoding' if any; otherwise the
249
(See get_terminal_encoding.)
251
:param encoding_type: How to handle encoding errors:
252
replace/strict/escape/exact. Default is replace.
254
# XXX: is the caller supposed to close the resulting object?
256
encoding = config.GlobalStack().get('output_encoding')
258
encoding = osutils.get_terminal_encoding(trace=True)
259
if encoding_type is None:
260
encoding_type = 'replace'
261
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
264
def _make_output_stream_explicit(self, encoding, encoding_type):
265
raise NotImplementedError("%s doesn't support make_output_stream"
266
% (self.__class__.__name__))
268
def nested_progress_bar(self):
269
"""Return a nested progress bar.
271
When the bar has been finished with, it should be released by calling
275
t = progress.ProgressTask(self._task_stack[-1], self)
277
t = progress.ProgressTask(None, self)
278
self._task_stack.append(t)
281
def _progress_finished(self, task):
282
"""Called by the ProgressTask when it finishes"""
283
if not self._task_stack:
284
warnings.warn("%r finished but nothing is active"
286
if task in self._task_stack:
287
self._task_stack.remove(task)
289
warnings.warn("%r is not in active stack %r"
290
% (task, self._task_stack))
291
if not self._task_stack:
292
self._progress_all_finished()
294
def _progress_all_finished(self):
295
"""Called when the top-level progress task finished"""
298
def _progress_updated(self, task):
299
"""Called by the ProgressTask when it changes.
301
Should be specialized to draw the progress.
305
def clear_term(self):
306
"""Prepare the terminal for output.
308
This will, for example, clear text progress bars, and leave the
309
cursor at the leftmost position.
313
def format_user_warning(self, warning_id, message_args):
315
template = self._user_warning_templates[warning_id]
317
fail = "bzr warning: %r, %r" % (warning_id, message_args)
318
warnings.warn("no template for warning: " + fail) # so tests will fail etc
321
return template % message_args
322
except ValueError, e:
323
fail = "bzr unprintable warning: %r, %r, %s" % (
324
warning_id, message_args, e)
325
warnings.warn(fail) # so tests will fail etc
328
def choose(self, msg, choices, default=None):
329
"""Prompt the user for a list of alternatives.
331
:param msg: message to be shown as part of the prompt.
333
:param choices: list of choices, with the individual choices separated
334
by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
335
letter after the '&' is the shortcut key for that choice. Thus you
336
can type 'c' to select "Cancel". Shorcuts are case insensitive.
337
The shortcut does not need to be the first letter. If a shorcut key
338
is not provided, the first letter for the choice will be used.
340
:param default: default choice (index), returned for example when enter
341
is pressed for the console version.
343
:return: the index fo the user choice (so '0', '1' or '2' for
344
respectively yes/no/cancel in the previous example).
346
raise NotImplementedError(self.choose)
348
def get_boolean(self, prompt):
349
"""Get a boolean question answered from the user.
351
:param prompt: a message to prompt the user with. Should be a single
352
line without terminating \\n.
353
:return: True or False for y/yes or n/no.
355
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
358
def get_integer(self, prompt):
359
"""Get an integer from the user.
361
:param prompt: a message to prompt the user with. Could be a multi-line
362
prompt but without a terminating \\n.
364
:return: A signed integer.
366
raise NotImplementedError(self.get_integer)
368
def make_progress_view(self):
369
"""Construct a new ProgressView object for this UI.
371
Application code should normally not call this but instead
372
nested_progress_bar().
374
return NullProgressView()
376
def recommend_upgrade(self, current_format_name, basedir):
377
"""Recommend the user upgrade a control directory.
379
:param current_format_name: Description of the current format
380
:param basedir: Location of the control dir
382
self.show_user_warning('recommend_upgrade',
383
current_format_name=current_format_name, basedir=basedir)
385
def report_transport_activity(self, transport, byte_count, direction):
386
"""Called by transports as they do IO.
388
This may update a progress bar, spinner, or similar display.
389
By default it does nothing.
393
def log_transport_activity(self, display=False):
394
"""Write out whatever transport activity has been measured.
396
Implementations are allowed to do nothing, but it is useful if they can
397
write a line to the log file.
399
:param display: If False, only log to disk, if True also try to display
400
a message to the user.
403
# Default implementation just does nothing
406
def show_user_warning(self, warning_id, **message_args):
407
"""Show a warning to the user.
409
This is specifically for things that are under the user's control (eg
410
outdated formats), not for internal program warnings like deprecated
413
This can be overridden by UIFactory subclasses to show it in some
414
appropriate way; the default UIFactory is noninteractive and does
415
nothing. format_user_warning maps it to a string, though other
416
presentations can be used for particular UIs.
418
:param warning_id: An identifier like 'cross_format_fetch' used to
419
check if the message is suppressed and to look up the string.
420
:param message_args: Arguments to be interpolated into the message.
424
def show_error(self, msg):
425
"""Show an error message (not an exception) to the user.
427
The message should not have an error prefix or trailing newline. That
428
will be added by the factory if appropriate.
430
raise NotImplementedError(self.show_error)
432
def show_message(self, msg):
433
"""Show a message to the user."""
434
raise NotImplementedError(self.show_message)
436
def show_warning(self, msg):
437
"""Show a warning to the user."""
438
raise NotImplementedError(self.show_warning)
441
class NoninteractiveUIFactory(UIFactory):
442
"""Base class for UIs with no user."""
444
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
448
return '%s()' % (self.__class__.__name__, )
451
class SilentUIFactory(NoninteractiveUIFactory):
452
"""A UI Factory which never prints anything.
454
This is the default UI, if another one is never registered by a program
455
using bzrlib, and it's also active for example inside 'bzr serve'.
457
Methods that try to read from the user raise an error; methods that do
462
UIFactory.__init__(self)
467
def get_username(self, prompt, **kwargs):
470
def _make_output_stream_explicit(self, encoding, encoding_type):
471
return NullOutputStream(encoding)
473
def show_error(self, msg):
476
def show_message(self, msg):
479
def show_warning(self, msg):
483
class CannedInputUIFactory(SilentUIFactory):
484
"""A silent UI that return canned input."""
486
def __init__(self, responses):
487
self.responses = responses
490
return "%s(%r)" % (self.__class__.__name__, self.responses)
492
def confirm_action(self, prompt, confirmation_id, args):
493
return self.get_boolean(prompt % args)
495
def get_boolean(self, prompt):
496
return self.responses.pop(0)
498
def get_integer(self, prompt):
499
return self.responses.pop(0)
501
def get_password(self, prompt=u'', **kwargs):
502
return self.responses.pop(0)
504
def get_username(self, prompt, **kwargs):
505
return self.responses.pop(0)
507
def assert_all_input_consumed(self):
509
raise AssertionError("expected all input in %r to be consumed"
513
ui_factory = SilentUIFactory()
514
# IMPORTANT: never import this symbol directly. ONLY ever access it as
515
# ui.ui_factory, so that you refer to the current value.
518
def make_ui_for_terminal(stdin, stdout, stderr):
519
"""Construct and return a suitable UIFactory for a text mode program.
521
# this is now always TextUIFactory, which in turn decides whether it
522
# should display progress bars etc
523
from bzrlib.ui.text import TextUIFactory
524
return TextUIFactory(stdin, stdout, stderr)
527
class NullProgressView(object):
528
"""Soak up and ignore progress information."""
533
def show_progress(self, task):
536
def show_transport_activity(self, transport, direction, byte_count):
539
def log_transport_activity(self, display=False):
543
class NullOutputStream(object):
544
"""Acts like a file, but discard all output."""
546
def __init__(self, encoding):
547
self.encoding = encoding
549
def write(self, data):
552
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
