1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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.
111
self._task_stack = []
114
def be_quiet(self, state):
115
"""Tell the UI to be more quiet, or not.
117
Typically this suppresses progress bars; the application may also look
118
at ui_factory.is_quiet().
122
def get_password(self, prompt='', **kwargs):
123
"""Prompt the user for a password.
125
:param prompt: The prompt to present the user
126
:param kwargs: Arguments which will be expanded into the prompt.
127
This lets front ends display different things if
130
:return: The password string, return None if the user canceled the
131
request. Note that we do not touch the encoding, users may
132
have whatever they see fit and the password should be
135
raise NotImplementedError(self.get_password)
140
def make_output_stream(self, encoding=None, encoding_type=None):
141
"""Get a stream for sending out bulk text data.
143
This is used for commands that produce bulk text, such as log or diff
144
output, as opposed to user interaction. This should work even for
145
non-interactive user interfaces. Typically this goes to a decorated
146
version of stdout, but in a GUI it might be appropriate to send it to a
147
window displaying the text.
149
:param encoding: Unicode encoding for output; default is the
150
terminal encoding, which may be different from the user encoding.
151
(See get_terminal_encoding.)
153
:param encoding_type: How to handle encoding errors:
154
replace/strict/escape/exact. Default is replace.
156
# XXX: is the caller supposed to close the resulting object?
158
encoding = osutils.get_terminal_encoding()
159
if encoding_type is None:
160
encoding_type = 'replace'
161
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
164
def _make_output_stream_explicit(self, encoding, encoding_type):
165
raise NotImplementedError("%s doesn't support make_output_stream"
166
% (self.__class__.__name__))
168
def nested_progress_bar(self):
169
"""Return a nested progress bar.
171
When the bar has been finished with, it should be released by calling
175
t = progress.ProgressTask(self._task_stack[-1], self)
177
t = progress.ProgressTask(None, self)
178
self._task_stack.append(t)
181
def _progress_finished(self, task):
182
"""Called by the ProgressTask when it finishes"""
183
if not self._task_stack:
184
warnings.warn("%r finished but nothing is active"
186
elif task != self._task_stack[-1]:
187
warnings.warn("%r is not the active task %r"
188
% (task, self._task_stack[-1]))
190
del self._task_stack[-1]
191
if not self._task_stack:
192
self._progress_all_finished()
194
def _progress_all_finished(self):
195
"""Called when the top-level progress task finished"""
198
def _progress_updated(self, task):
199
"""Called by the ProgressTask when it changes.
201
Should be specialized to draw the progress.
205
def clear_term(self):
206
"""Prepare the terminal for output.
208
This will, for example, clear text progress bars, and leave the
209
cursor at the leftmost position.
213
def get_boolean(self, prompt):
214
"""Get a boolean question answered from the user.
216
:param prompt: a message to prompt the user with. Should be a single
217
line without terminating \n.
218
:return: True or False for y/yes or n/no.
220
raise NotImplementedError(self.get_boolean)
222
def get_integer(self, prompt):
223
"""Get an integer from the user.
225
:param prompt: a message to prompt the user with. Could be a multi-line
226
prompt but without a terminating \n.
228
:return: A signed integer.
230
raise NotImplementedError(self.get_integer)
232
def make_progress_view(self):
233
"""Construct a new ProgressView object for this UI.
235
Application code should normally not call this but instead
236
nested_progress_bar().
238
return NullProgressView()
240
def recommend_upgrade(self,
243
# this should perhaps be in the TextUIFactory and the default can do
245
trace.warning("%s is deprecated "
246
"and a better format is available.\n"
247
"It is recommended that you upgrade by "
248
"running the command\n"
253
def report_transport_activity(self, transport, byte_count, direction):
254
"""Called by transports as they do IO.
256
This may update a progress bar, spinner, or similar display.
257
By default it does nothing.
261
def log_transport_activity(self, display=False):
262
"""Write out whatever transport activity has been measured.
264
Implementations are allowed to do nothing, but it is useful if they can
265
write a line to the log file.
267
:param display: If False, only log to disk, if True also try to display
268
a message to the user.
271
# Default implementation just does nothing
274
def show_error(self, msg):
275
"""Show an error message (not an exception) to the user.
277
The message should not have an error prefix or trailing newline. That
278
will be added by the factory if appropriate.
280
raise NotImplementedError(self.show_error)
282
def show_message(self, msg):
283
"""Show a message to the user."""
284
raise NotImplementedError(self.show_message)
286
def show_warning(self, msg):
287
"""Show a warning to the user."""
288
raise NotImplementedError(self.show_warning)
292
class SilentUIFactory(UIFactory):
293
"""A UI Factory which never prints anything.
295
This is the default UI, if another one is never registered by a program
296
using bzrlib, and it's also active for example inside 'bzr serve'.
298
Methods that try to read from the user raise an error; methods that do
303
UIFactory.__init__(self)
308
def get_username(self, prompt, **kwargs):
311
def show_error(self, msg):
314
def show_message(self, msg):
317
def show_warning(self, msg):
321
class CannedInputUIFactory(SilentUIFactory):
322
"""A silent UI that return canned input."""
324
def __init__(self, responses):
325
self.responses = responses
328
return "%s(%r)" % (self.__class__.__name__, self.responses)
330
def get_boolean(self, prompt):
331
return self.responses.pop(0)
333
def get_integer(self, prompt):
334
return self.responses.pop(0)
336
def get_password(self, prompt='', **kwargs):
337
return self.responses.pop(0)
339
def get_username(self, prompt, **kwargs):
340
return self.responses.pop(0)
342
def assert_all_input_consumed(self):
344
raise AssertionError("expected all input in %r to be consumed"
348
ui_factory = SilentUIFactory()
349
# IMPORTANT: never import this symbol directly. ONLY ever access it as
350
# ui.ui_factory, so that you refer to the current value.
353
def make_ui_for_terminal(stdin, stdout, stderr):
354
"""Construct and return a suitable UIFactory for a text mode program.
356
# this is now always TextUIFactory, which in turn decides whether it
357
# should display progress bars etc
358
from bzrlib.ui.text import TextUIFactory
359
return TextUIFactory(stdin, stdout, stderr)
362
class NullProgressView(object):
363
"""Soak up and ignore progress information."""
368
def show_progress(self, task):
371
def show_transport_activity(self, transport, direction, byte_count):
374
def log_transport_activity(self, display=False):
added
removed
bzrlib/ui/__init__.py
