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., 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.
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
This tells the library how to display things to the user. Through this
22
layer different applications can choose the style of UI.
24
At the moment this layer is almost trivial: the application can just
25
choose the style of progress bar.
27
Set the ui_factory member to define the behaviour. The default
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)
33
import bzrlib.progress
34
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
131
37
class UIFactory(object):
134
40
This tells the library how to display things to the user. Through this
135
41
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."),
169
not_checking_ssl_cert=(
170
u"Not checking SSL certificate for %(host)s."),
173
44
def __init__(self):
174
self._task_stack = []
175
self.suppressed_warnings = set()
179
"""Context manager entry support.
181
Override in a concrete factory class if initialisation before use is
184
return self # This is bound to the 'as' clause in a with statement.
186
def __exit__(self, exc_type, exc_val, exc_tb):
187
"""Context manager exit support.
189
Override in a concrete factory class if more cleanup than a simple
190
self.clear_term() is needed when the UIFactory is finished with.
193
return False # propogate exceptions.
195
def be_quiet(self, state):
196
"""Tell the UI to be more quiet, or not.
198
Typically this suppresses progress bars; the application may also look
199
at ui_factory.is_quiet().
203
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
204
"""Seek user confirmation for an action.
206
If the UI is noninteractive, or the user does not want to be asked
207
about this action, True is returned, indicating bzr should just
210
The confirmation id allows the user to configure certain actions to
211
always be confirmed or always denied, and for UIs to specialize the
212
display of particular confirmations.
214
:param prompt: Suggested text to display to the user.
215
:param prompt_kwargs: A dictionary of arguments that can be
216
string-interpolated into the prompt.
217
:param confirmation_id: Unique string identifier for the confirmation.
219
return self.get_boolean(prompt % prompt_kwargs)
221
def get_password(self, prompt=u'', **kwargs):
45
super(UIFactory, self).__init__()
46
self._progress_bar_stack = None
48
@deprecated_method(zero_eight)
49
def progress_bar(self):
50
"""See UIFactory.nested_progress_bar()."""
51
raise NotImplementedError(self.progress_bar)
53
def get_password(self, prompt='', **kwargs):
222
54
"""Prompt the user for a password.
224
:param prompt: The prompt to present the user (must be unicode)
56
:param prompt: The prompt to present the user
225
57
:param kwargs: Arguments which will be expanded into the prompt.
226
58
This lets front ends display different things if
229
:return: The password string, return None if the user canceled the
230
request. Note that we do not touch the encoding, users may
231
have whatever they see fit and the password should be
60
:return: The password string, return None if the user
234
63
raise NotImplementedError(self.get_password)
239
def make_output_stream(self, encoding=None, encoding_type=None):
240
"""Get a stream for sending out bulk text data.
242
This is used for commands that produce bulk text, such as log or diff
243
output, as opposed to user interaction. This should work even for
244
non-interactive user interfaces. Typically this goes to a decorated
245
version of stdout, but in a GUI it might be appropriate to send it to a
246
window displaying the text.
248
:param encoding: Unicode encoding for output; if not specified
249
uses the configured 'output_encoding' if any; otherwise the
251
(See get_terminal_encoding.)
253
:param encoding_type: How to handle encoding errors:
254
replace/strict/escape/exact. Default is replace.
256
# XXX: is the caller supposed to close the resulting object?
258
encoding = config.GlobalStack().get('output_encoding')
260
encoding = osutils.get_terminal_encoding(trace=True)
261
if encoding_type is None:
262
encoding_type = 'replace'
263
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
266
def _make_output_stream_explicit(self, encoding, encoding_type):
267
raise NotImplementedError("%s doesn't support make_output_stream"
268
% (self.__class__.__name__))
270
65
def nested_progress_bar(self):
271
66
"""Return a nested progress bar.
273
When the bar has been finished with, it should be released by calling
68
When the bar has been finished with, it should be released bu calling
277
t = progress.ProgressTask(self._task_stack[-1], self)
279
t = progress.ProgressTask(None, self)
280
self._task_stack.append(t)
283
def _progress_finished(self, task):
284
"""Called by the ProgressTask when it finishes"""
285
if not self._task_stack:
286
warnings.warn("%r finished but nothing is active"
288
if task in self._task_stack:
289
self._task_stack.remove(task)
291
warnings.warn("%r is not in active stack %r"
292
% (task, self._task_stack))
293
if not self._task_stack:
294
self._progress_all_finished()
296
def _progress_all_finished(self):
297
"""Called when the top-level progress task finished"""
300
def _progress_updated(self, task):
301
"""Called by the ProgressTask when it changes.
303
Should be specialized to draw the progress.
71
raise NotImplementedError(self.nested_progress_bar)
307
73
def clear_term(self):
308
74
"""Prepare the terminal for output.
310
76
This will, for example, clear text progress bars, and leave the
311
cursor at the leftmost position.
315
def format_user_warning(self, warning_id, message_args):
317
template = self._user_warning_templates[warning_id]
319
fail = "bzr warning: %r, %r" % (warning_id, message_args)
320
warnings.warn("no template for warning: " + fail) # so tests will fail etc
323
return template % message_args
324
except ValueError, e:
325
fail = "bzr unprintable warning: %r, %r, %s" % (
326
warning_id, message_args, e)
327
warnings.warn(fail) # so tests will fail etc
330
def choose(self, msg, choices, default=None):
331
"""Prompt the user for a list of alternatives.
333
:param msg: message to be shown as part of the prompt.
335
:param choices: list of choices, with the individual choices separated
336
by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
337
letter after the '&' is the shortcut key for that choice. Thus you
338
can type 'c' to select "Cancel". Shorcuts are case insensitive.
339
The shortcut does not need to be the first letter. If a shorcut key
340
is not provided, the first letter for the choice will be used.
342
:param default: default choice (index), returned for example when enter
343
is pressed for the console version.
345
:return: the index fo the user choice (so '0', '1' or '2' for
346
respectively yes/no/cancel in the previous example).
348
raise NotImplementedError(self.choose)
77
cursor at the leftmost position."""
78
raise NotImplementedError(self.clear_term)
350
80
def get_boolean(self, prompt):
351
"""Get a boolean question answered from the user.
81
"""Get a boolean question answered from the user.
353
83
:param prompt: a message to prompt the user with. Should be a single
354
line without terminating \\n.
84
line without terminating \n.
355
85
:return: True or False for y/yes or n/no.
357
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
360
def get_integer(self, prompt):
361
"""Get an integer from the user.
363
:param prompt: a message to prompt the user with. Could be a multi-line
364
prompt but without a terminating \\n.
366
:return: A signed integer.
368
raise NotImplementedError(self.get_integer)
370
def make_progress_view(self):
371
"""Construct a new ProgressView object for this UI.
373
Application code should normally not call this but instead
374
nested_progress_bar().
376
return NullProgressView()
378
def recommend_upgrade(self, current_format_name, basedir):
379
"""Recommend the user upgrade a control directory.
381
:param current_format_name: Description of the current format
382
:param basedir: Location of the control dir
384
self.show_user_warning('recommend_upgrade',
385
current_format_name=current_format_name, basedir=basedir)
387
def report_transport_activity(self, transport, byte_count, direction):
388
"""Called by transports as they do IO.
390
This may update a progress bar, spinner, or similar display.
391
By default it does nothing.
395
def log_transport_activity(self, display=False):
396
"""Write out whatever transport activity has been measured.
398
Implementations are allowed to do nothing, but it is useful if they can
399
write a line to the log file.
401
:param display: If False, only log to disk, if True also try to display
402
a message to the user.
405
# Default implementation just does nothing
408
def show_user_warning(self, warning_id, **message_args):
409
"""Show a warning to the user.
411
This is specifically for things that are under the user's control (eg
412
outdated formats), not for internal program warnings like deprecated
415
This can be overridden by UIFactory subclasses to show it in some
416
appropriate way; the default UIFactory is noninteractive and does
417
nothing. format_user_warning maps it to a string, though other
418
presentations can be used for particular UIs.
420
:param warning_id: An identifier like 'cross_format_fetch' used to
421
check if the message is suppressed and to look up the string.
422
:param message_args: Arguments to be interpolated into the message.
426
def show_error(self, msg):
427
"""Show an error message (not an exception) to the user.
429
The message should not have an error prefix or trailing newline. That
430
will be added by the factory if appropriate.
432
raise NotImplementedError(self.show_error)
434
def show_message(self, msg):
435
"""Show a message to the user."""
436
raise NotImplementedError(self.show_message)
438
def show_warning(self, msg):
439
"""Show a warning to the user."""
440
raise NotImplementedError(self.show_warning)
443
class NoninteractiveUIFactory(UIFactory):
444
"""Base class for UIs with no user."""
446
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
450
return '%s()' % (self.__class__.__name__, )
453
class SilentUIFactory(NoninteractiveUIFactory):
87
raise NotImplementedError(self.get_boolean)
90
class CLIUIFactory(UIFactory):
91
"""Common behaviour for command line UI factories."""
94
super(CLIUIFactory, self).__init__()
95
self.stdin = sys.stdin
97
def get_boolean(self, prompt):
99
# FIXME: make a regexp and handle case variations as well.
102
line = self.stdin.readline()
103
if line in ('y\n', 'yes\n'):
105
if line in ('n\n', 'no\n'):
108
def prompt(self, prompt):
109
"""Emit prompt on the CLI."""
112
class SilentUIFactory(CLIUIFactory):
454
113
"""A UI Factory which never prints anything.
456
This is the default UI, if another one is never registered by a program
457
using bzrlib, and it's also active for example inside 'bzr serve'.
459
Methods that try to read from the user raise an error; methods that do
115
This is the default UI, if another one is never registered.
464
UIFactory.__init__(self)
469
def get_username(self, prompt, **kwargs):
118
@deprecated_method(zero_eight)
119
def progress_bar(self):
120
"""See UIFactory.nested_progress_bar()."""
121
return bzrlib.progress.DummyProgress()
123
def get_password(self, prompt='', **kwargs):
472
def _make_output_stream_explicit(self, encoding, encoding_type):
473
return NullOutputStream(encoding)
475
def show_error(self, msg):
478
def show_message(self, msg):
481
def show_warning(self, msg):
485
class CannedInputUIFactory(SilentUIFactory):
486
"""A silent UI that return canned input."""
488
def __init__(self, responses):
489
self.responses = responses
492
return "%s(%r)" % (self.__class__.__name__, self.responses)
494
def confirm_action(self, prompt, confirmation_id, args):
495
return self.get_boolean(prompt % args)
497
def get_boolean(self, prompt):
498
return self.responses.pop(0)
500
def get_integer(self, prompt):
501
return self.responses.pop(0)
503
def get_password(self, prompt=u'', **kwargs):
504
return self.responses.pop(0)
506
def get_username(self, prompt, **kwargs):
507
return self.responses.pop(0)
509
def assert_all_input_consumed(self):
511
raise AssertionError("expected all input in %r to be consumed"
126
def nested_progress_bar(self):
127
if self._progress_bar_stack is None:
128
self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
129
klass=bzrlib.progress.DummyProgress)
130
return self._progress_bar_stack.get_nested()
132
def clear_term(self):
136
def clear_decorator(func, *args, **kwargs):
137
"""Decorator that clears the term"""
138
ui_factory.clear_term()
139
func(*args, **kwargs)
515
142
ui_factory = SilentUIFactory()
516
# IMPORTANT: never import this symbol directly. ONLY ever access it as
517
# ui.ui_factory, so that you refer to the current value.
520
def make_ui_for_terminal(stdin, stdout, stderr):
521
"""Construct and return a suitable UIFactory for a text mode program.
523
# this is now always TextUIFactory, which in turn decides whether it
524
# should display progress bars etc
525
from bzrlib.ui.text import TextUIFactory
526
return TextUIFactory(stdin, stdout, stderr)
529
class NullProgressView(object):
530
"""Soak up and ignore progress information."""
535
def show_progress(self, task):
538
def show_transport_activity(self, transport, direction, byte_count):
541
def log_transport_activity(self, display=False):
545
class NullOutputStream(object):
546
"""Acts like a file, but discard all output."""
548
def __init__(self, encoding):
549
self.encoding = encoding
551
def write(self, data):
554
def writelines(self, data):
143
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
