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(), """
57
_valid_boolean_strings = dict(yes=True, no=False,
60
true=True, false=False)
61
_valid_boolean_strings['1'] = True
62
_valid_boolean_strings['0'] = False
65
def bool_from_string(s, accepted_values=None):
66
"""Returns a boolean if the string can be interpreted as such.
68
Interpret case insensitive strings as booleans. The default values
69
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
70
'off'. Alternative values can be provided with the 'accepted_values'
73
:param s: A string that should be interpreted as a boolean. It should be of
74
type string or unicode.
76
:param accepted_values: An optional dict with accepted strings as keys and
77
True/False as values. The strings will be tested against a lowered
80
:return: True or False for accepted strings, None otherwise.
82
if accepted_values is None:
83
accepted_values = _valid_boolean_strings
85
if type(s) in (str, unicode):
87
val = accepted_values[s.lower()]
93
class ConfirmationUserInterfacePolicy(object):
94
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
96
def __init__(self, wrapped_ui, default_answer, specific_answers):
97
"""Generate a proxy UI that does no confirmations.
99
:param wrapped_ui: Underlying UIFactory.
100
:param default_answer: Bool for whether requests for
101
confirmation from the user should be noninteractively accepted or
103
:param specific_answers: Map from confirmation_id to bool answer.
105
self.wrapped_ui = wrapped_ui
106
self.default_answer = default_answer
107
self.specific_answers = specific_answers
109
def __getattr__(self, name):
110
return getattr(self.wrapped_ui, name)
113
return '%s(%r, %r, %r)' % (
114
self.__class__.__name__,
117
self.specific_answers)
119
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
120
if confirmation_id in self.specific_answers:
121
return self.specific_answers[confirmation_id]
122
elif self.default_answer is not None:
123
return self.default_answer
125
return self.wrapped_ui.confirm_action(
126
prompt, confirmation_id, prompt_kwargs)
129
class UIFactory(object):
132
This tells the library how to display things to the user. Through this
133
layer different applications can choose the style of UI.
135
UI Factories are also context managers, for some syntactic sugar some users
138
:ivar suppressed_warnings: Identifiers for user warnings that should
142
_user_warning_templates = dict(
143
cross_format_fetch=("Doing on-the-fly conversion from "
144
"%(from_format)s to %(to_format)s.\n"
145
"This may take some time. Upgrade the repositories to the "
146
"same format for better performance."
149
"The command 'bzr %(deprecated_name)s' "
150
"has been deprecated in bzr %(deprecated_in_version)s. "
151
"Please use 'bzr %(recommended_name)s' instead."),
152
recommend_upgrade=("%(current_format_name)s is deprecated "
153
"and a better format is available.\n"
154
"It is recommended that you upgrade by "
155
"running the command\n"
156
" bzr upgrade %(basedir)s"),
160
self._task_stack = []
161
self.suppressed_warnings = set()
165
"""Context manager entry support.
167
Override in a concrete factory class if initialisation before use is
170
return self # This is bound to the 'as' clause in a with statement.
172
def __exit__(self, exc_type, exc_val, exc_tb):
173
"""Context manager exit support.
175
Override in a concrete factory class if more cleanup than a simple
176
self.clear_term() is needed when the UIFactory is finished with.
179
return False # propogate exceptions.
181
def be_quiet(self, state):
182
"""Tell the UI to be more quiet, or not.
184
Typically this suppresses progress bars; the application may also look
185
at ui_factory.is_quiet().
189
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
190
"""Seek user confirmation for an action.
192
If the UI is noninteractive, or the user does not want to be asked
193
about this action, True is returned, indicating bzr should just
196
The confirmation id allows the user to configure certain actions to
197
always be confirmed or always denied, and for UIs to specialize the
198
display of particular confirmations.
200
:param prompt: Suggested text to display to the user.
201
:param prompt_kwargs: A dictionary of arguments that can be
202
string-interpolated into the prompt.
203
:param confirmation_id: Unique string identifier for the confirmation.
205
return self.get_boolean(prompt % prompt_kwargs)
207
def get_password(self, prompt='', **kwargs):
208
"""Prompt the user for a password.
210
:param prompt: The prompt to present the user
211
:param kwargs: Arguments which will be expanded into the prompt.
212
This lets front ends display different things if
215
:return: The password string, return None if the user canceled the
216
request. Note that we do not touch the encoding, users may
217
have whatever they see fit and the password should be
220
raise NotImplementedError(self.get_password)
225
def make_output_stream(self, encoding=None, encoding_type=None):
226
"""Get a stream for sending out bulk text data.
228
This is used for commands that produce bulk text, such as log or diff
229
output, as opposed to user interaction. This should work even for
230
non-interactive user interfaces. Typically this goes to a decorated
231
version of stdout, but in a GUI it might be appropriate to send it to a
232
window displaying the text.
234
:param encoding: Unicode encoding for output; if not specified
235
uses the configured 'output_encoding' if any; otherwise the
237
(See get_terminal_encoding.)
239
:param encoding_type: How to handle encoding errors:
240
replace/strict/escape/exact. Default is replace.
242
# XXX: is the caller supposed to close the resulting object?
244
from bzrlib import config
245
encoding = config.GlobalConfig().get_user_option(
248
encoding = osutils.get_terminal_encoding(trace=True)
249
if encoding_type is None:
250
encoding_type = 'replace'
251
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
254
def _make_output_stream_explicit(self, encoding, encoding_type):
255
raise NotImplementedError("%s doesn't support make_output_stream"
256
% (self.__class__.__name__))
258
def nested_progress_bar(self):
259
"""Return a nested progress bar.
261
When the bar has been finished with, it should be released by calling
265
t = progress.ProgressTask(self._task_stack[-1], self)
267
t = progress.ProgressTask(None, self)
268
self._task_stack.append(t)
271
def _progress_finished(self, task):
272
"""Called by the ProgressTask when it finishes"""
273
if not self._task_stack:
274
warnings.warn("%r finished but nothing is active"
276
if task in self._task_stack:
277
self._task_stack.remove(task)
279
warnings.warn("%r is not in active stack %r"
280
% (task, self._task_stack))
281
if not self._task_stack:
282
self._progress_all_finished()
284
def _progress_all_finished(self):
285
"""Called when the top-level progress task finished"""
288
def _progress_updated(self, task):
289
"""Called by the ProgressTask when it changes.
291
Should be specialized to draw the progress.
295
def clear_term(self):
296
"""Prepare the terminal for output.
298
This will, for example, clear text progress bars, and leave the
299
cursor at the leftmost position.
303
def format_user_warning(self, warning_id, message_args):
305
template = self._user_warning_templates[warning_id]
307
fail = "failed to format warning %r, %r" % (warning_id, message_args)
308
warnings.warn(fail) # so tests will fail etc
311
return template % message_args
312
except ValueError, e:
313
fail = "failed to format warning %r, %r: %s" % (
314
warning_id, message_args, e)
315
warnings.warn(fail) # so tests will fail etc
318
def get_boolean(self, prompt):
319
"""Get a boolean question answered from the user.
321
:param prompt: a message to prompt the user with. Should be a single
322
line without terminating \n.
323
:return: True or False for y/yes or n/no.
325
raise NotImplementedError(self.get_boolean)
327
def get_integer(self, prompt):
328
"""Get an integer from the user.
330
:param prompt: a message to prompt the user with. Could be a multi-line
331
prompt but without a terminating \n.
333
:return: A signed integer.
335
raise NotImplementedError(self.get_integer)
337
def make_progress_view(self):
338
"""Construct a new ProgressView object for this UI.
340
Application code should normally not call this but instead
341
nested_progress_bar().
343
return NullProgressView()
345
def recommend_upgrade(self, current_format_name, basedir):
346
"""Recommend the user upgrade a control directory.
348
:param current_format_name: Description of the current format
349
:param basedir: Location of the control dir
351
self.show_user_warning('recommend_upgrade',
352
current_format_name=current_format_name, basedir=basedir)
354
def report_transport_activity(self, transport, byte_count, direction):
355
"""Called by transports as they do IO.
357
This may update a progress bar, spinner, or similar display.
358
By default it does nothing.
362
def log_transport_activity(self, display=False):
363
"""Write out whatever transport activity has been measured.
365
Implementations are allowed to do nothing, but it is useful if they can
366
write a line to the log file.
368
:param display: If False, only log to disk, if True also try to display
369
a message to the user.
372
# Default implementation just does nothing
375
def show_user_warning(self, warning_id, **message_args):
376
"""Show a warning to the user.
378
This is specifically for things that are under the user's control (eg
379
outdated formats), not for internal program warnings like deprecated
382
This can be overridden by UIFactory subclasses to show it in some
383
appropriate way; the default UIFactory is noninteractive and does
384
nothing. format_user_warning maps it to a string, though other
385
presentations can be used for particular UIs.
387
:param warning_id: An identifier like 'cross_format_fetch' used to
388
check if the message is suppressed and to look up the string.
389
:param message_args: Arguments to be interpolated into the message.
393
def show_error(self, msg):
394
"""Show an error message (not an exception) to the user.
396
The message should not have an error prefix or trailing newline. That
397
will be added by the factory if appropriate.
399
raise NotImplementedError(self.show_error)
401
def show_message(self, msg):
402
"""Show a message to the user."""
403
raise NotImplementedError(self.show_message)
405
def show_warning(self, msg):
406
"""Show a warning to the user."""
407
raise NotImplementedError(self.show_warning)
409
def warn_cross_format_fetch(self, from_format, to_format):
410
"""Warn about a potentially slow cross-format transfer.
412
This is deprecated in favor of show_user_warning, but retained for api
413
compatibility in 2.0 and 2.1.
415
self.show_user_warning('cross_format_fetch', from_format=from_format,
418
def warn_experimental_format_fetch(self, inter):
419
"""Warn about fetching into experimental repository formats."""
420
if inter.target._format.experimental:
421
trace.warning("Fetching into experimental format %s.\n"
422
"This format may be unreliable or change in the future "
423
"without an upgrade path.\n" % (inter.target._format,))
426
class NoninteractiveUIFactory(UIFactory):
427
"""Base class for UIs with no user."""
429
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
433
return '%s()' % (self.__class__.__name__, )
436
class SilentUIFactory(NoninteractiveUIFactory):
437
"""A UI Factory which never prints anything.
439
This is the default UI, if another one is never registered by a program
440
using bzrlib, and it's also active for example inside 'bzr serve'.
442
Methods that try to read from the user raise an error; methods that do
447
UIFactory.__init__(self)
452
def get_username(self, prompt, **kwargs):
455
def _make_output_stream_explicit(self, encoding, encoding_type):
456
return NullOutputStream(encoding)
458
def show_error(self, msg):
461
def show_message(self, msg):
464
def show_warning(self, msg):
468
class CannedInputUIFactory(SilentUIFactory):
469
"""A silent UI that return canned input."""
471
def __init__(self, responses):
472
self.responses = responses
475
return "%s(%r)" % (self.__class__.__name__, self.responses)
477
def confirm_action(self, prompt, confirmation_id, args):
478
return self.get_boolean(prompt % args)
480
def get_boolean(self, prompt):
481
return self.responses.pop(0)
483
def get_integer(self, prompt):
484
return self.responses.pop(0)
486
def get_password(self, prompt='', **kwargs):
487
return self.responses.pop(0)
489
def get_username(self, prompt, **kwargs):
490
return self.responses.pop(0)
492
def assert_all_input_consumed(self):
494
raise AssertionError("expected all input in %r to be consumed"
498
ui_factory = SilentUIFactory()
499
# IMPORTANT: never import this symbol directly. ONLY ever access it as
500
# ui.ui_factory, so that you refer to the current value.
503
def make_ui_for_terminal(stdin, stdout, stderr):
504
"""Construct and return a suitable UIFactory for a text mode program.
506
# this is now always TextUIFactory, which in turn decides whether it
507
# should display progress bars etc
508
from bzrlib.ui.text import TextUIFactory
509
return TextUIFactory(stdin, stdout, stderr)
512
class NullProgressView(object):
513
"""Soak up and ignore progress information."""
518
def show_progress(self, task):
521
def show_transport_activity(self, transport, direction, byte_count):
524
def log_transport_activity(self, display=False):
528
class NullOutputStream(object):
529
"""Acts like a file, but discard all output."""
531
def __init__(self, encoding):
532
self.encoding = encoding
534
def write(self, data):
537
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
