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
49
33
from bzrlib.lazy_import import lazy_import
50
34
lazy_import(globals(), """
53
37
from bzrlib import (
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
45
class UIFactory(object):
147
69
raise NotImplementedError(self.get_password)
152
def make_output_stream(self, encoding=None, encoding_type=None):
153
"""Get a stream for sending out bulk text data.
155
This is used for commands that produce bulk text, such as log or diff
156
output, as opposed to user interaction. This should work even for
157
non-interactive user interfaces. Typically this goes to a decorated
158
version of stdout, but in a GUI it might be appropriate to send it to a
159
window displaying the text.
161
:param encoding: Unicode encoding for output; default is the
162
terminal encoding, which may be different from the user encoding.
163
(See get_terminal_encoding.)
165
:param encoding_type: How to handle encoding errors:
166
replace/strict/escape/exact. Default is replace.
168
# XXX: is the caller supposed to close the resulting object?
170
encoding = osutils.get_terminal_encoding()
171
if encoding_type is None:
172
encoding_type = 'replace'
173
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
176
def _make_output_stream_explicit(self, encoding, encoding_type):
177
raise NotImplementedError("%s doesn't support make_output_stream"
178
% (self.__class__.__name__))
180
71
def nested_progress_bar(self):
181
72
"""Return a nested progress bar.
183
74
When the bar has been finished with, it should be released by calling
187
t = progress.ProgressTask(self._task_stack[-1], self)
189
t = progress.ProgressTask(None, self)
190
self._task_stack.append(t)
193
def _progress_finished(self, task):
194
"""Called by the ProgressTask when it finishes"""
195
if not self._task_stack:
196
warnings.warn("%r finished but nothing is active"
198
if task in self._task_stack:
199
self._task_stack.remove(task)
201
warnings.warn("%r is not in active stack %r"
202
% (task, self._task_stack))
203
if not self._task_stack:
204
self._progress_all_finished()
206
def _progress_all_finished(self):
207
"""Called when the top-level progress task finished"""
210
def _progress_updated(self, task):
211
"""Called by the ProgressTask when it changes.
213
Should be specialized to draw the progress.
77
raise NotImplementedError(self.nested_progress_bar)
217
79
def clear_term(self):
218
80
"""Prepare the terminal for output.
220
82
This will, for example, clear text progress bars, and leave the
221
cursor at the leftmost position.
225
def format_user_warning(self, warning_id, message_args):
227
template = self._user_warning_templates[warning_id]
229
fail = "failed to format warning %r, %r" % (warning_id, message_args)
230
warnings.warn(fail) # so tests will fail etc
233
return template % message_args
234
except ValueError, e:
235
fail = "failed to format warning %r, %r: %s" % (
236
warning_id, message_args, e)
237
warnings.warn(fail) # so tests will fail etc
83
cursor at the leftmost position."""
84
raise NotImplementedError(self.clear_term)
240
86
def get_boolean(self, prompt):
241
"""Get a boolean question answered from the user.
87
"""Get a boolean question answered from the user.
243
89
:param prompt: a message to prompt the user with. Should be a single
244
90
line without terminating \n.
280
105
current_format_name,
283
def report_transport_activity(self, transport, byte_count, direction):
284
"""Called by transports as they do IO.
286
This may update a progress bar, spinner, or similar display.
287
By default it does nothing.
291
def log_transport_activity(self, display=False):
292
"""Write out whatever transport activity has been measured.
294
Implementations are allowed to do nothing, but it is useful if they can
295
write a line to the log file.
297
:param display: If False, only log to disk, if True also try to display
298
a message to the user.
301
# Default implementation just does nothing
304
def show_user_warning(self, warning_id, **message_args):
305
"""Show a warning to the user.
307
This is specifically for things that are under the user's control (eg
308
outdated formats), not for internal program warnings like deprecated
311
This can be overridden by UIFactory subclasses to show it in some
312
appropriate way; the default UIFactory is noninteractive and does
313
nothing. format_user_warning maps it to a string, though other
314
presentations can be used for particular UIs.
316
:param warning_id: An identifier like 'cross_format_fetch' used to
317
check if the message is suppressed and to look up the string.
318
:param message_args: Arguments to be interpolated into the message.
322
def show_error(self, msg):
323
"""Show an error message (not an exception) to the user.
325
The message should not have an error prefix or trailing newline. That
326
will be added by the factory if appropriate.
328
raise NotImplementedError(self.show_error)
330
def show_message(self, msg):
331
"""Show a message to the user."""
332
raise NotImplementedError(self.show_message)
334
def show_warning(self, msg):
335
"""Show a warning to the user."""
336
raise NotImplementedError(self.show_warning)
338
def warn_cross_format_fetch(self, from_format, to_format):
339
"""Warn about a potentially slow cross-format transfer.
341
This is deprecated in favor of show_user_warning, but retained for api
342
compatibility in 2.0 and 2.1.
344
self.show_user_warning('cross_format_fetch', from_format=from_format,
347
def warn_experimental_format_fetch(self, inter):
348
"""Warn about fetching into experimental repository formats."""
349
if inter.target._format.experimental:
350
trace.warning("Fetching into experimental format %s.\n"
351
"This format may be unreliable or change in the future "
352
"without an upgrade path.\n" % (inter.target._format,))
356
class SilentUIFactory(UIFactory):
109
class CLIUIFactory(UIFactory):
110
"""Common behaviour for command line UI factories."""
113
super(CLIUIFactory, self).__init__()
114
self.stdin = sys.stdin
116
def get_boolean(self, prompt):
118
# FIXME: make a regexp and handle case variations as well.
120
self.prompt(prompt + "? [y/n]: ")
121
line = self.stdin.readline()
122
if line in ('y\n', 'yes\n'):
124
if line in ('n\n', 'no\n'):
127
def get_non_echoed_password(self, prompt):
128
encoding = osutils.get_terminal_encoding()
129
return getpass.getpass(prompt.encode(encoding, 'replace'))
131
def get_password(self, prompt='', **kwargs):
132
"""Prompt the user for a password.
134
:param prompt: The prompt to present the user
135
:param kwargs: Arguments which will be expanded into the prompt.
136
This lets front ends display different things if
138
:return: The password string, return None if the user
139
canceled the request.
142
prompt = (prompt % kwargs)
143
# There's currently no way to say 'i decline to enter a password'
144
# as opposed to 'my password is empty' -- does it matter?
145
return self.get_non_echoed_password(prompt)
147
def prompt(self, prompt):
148
"""Emit prompt on the CLI."""
151
class SilentUIFactory(CLIUIFactory):
357
152
"""A UI Factory which never prints anything.
359
This is the default UI, if another one is never registered by a program
360
using bzrlib, and it's also active for example inside 'bzr serve'.
362
Methods that try to read from the user raise an error; methods that do
154
This is the default UI, if another one is never registered.
367
UIFactory.__init__(self)
372
def get_username(self, prompt, **kwargs):
157
def get_password(self, prompt='', **kwargs):
375
def _make_output_stream_explicit(self, encoding, encoding_type):
376
return NullOutputStream(encoding)
378
def show_error(self, msg):
381
def show_message(self, msg):
384
def show_warning(self, msg):
388
class CannedInputUIFactory(SilentUIFactory):
389
"""A silent UI that return canned input."""
391
def __init__(self, responses):
392
self.responses = responses
395
return "%s(%r)" % (self.__class__.__name__, self.responses)
397
def get_boolean(self, prompt):
398
return self.responses.pop(0)
400
def get_integer(self, prompt):
401
return self.responses.pop(0)
403
def get_password(self, prompt='', **kwargs):
404
return self.responses.pop(0)
406
def get_username(self, prompt, **kwargs):
407
return self.responses.pop(0)
409
def assert_all_input_consumed(self):
411
raise AssertionError("expected all input in %r to be consumed"
160
def nested_progress_bar(self):
161
if self._progress_bar_stack is None:
162
self._progress_bar_stack = progress.ProgressBarStack(
163
klass=progress.DummyProgress)
164
return self._progress_bar_stack.get_nested()
166
def clear_term(self):
169
def recommend_upgrade(self, *args):
173
def clear_decorator(func, *args, **kwargs):
174
"""Decorator that clears the term"""
175
ui_factory.clear_term()
176
func(*args, **kwargs)
415
179
ui_factory = SilentUIFactory()
416
# IMPORTANT: never import this symbol directly. ONLY ever access it as
417
# ui.ui_factory, so that you refer to the current value.
420
def make_ui_for_terminal(stdin, stdout, stderr):
421
"""Construct and return a suitable UIFactory for a text mode program.
423
# this is now always TextUIFactory, which in turn decides whether it
424
# should display progress bars etc
425
from bzrlib.ui.text import TextUIFactory
426
return TextUIFactory(stdin, stdout, stderr)
429
class NullProgressView(object):
430
"""Soak up and ignore progress information."""
435
def show_progress(self, task):
438
def show_transport_activity(self, transport, direction, byte_count):
441
def log_transport_activity(self, display=False):
445
class NullOutputStream(object):
446
"""Acts like a file, but discard all output."""
448
def __init__(self, encoding):
449
self.encoding = encoding
451
def write(self, data):
454
def writelines(self, data):
180
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
