1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
breezy.ui.SilentUIFactory
29
Produces no output and cannot take any input; useful for programs using
30
breezy in batch mode or for programs such as loggerhead.
32
breezy.ui.CannedInputUIFactory
33
For use in testing; the input values to be returned are provided
36
breezy.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 ..lazy_import import lazy_import
49
lazy_import(globals(), """
57
from ..sixish import (
64
_valid_boolean_strings = dict(yes=True, no=False,
67
true=True, false=False)
68
_valid_boolean_strings['1'] = True
69
_valid_boolean_strings['0'] = False
72
def bool_from_string(s, accepted_values=None):
73
"""Returns a boolean if the string can be interpreted as such.
75
Interpret case insensitive strings as booleans. The default values
76
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
77
'off'. Alternative values can be provided with the 'accepted_values'
80
:param s: A string that should be interpreted as a boolean. It should be of
81
type string or unicode.
83
:param accepted_values: An optional dict with accepted strings as keys and
84
True/False as values. The strings will be tested against a lowered
87
:return: True or False for accepted strings, None otherwise.
89
if accepted_values is None:
90
accepted_values = _valid_boolean_strings
92
if isinstance(s, string_types):
94
val = accepted_values[s.lower()]
100
class ConfirmationUserInterfacePolicy(object):
101
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
103
def __init__(self, wrapped_ui, default_answer, specific_answers):
104
"""Generate a proxy UI that does no confirmations.
106
:param wrapped_ui: Underlying UIFactory.
107
:param default_answer: Bool for whether requests for
108
confirmation from the user should be noninteractively accepted or
110
:param specific_answers: Map from confirmation_id to bool answer.
112
self.wrapped_ui = wrapped_ui
113
self.default_answer = default_answer
114
self.specific_answers = specific_answers
116
def __getattr__(self, name):
117
return getattr(self.wrapped_ui, name)
120
return '%s(%r, %r, %r)' % (
121
self.__class__.__name__,
124
self.specific_answers)
126
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
127
if confirmation_id in self.specific_answers:
128
return self.specific_answers[confirmation_id]
129
elif self.default_answer is not None:
130
return self.default_answer
132
return self.wrapped_ui.confirm_action(
133
prompt, confirmation_id, prompt_kwargs)
136
class UIFactory(object):
139
This tells the library how to display things to the user. Through this
140
layer different applications can choose the style of UI.
142
UI Factories are also context managers, for some syntactic sugar some users
145
:ivar suppressed_warnings: Identifiers for user warnings that should
149
_user_warning_templates = dict(
150
cross_format_fetch=("Doing on-the-fly conversion from "
151
"%(from_format)s to %(to_format)s.\n"
152
"This may take some time. Upgrade the repositories to the "
153
"same format for better performance."
155
experimental_format_fetch=("Fetching into experimental format "
157
"This format may be unreliable or change in the future "
158
"without an upgrade path.\n"),
160
"The command 'brz %(deprecated_name)s' "
161
"has been deprecated in brz %(deprecated_in_version)s. "
162
"Please use 'brz %(recommended_name)s' instead."),
163
deprecated_command_option=(
164
"The option '%(deprecated_name)s' to 'brz %(command)s' "
165
"has been deprecated in brz %(deprecated_in_version)s. "
166
"Please use '%(recommended_name)s' instead."),
167
recommend_upgrade=("%(current_format_name)s is deprecated "
168
"and a better format is available.\n"
169
"It is recommended that you upgrade by "
170
"running the command\n"
171
" brz upgrade %(basedir)s"),
173
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
174
not_checking_ssl_cert=(
175
u"Not checking SSL certificate for %(host)s."),
179
self._task_stack = []
180
self.suppressed_warnings = set()
184
"""Context manager entry support.
186
Override in a concrete factory class if initialisation before use is
189
return self # This is bound to the 'as' clause in a with statement.
191
def __exit__(self, exc_type, exc_val, exc_tb):
192
"""Context manager exit support.
194
Override in a concrete factory class if more cleanup than a simple
195
self.clear_term() is needed when the UIFactory is finished with.
198
return False # propogate exceptions.
200
def be_quiet(self, state):
201
"""Tell the UI to be more quiet, or not.
203
Typically this suppresses progress bars; the application may also look
204
at ui_factory.is_quiet().
208
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
209
"""Seek user confirmation for an action.
211
If the UI is noninteractive, or the user does not want to be asked
212
about this action, True is returned, indicating brz should just
215
The confirmation id allows the user to configure certain actions to
216
always be confirmed or always denied, and for UIs to specialize the
217
display of particular confirmations.
219
:param prompt: Suggested text to display to the user.
220
:param prompt_kwargs: A dictionary of arguments that can be
221
string-interpolated into the prompt.
222
:param confirmation_id: Unique string identifier for the confirmation.
224
return self.get_boolean(prompt % prompt_kwargs)
226
def get_password(self, prompt=u'', **kwargs):
227
"""Prompt the user for a password.
229
:param prompt: The prompt to present the user (must be unicode)
230
:param kwargs: Arguments which will be expanded into the prompt.
231
This lets front ends display different things if
234
:return: The password string, return None if the user canceled the
235
request. Note that we do not touch the encoding, users may
236
have whatever they see fit and the password should be
239
raise NotImplementedError(self.get_password)
244
def make_output_stream(self, encoding=None, encoding_type='replace'):
245
"""Get a stream for sending out bulk text data.
247
This is used for commands that produce bulk text, such as log or diff
248
output, as opposed to user interaction. This should work even for
249
non-interactive user interfaces. Typically this goes to a decorated
250
version of stdout, but in a GUI it might be appropriate to send it to a
251
window displaying the text.
253
The caller may flush but should not close the returned stream.
255
:param encoding: Unicode encoding for output; if not specified
256
uses the configured 'output_encoding' if any; otherwise the
258
(See get_terminal_encoding.)
260
:param encoding_type: How to handle encoding errors:
261
replace/strict/escape/exact. Default is 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
def nested_progress_bar(self):
271
"""Return a nested progress bar.
273
When the bar has been finished with, it should be released by 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.
307
def clear_term(self):
308
"""Prepare the terminal for output.
310
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 = "brz warning: %r, %r" % (warning_id, message_args)
320
warnings.warn("no template for warning: "
321
+ fail) # so tests will fail etc
322
return text_type(fail)
324
return text_type(template) % message_args
325
except ValueError as e:
326
fail = "brz unprintable warning: %r, %r, %s" % (
327
warning_id, message_args, e)
328
warnings.warn(fail) # so tests will fail etc
329
return text_type(fail)
331
def choose(self, msg, choices, default=None):
332
"""Prompt the user for a list of alternatives.
334
:param msg: message to be shown as part of the prompt.
336
:param choices: list of choices, with the individual choices separated
337
by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
338
letter after the '&' is the shortcut key for that choice. Thus you
339
can type 'c' to select "Cancel". Shorcuts are case insensitive.
340
The shortcut does not need to be the first letter. If a shorcut key
341
is not provided, the first letter for the choice will be used.
343
:param default: default choice (index), returned for example when enter
344
is pressed for the console version.
346
:return: the index fo the user choice (so '0', '1' or '2' for
347
respectively yes/no/cancel in the previous example).
349
raise NotImplementedError(self.choose)
351
def get_boolean(self, prompt):
352
"""Get a boolean question answered from the user.
354
:param prompt: a message to prompt the user with. Should be a single
355
line without terminating \\n.
356
:return: True or False for y/yes or n/no.
358
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
361
def get_integer(self, prompt):
362
"""Get an integer from the user.
364
:param prompt: a message to prompt the user with. Could be a multi-line
365
prompt but without a terminating \\n.
367
:return: A signed integer.
369
raise NotImplementedError(self.get_integer)
371
def make_progress_view(self):
372
"""Construct a new ProgressView object for this UI.
374
Application code should normally not call this but instead
375
nested_progress_bar().
377
return NullProgressView()
379
def recommend_upgrade(self, current_format_name, basedir):
380
"""Recommend the user upgrade a control directory.
382
:param current_format_name: Description of the current format
383
:param basedir: Location of the control dir
385
self.show_user_warning('recommend_upgrade',
386
current_format_name=current_format_name, basedir=basedir)
388
def report_transport_activity(self, transport, byte_count, direction):
389
"""Called by transports as they do IO.
391
This may update a progress bar, spinner, or similar display.
392
By default it does nothing.
396
def log_transport_activity(self, display=False):
397
"""Write out whatever transport activity has been measured.
399
Implementations are allowed to do nothing, but it is useful if they can
400
write a line to the log file.
402
:param display: If False, only log to disk, if True also try to display
403
a message to the user.
406
# Default implementation just does nothing
409
def show_user_warning(self, warning_id, **message_args):
410
"""Show a warning to the user.
412
This is specifically for things that are under the user's control (eg
413
outdated formats), not for internal program warnings like deprecated
416
This can be overridden by UIFactory subclasses to show it in some
417
appropriate way; the default UIFactory is noninteractive and does
418
nothing. format_user_warning maps it to a string, though other
419
presentations can be used for particular UIs.
421
:param warning_id: An identifier like 'cross_format_fetch' used to
422
check if the message is suppressed and to look up the string.
423
:param message_args: Arguments to be interpolated into the message.
427
def show_error(self, msg):
428
"""Show an error message (not an exception) to the user.
430
The message should not have an error prefix or trailing newline. That
431
will be added by the factory if appropriate.
433
raise NotImplementedError(self.show_error)
435
def show_message(self, msg):
436
"""Show a message to the user."""
437
raise NotImplementedError(self.show_message)
439
def show_warning(self, msg):
440
"""Show a warning to the user."""
441
raise NotImplementedError(self.show_warning)
444
class NoninteractiveUIFactory(UIFactory):
445
"""Base class for UIs with no user."""
447
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
451
return '%s()' % (self.__class__.__name__, )
454
class SilentUIFactory(NoninteractiveUIFactory):
455
"""A UI Factory which never prints anything.
457
This is the default UI, if another one is never registered by a program
458
using breezy, and it's also active for example inside 'brz serve'.
460
Methods that try to read from the user raise an error; methods that do
465
UIFactory.__init__(self)
470
def get_username(self, prompt, **kwargs):
473
def _make_output_stream_explicit(self, encoding, encoding_type):
474
return NullOutputStream(encoding)
476
def show_error(self, msg):
479
def show_message(self, msg):
482
def show_warning(self, msg):
486
class CannedInputUIFactory(SilentUIFactory):
487
"""A silent UI that return canned input."""
489
def __init__(self, responses):
490
self.responses = responses
493
return "%s(%r)" % (self.__class__.__name__, self.responses)
495
def confirm_action(self, prompt, confirmation_id, args):
496
return self.get_boolean(prompt % args)
498
def get_boolean(self, prompt):
499
return self.responses.pop(0)
501
def get_integer(self, prompt):
502
return self.responses.pop(0)
504
def get_password(self, prompt=u'', **kwargs):
505
return self.responses.pop(0)
507
def get_username(self, prompt, **kwargs):
508
return self.responses.pop(0)
510
def assert_all_input_consumed(self):
512
raise AssertionError("expected all input in %r to be consumed"
35
import bzrlib.progress
38
class TextUIFactory(object):
39
def progress_bar(self):
41
# this in turn is abstract, and creates either a tty or dots
42
# bar depending on what we think of the terminal
43
return bzrlib.progress.ProgressBar()
46
class SilentUIFactory(object):
47
def progress_bar(self):
48
return bzrlib.progress.DummyProgress()
516
51
ui_factory = SilentUIFactory()
517
# IMPORTANT: never import this symbol directly. ONLY ever access it as
518
# ui.ui_factory, so that you refer to the current value.
521
def make_ui_for_terminal(stdin, stdout, stderr):
522
"""Construct and return a suitable UIFactory for a text mode program.
524
# this is now always TextUIFactory, which in turn decides whether it
525
# should display progress bars etc
526
from .text import TextUIFactory
527
return TextUIFactory(stdin, stdout, stderr)
530
class NullProgressView(object):
531
"""Soak up and ignore progress information."""
536
def show_progress(self, task):
539
def show_transport_activity(self, transport, direction, byte_count):
542
def log_transport_activity(self, display=False):
546
class NullOutputStream(object):
547
"""Acts like a file, but discard all output."""
549
def __init__(self, encoding):
550
self.encoding = encoding
552
def write(self, data):
555
def writelines(self, data):
added
removed
bzrlib/ui.py
