1
# Copyright (C) 2005-2010 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.
49
from bzrlib.lazy_import import lazy_import
50
lazy_import(globals(), """
60
from bzrlib.symbol_versioning import (
67
_valid_boolean_strings = dict(yes=True, no=False,
70
true=True, false=False)
71
_valid_boolean_strings['1'] = True
72
_valid_boolean_strings['0'] = False
75
def bool_from_string(s, accepted_values=None):
76
"""Returns a boolean if the string can be interpreted as such.
78
Interpret case insensitive strings as booleans. The default values
79
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
80
'off'. Alternative values can be provided with the 'accepted_values'
83
:param s: A string that should be interpreted as a boolean. It should be of
84
type string or unicode.
86
:param accepted_values: An optional dict with accepted strings as keys and
87
True/False as values. The strings will be tested against a lowered
90
:return: True or False for accepted strings, None otherwise.
92
if accepted_values is None:
93
accepted_values = _valid_boolean_strings
95
if type(s) in (str, unicode):
97
val = accepted_values[s.lower()]
103
class UIFactory(object):
106
This tells the library how to display things to the user. Through this
107
layer different applications can choose the style of UI.
109
UI Factories are also context managers, for some syntactic sugar some users
112
:ivar suppressed_warnings: Identifiers for user warnings that should
116
_user_warning_templates = dict(
117
cross_format_fetch=("Doing on-the-fly conversion from "
118
"%(from_format)s to %(to_format)s.\n"
119
"This may take some time. Upgrade the repositories to the "
120
"same format for better performance."
125
self._task_stack = []
126
self.suppressed_warnings = set()
130
"""Context manager entry support.
132
Override in a concrete factory class if initialisation before use is
135
return self # This is bound to the 'as' clause in a with statement.
137
def __exit__(self, exc_type, exc_val, exc_tb):
138
"""Context manager exit support.
140
Override in a concrete factory class if more cleanup than a simple
141
self.clear_term() is needed when the UIFactory is finished with.
144
return False # propogate exceptions.
146
def be_quiet(self, state):
147
"""Tell the UI to be more quiet, or not.
149
Typically this suppresses progress bars; the application may also look
150
at ui_factory.is_quiet().
154
def get_password(self, prompt='', **kwargs):
155
"""Prompt the user for a password.
157
:param prompt: The prompt to present the user
158
:param kwargs: Arguments which will be expanded into the prompt.
159
This lets front ends display different things if
162
:return: The password string, return None if the user canceled the
163
request. Note that we do not touch the encoding, users may
164
have whatever they see fit and the password should be
167
raise NotImplementedError(self.get_password)
172
def make_output_stream(self, encoding=None, encoding_type=None):
173
"""Get a stream for sending out bulk text data.
175
This is used for commands that produce bulk text, such as log or diff
176
output, as opposed to user interaction. This should work even for
177
non-interactive user interfaces. Typically this goes to a decorated
178
version of stdout, but in a GUI it might be appropriate to send it to a
179
window displaying the text.
181
:param encoding: Unicode encoding for output; if not specified
182
uses the configured 'output_encoding' if any; otherwise the
184
(See get_terminal_encoding.)
186
:param encoding_type: How to handle encoding errors:
187
replace/strict/escape/exact. Default is replace.
189
# XXX: is the caller supposed to close the resulting object?
191
from bzrlib import config
192
encoding = config.GlobalConfig().get_user_option(
195
encoding = osutils.get_terminal_encoding(trace=True)
196
if encoding_type is None:
197
encoding_type = 'replace'
198
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
201
def _make_output_stream_explicit(self, encoding, encoding_type):
202
raise NotImplementedError("%s doesn't support make_output_stream"
203
% (self.__class__.__name__))
205
def nested_progress_bar(self):
206
"""Return a nested progress bar.
208
When the bar has been finished with, it should be released by calling
212
t = progress.ProgressTask(self._task_stack[-1], self)
214
t = progress.ProgressTask(None, self)
215
self._task_stack.append(t)
218
def _progress_finished(self, task):
219
"""Called by the ProgressTask when it finishes"""
220
if not self._task_stack:
221
warnings.warn("%r finished but nothing is active"
223
if task in self._task_stack:
224
self._task_stack.remove(task)
226
warnings.warn("%r is not in active stack %r"
227
% (task, self._task_stack))
228
if not self._task_stack:
229
self._progress_all_finished()
231
def _progress_all_finished(self):
232
"""Called when the top-level progress task finished"""
235
def _progress_updated(self, task):
236
"""Called by the ProgressTask when it changes.
238
Should be specialized to draw the progress.
242
def clear_term(self):
243
"""Prepare the terminal for output.
245
This will, for example, clear text progress bars, and leave the
246
cursor at the leftmost position.
250
def format_user_warning(self, warning_id, message_args):
252
template = self._user_warning_templates[warning_id]
254
fail = "failed to format warning %r, %r" % (warning_id, message_args)
255
warnings.warn(fail) # so tests will fail etc
258
return template % message_args
259
except ValueError, e:
260
fail = "failed to format warning %r, %r: %s" % (
261
warning_id, message_args, e)
262
warnings.warn(fail) # so tests will fail etc
265
def get_boolean(self, prompt):
266
"""Get a boolean question answered from the user.
268
:param prompt: a message to prompt the user with. Should be a single
269
line without terminating \n.
270
:return: True or False for y/yes or n/no.
272
raise NotImplementedError(self.get_boolean)
274
def get_integer(self, prompt):
275
"""Get an integer from the user.
277
:param prompt: a message to prompt the user with. Could be a multi-line
278
prompt but without a terminating \n.
280
:return: A signed integer.
282
raise NotImplementedError(self.get_integer)
284
def make_progress_view(self):
285
"""Construct a new ProgressView object for this UI.
287
Application code should normally not call this but instead
288
nested_progress_bar().
290
return NullProgressView()
292
def recommend_upgrade(self,
295
# XXX: this should perhaps be in the TextUIFactory and the default can do
298
# XXX: Change to show_user_warning - that will accomplish the previous
299
# xxx. -- mbp 2010-02-25
300
trace.warning("%s is deprecated "
301
"and a better format is available.\n"
302
"It is recommended that you upgrade by "
303
"running the command\n"
308
def report_transport_activity(self, transport, byte_count, direction):
309
"""Called by transports as they do IO.
311
This may update a progress bar, spinner, or similar display.
312
By default it does nothing.
316
def log_transport_activity(self, display=False):
317
"""Write out whatever transport activity has been measured.
319
Implementations are allowed to do nothing, but it is useful if they can
320
write a line to the log file.
322
:param display: If False, only log to disk, if True also try to display
323
a message to the user.
326
# Default implementation just does nothing
329
def show_user_warning(self, warning_id, **message_args):
330
"""Show a warning to the user.
332
This is specifically for things that are under the user's control (eg
333
outdated formats), not for internal program warnings like deprecated
336
This can be overridden by UIFactory subclasses to show it in some
337
appropriate way; the default UIFactory is noninteractive and does
338
nothing. format_user_warning maps it to a string, though other
339
presentations can be used for particular UIs.
341
:param warning_id: An identifier like 'cross_format_fetch' used to
342
check if the message is suppressed and to look up the string.
343
:param message_args: Arguments to be interpolated into the message.
347
def show_error(self, msg):
348
"""Show an error message (not an exception) to the user.
350
The message should not have an error prefix or trailing newline. That
351
will be added by the factory if appropriate.
353
raise NotImplementedError(self.show_error)
355
def show_message(self, msg):
356
"""Show a message to the user."""
357
raise NotImplementedError(self.show_message)
359
def show_warning(self, msg):
360
"""Show a warning to the user."""
361
raise NotImplementedError(self.show_warning)
363
def warn_cross_format_fetch(self, from_format, to_format):
364
"""Warn about a potentially slow cross-format transfer.
366
This is deprecated in favor of show_user_warning, but retained for api
367
compatibility in 2.0 and 2.1.
369
self.show_user_warning('cross_format_fetch', from_format=from_format,
372
def warn_experimental_format_fetch(self, inter):
373
"""Warn about fetching into experimental repository formats."""
374
if inter.target._format.experimental:
375
trace.warning("Fetching into experimental format %s.\n"
376
"This format may be unreliable or change in the future "
377
"without an upgrade path.\n" % (inter.target._format,))
380
class SilentUIFactory(UIFactory):
381
"""A UI Factory which never prints anything.
383
This is the default UI, if another one is never registered by a program
384
using bzrlib, and it's also active for example inside 'bzr serve'.
386
Methods that try to read from the user raise an error; methods that do
391
UIFactory.__init__(self)
396
def get_username(self, prompt, **kwargs):
399
def _make_output_stream_explicit(self, encoding, encoding_type):
400
return NullOutputStream(encoding)
402
def show_error(self, msg):
405
def show_message(self, msg):
408
def show_warning(self, msg):
412
class CannedInputUIFactory(SilentUIFactory):
413
"""A silent UI that return canned input."""
415
def __init__(self, responses):
416
self.responses = responses
419
return "%s(%r)" % (self.__class__.__name__, self.responses)
421
def get_boolean(self, prompt):
422
return self.responses.pop(0)
424
def get_integer(self, prompt):
425
return self.responses.pop(0)
427
def get_password(self, prompt='', **kwargs):
428
return self.responses.pop(0)
430
def get_username(self, prompt, **kwargs):
431
return self.responses.pop(0)
433
def assert_all_input_consumed(self):
435
raise AssertionError("expected all input in %r to be consumed"
439
ui_factory = SilentUIFactory()
440
# IMPORTANT: never import this symbol directly. ONLY ever access it as
441
# ui.ui_factory, so that you refer to the current value.
444
def make_ui_for_terminal(stdin, stdout, stderr):
445
"""Construct and return a suitable UIFactory for a text mode program.
447
# this is now always TextUIFactory, which in turn decides whether it
448
# should display progress bars etc
449
from bzrlib.ui.text import TextUIFactory
450
return TextUIFactory(stdin, stdout, stderr)
453
class NullProgressView(object):
454
"""Soak up and ignore progress information."""
459
def show_progress(self, task):
462
def show_transport_activity(self, transport, direction, byte_count):
465
def log_transport_activity(self, display=False):
469
class NullOutputStream(object):
470
"""Acts like a file, but discard all output."""
472
def __init__(self, encoding):
473
self.encoding = encoding
475
def write(self, data):
478
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
