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
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
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)
31
import bzrlib.progress
129
34
class UIFactory(object):
132
37
This tells the library how to display things to the user. Through this
133
38
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"),
158
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
162
self._task_stack = []
163
self.suppressed_warnings = set()
167
"""Context manager entry support.
169
Override in a concrete factory class if initialisation before use is
172
return self # This is bound to the 'as' clause in a with statement.
174
def __exit__(self, exc_type, exc_val, exc_tb):
175
"""Context manager exit support.
177
Override in a concrete factory class if more cleanup than a simple
178
self.clear_term() is needed when the UIFactory is finished with.
181
return False # propogate exceptions.
183
def be_quiet(self, state):
184
"""Tell the UI to be more quiet, or not.
186
Typically this suppresses progress bars; the application may also look
187
at ui_factory.is_quiet().
191
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
192
"""Seek user confirmation for an action.
194
If the UI is noninteractive, or the user does not want to be asked
195
about this action, True is returned, indicating bzr should just
198
The confirmation id allows the user to configure certain actions to
199
always be confirmed or always denied, and for UIs to specialize the
200
display of particular confirmations.
202
:param prompt: Suggested text to display to the user.
203
:param prompt_kwargs: A dictionary of arguments that can be
204
string-interpolated into the prompt.
205
:param confirmation_id: Unique string identifier for the confirmation.
207
return self.get_boolean(prompt % prompt_kwargs)
209
def get_password(self, prompt=u'', **kwargs):
210
"""Prompt the user for a password.
212
:param prompt: The prompt to present the user (must be unicode)
213
:param kwargs: Arguments which will be expanded into the prompt.
214
This lets front ends display different things if
217
:return: The password string, return None if the user canceled the
218
request. Note that we do not touch the encoding, users may
219
have whatever they see fit and the password should be
222
raise NotImplementedError(self.get_password)
227
def make_output_stream(self, encoding=None, encoding_type=None):
228
"""Get a stream for sending out bulk text data.
230
This is used for commands that produce bulk text, such as log or diff
231
output, as opposed to user interaction. This should work even for
232
non-interactive user interfaces. Typically this goes to a decorated
233
version of stdout, but in a GUI it might be appropriate to send it to a
234
window displaying the text.
236
:param encoding: Unicode encoding for output; if not specified
237
uses the configured 'output_encoding' if any; otherwise the
239
(See get_terminal_encoding.)
241
:param encoding_type: How to handle encoding errors:
242
replace/strict/escape/exact. Default is replace.
244
# XXX: is the caller supposed to close the resulting object?
246
from bzrlib import config
247
encoding = config.GlobalConfig().get_user_option(
250
encoding = osutils.get_terminal_encoding(trace=True)
251
if encoding_type is None:
252
encoding_type = 'replace'
253
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
256
def _make_output_stream_explicit(self, encoding, encoding_type):
257
raise NotImplementedError("%s doesn't support make_output_stream"
258
% (self.__class__.__name__))
260
def nested_progress_bar(self):
261
"""Return a nested progress bar.
263
When the bar has been finished with, it should be released by calling
267
t = progress.ProgressTask(self._task_stack[-1], self)
269
t = progress.ProgressTask(None, self)
270
self._task_stack.append(t)
273
def _progress_finished(self, task):
274
"""Called by the ProgressTask when it finishes"""
275
if not self._task_stack:
276
warnings.warn("%r finished but nothing is active"
278
if task in self._task_stack:
279
self._task_stack.remove(task)
281
warnings.warn("%r is not in active stack %r"
282
% (task, self._task_stack))
283
if not self._task_stack:
284
self._progress_all_finished()
286
def _progress_all_finished(self):
287
"""Called when the top-level progress task finished"""
290
def _progress_updated(self, task):
291
"""Called by the ProgressTask when it changes.
293
Should be specialized to draw the progress.
297
def clear_term(self):
298
"""Prepare the terminal for output.
300
This will, for example, clear text progress bars, and leave the
301
cursor at the leftmost position.
305
def format_user_warning(self, warning_id, message_args):
307
template = self._user_warning_templates[warning_id]
309
fail = "bzr warning: %r, %r" % (warning_id, message_args)
310
warnings.warn("no template for warning: " + fail) # so tests will fail etc
313
return template % message_args
314
except ValueError, e:
315
fail = "bzr unprintable warning: %r, %r, %s" % (
316
warning_id, message_args, e)
317
warnings.warn(fail) # so tests will fail etc
320
def get_boolean(self, prompt):
321
"""Get a boolean question answered from the user.
323
:param prompt: a message to prompt the user with. Should be a single
324
line without terminating \\n.
325
:return: True or False for y/yes or n/no.
327
raise NotImplementedError(self.get_boolean)
329
def get_integer(self, prompt):
330
"""Get an integer from the user.
332
:param prompt: a message to prompt the user with. Could be a multi-line
333
prompt but without a terminating \\n.
335
:return: A signed integer.
337
raise NotImplementedError(self.get_integer)
339
def make_progress_view(self):
340
"""Construct a new ProgressView object for this UI.
342
Application code should normally not call this but instead
343
nested_progress_bar().
345
return NullProgressView()
347
def recommend_upgrade(self, current_format_name, basedir):
348
"""Recommend the user upgrade a control directory.
350
:param current_format_name: Description of the current format
351
:param basedir: Location of the control dir
353
self.show_user_warning('recommend_upgrade',
354
current_format_name=current_format_name, basedir=basedir)
356
def report_transport_activity(self, transport, byte_count, direction):
357
"""Called by transports as they do IO.
359
This may update a progress bar, spinner, or similar display.
360
By default it does nothing.
364
def log_transport_activity(self, display=False):
365
"""Write out whatever transport activity has been measured.
367
Implementations are allowed to do nothing, but it is useful if they can
368
write a line to the log file.
370
:param display: If False, only log to disk, if True also try to display
371
a message to the user.
374
# Default implementation just does nothing
377
def show_user_warning(self, warning_id, **message_args):
378
"""Show a warning to the user.
380
This is specifically for things that are under the user's control (eg
381
outdated formats), not for internal program warnings like deprecated
384
This can be overridden by UIFactory subclasses to show it in some
385
appropriate way; the default UIFactory is noninteractive and does
386
nothing. format_user_warning maps it to a string, though other
387
presentations can be used for particular UIs.
389
:param warning_id: An identifier like 'cross_format_fetch' used to
390
check if the message is suppressed and to look up the string.
391
:param message_args: Arguments to be interpolated into the message.
395
def show_error(self, msg):
396
"""Show an error message (not an exception) to the user.
398
The message should not have an error prefix or trailing newline. That
399
will be added by the factory if appropriate.
401
raise NotImplementedError(self.show_error)
403
def show_message(self, msg):
404
"""Show a message to the user."""
405
raise NotImplementedError(self.show_message)
407
def show_warning(self, msg):
408
"""Show a warning to the user."""
409
raise NotImplementedError(self.show_warning)
411
def warn_cross_format_fetch(self, from_format, to_format):
412
"""Warn about a potentially slow cross-format transfer.
414
This is deprecated in favor of show_user_warning, but retained for api
415
compatibility in 2.0 and 2.1.
417
self.show_user_warning('cross_format_fetch', from_format=from_format,
420
def warn_experimental_format_fetch(self, inter):
421
"""Warn about fetching into experimental repository formats."""
422
if inter.target._format.experimental:
423
trace.warning("Fetching into experimental format %s.\n"
424
"This format may be unreliable or change in the future "
425
"without an upgrade path.\n" % (inter.target._format,))
428
class NoninteractiveUIFactory(UIFactory):
429
"""Base class for UIs with no user."""
431
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
435
return '%s()' % (self.__class__.__name__, )
438
class SilentUIFactory(NoninteractiveUIFactory):
40
def progress_bar(self):
41
raise NotImplementedError
44
class SilentUIFactory(UIFactory):
439
45
"""A UI Factory which never prints anything.
441
This is the default UI, if another one is never registered by a program
442
using bzrlib, and it's also active for example inside 'bzr serve'.
444
Methods that try to read from the user raise an error; methods that do
47
This is the default UI, if another one is never registered.
449
UIFactory.__init__(self)
454
def get_username(self, prompt, **kwargs):
457
def _make_output_stream_explicit(self, encoding, encoding_type):
458
return NullOutputStream(encoding)
460
def show_error(self, msg):
463
def show_message(self, msg):
466
def show_warning(self, msg):
470
class CannedInputUIFactory(SilentUIFactory):
471
"""A silent UI that return canned input."""
473
def __init__(self, responses):
474
self.responses = responses
477
return "%s(%r)" % (self.__class__.__name__, self.responses)
479
def confirm_action(self, prompt, confirmation_id, args):
480
return self.get_boolean(prompt % args)
482
def get_boolean(self, prompt):
483
return self.responses.pop(0)
485
def get_integer(self, prompt):
486
return self.responses.pop(0)
488
def get_password(self, prompt=u'', **kwargs):
489
return self.responses.pop(0)
491
def get_username(self, prompt, **kwargs):
492
return self.responses.pop(0)
494
def assert_all_input_consumed(self):
496
raise AssertionError("expected all input in %r to be consumed"
49
def progress_bar(self):
50
return bzrlib.progress.DummyProgress()
500
52
ui_factory = SilentUIFactory()
501
# IMPORTANT: never import this symbol directly. ONLY ever access it as
502
# ui.ui_factory, so that you refer to the current value.
505
def make_ui_for_terminal(stdin, stdout, stderr):
506
"""Construct and return a suitable UIFactory for a text mode program.
508
# this is now always TextUIFactory, which in turn decides whether it
509
# should display progress bars etc
510
from bzrlib.ui.text import TextUIFactory
511
return TextUIFactory(stdin, stdout, stderr)
514
class NullProgressView(object):
515
"""Soak up and ignore progress information."""
520
def show_progress(self, task):
523
def show_transport_activity(self, transport, direction, byte_count):
526
def log_transport_activity(self, display=False):
530
class NullOutputStream(object):
531
"""Acts like a file, but discard all output."""
533
def __init__(self, encoding):
534
self.encoding = encoding
536
def write(self, data):
539
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
