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()]
43
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
103
46
class UIFactory(object):
135
75
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
77
def nested_progress_bar(self):
169
78
"""Return a nested progress bar.
171
80
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.
83
raise NotImplementedError(self.nested_progress_bar)
205
85
def clear_term(self):
206
86
"""Prepare the terminal for output.
208
88
This will, for example, clear text progress bars, and leave the
209
cursor at the leftmost position.
89
cursor at the leftmost position."""
90
raise NotImplementedError(self.clear_term)
213
92
def get_boolean(self, prompt):
214
"""Get a boolean question answered from the user.
93
"""Get a boolean question answered from the user.
216
95
:param prompt: a message to prompt the user with. Should be a single
217
96
line without terminating \n.
250
111
current_format_name,
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)
290
def warn_cross_format_fetch(self, from_format, to_format):
291
"""Warn about a potentially slow cross-format transfer"""
292
# See <https://launchpad.net/bugs/456077> asking for a warning here
293
trace.warning("Doing on-the-fly conversion from %s to %s.\n"
294
"This may take some time. Upgrade the repositories to the "
295
"same format for better performance.\n" %
296
(from_format, to_format))
299
class SilentUIFactory(UIFactory):
115
class CLIUIFactory(UIFactory):
116
"""Common behaviour for command line UI factories."""
119
super(CLIUIFactory, self).__init__()
120
self.stdin = sys.stdin
122
def get_boolean(self, prompt):
124
# FIXME: make a regexp and handle case variations as well.
126
self.prompt(prompt + "? [y/n]: ")
127
line = self.stdin.readline()
128
if line in ('y\n', 'yes\n'):
130
if line in ('n\n', 'no\n'):
133
def get_non_echoed_password(self, prompt):
134
return getpass.getpass(prompt)
136
def get_password(self, prompt='', **kwargs):
137
"""Prompt the user for a password.
139
:param prompt: The prompt to present the user
140
:param kwargs: Arguments which will be expanded into the prompt.
141
This lets front ends display different things if
143
:return: The password string, return None if the user
144
canceled the request.
147
prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
148
# There's currently no way to say 'i decline to enter a password'
149
# as opposed to 'my password is empty' -- does it matter?
150
return self.get_non_echoed_password(prompt)
152
def prompt(self, prompt):
153
"""Emit prompt on the CLI."""
156
class SilentUIFactory(CLIUIFactory):
300
157
"""A UI Factory which never prints anything.
302
This is the default UI, if another one is never registered by a program
303
using bzrlib, and it's also active for example inside 'bzr serve'.
305
Methods that try to read from the user raise an error; methods that do
159
This is the default UI, if another one is never registered.
310
UIFactory.__init__(self)
315
def get_username(self, prompt, **kwargs):
162
@deprecated_method(zero_eight)
163
def progress_bar(self):
164
"""See UIFactory.nested_progress_bar()."""
165
return progress.DummyProgress()
167
def get_password(self, prompt='', **kwargs):
318
def _make_output_stream_explicit(self, encoding, encoding_type):
319
return NullOutputStream(encoding)
321
def show_error(self, msg):
324
def show_message(self, msg):
327
def show_warning(self, msg):
331
class CannedInputUIFactory(SilentUIFactory):
332
"""A silent UI that return canned input."""
334
def __init__(self, responses):
335
self.responses = responses
338
return "%s(%r)" % (self.__class__.__name__, self.responses)
340
def get_boolean(self, prompt):
341
return self.responses.pop(0)
343
def get_integer(self, prompt):
344
return self.responses.pop(0)
346
def get_password(self, prompt='', **kwargs):
347
return self.responses.pop(0)
349
def get_username(self, prompt, **kwargs):
350
return self.responses.pop(0)
352
def assert_all_input_consumed(self):
354
raise AssertionError("expected all input in %r to be consumed"
170
def nested_progress_bar(self):
171
if self._progress_bar_stack is None:
172
self._progress_bar_stack = progress.ProgressBarStack(
173
klass=progress.DummyProgress)
174
return self._progress_bar_stack.get_nested()
176
def clear_term(self):
179
def recommend_upgrade(self, *args):
183
def clear_decorator(func, *args, **kwargs):
184
"""Decorator that clears the term"""
185
ui_factory.clear_term()
186
func(*args, **kwargs)
358
189
ui_factory = SilentUIFactory()
359
# IMPORTANT: never import this symbol directly. ONLY ever access it as
360
# ui.ui_factory, so that you refer to the current value.
363
def make_ui_for_terminal(stdin, stdout, stderr):
364
"""Construct and return a suitable UIFactory for a text mode program.
366
# this is now always TextUIFactory, which in turn decides whether it
367
# should display progress bars etc
368
from bzrlib.ui.text import TextUIFactory
369
return TextUIFactory(stdin, stdout, stderr)
372
class NullProgressView(object):
373
"""Soak up and ignore progress information."""
378
def show_progress(self, task):
381
def show_transport_activity(self, transport, direction, byte_count):
384
def log_transport_activity(self, display=False):
388
class NullOutputStream(object):
389
"""Acts like a file, but discard all output."""
391
def __init__(self, encoding):
392
self.encoding = encoding
394
def write(self, data):
397
def writelines(self, data):
190
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
