1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
29
Produces no output and cannot take any input; useful for programs using
30
bzrlib in batch mode or for programs such as loggerhead.
33
For use in testing; the input values to be returned are provided
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
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()]
33
import bzrlib.progress
34
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
103
37
class UIFactory(object):
117
57
:param kwargs: Arguments which will be expanded into the prompt.
118
58
This lets front ends display different things if
121
:return: The password string, return None if the user canceled the
122
request. Note that we do not touch the encoding, users may
123
have whatever they see fit and the password should be
60
:return: The password string, return None if the user
126
63
raise NotImplementedError(self.get_password)
128
65
def nested_progress_bar(self):
129
66
"""Return a nested progress bar.
131
When the bar has been finished with, it should be released by calling
68
When the bar has been finished with, it should be released bu calling
135
t = progress.ProgressTask(self._task_stack[-1], self)
137
t = progress.ProgressTask(None, self)
138
self._task_stack.append(t)
141
def _progress_finished(self, task):
142
"""Called by the ProgressTask when it finishes"""
143
if not self._task_stack:
144
warnings.warn("%r finished but nothing is active"
146
elif task != self._task_stack[-1]:
147
warnings.warn("%r is not the active task %r"
148
% (task, self._task_stack[-1]))
150
del self._task_stack[-1]
151
if not self._task_stack:
152
self._progress_all_finished()
154
def _progress_all_finished(self):
155
"""Called when the top-level progress task finished"""
158
def _progress_updated(self, task):
159
"""Called by the ProgressTask when it changes.
161
Should be specialized to draw the progress.
71
raise NotImplementedError(self.nested_progress_bar)
165
73
def clear_term(self):
166
74
"""Prepare the terminal for output.
168
76
This will, for example, clear text progress bars, and leave the
169
cursor at the leftmost position.
77
cursor at the leftmost position."""
78
raise NotImplementedError(self.clear_term)
173
80
def get_boolean(self, prompt):
174
"""Get a boolean question answered from the user.
81
"""Get a boolean question answered from the user.
176
83
:param prompt: a message to prompt the user with. Should be a single
177
84
line without terminating \n.
180
87
raise NotImplementedError(self.get_boolean)
182
def make_progress_view(self):
183
"""Construct a new ProgressView object for this UI.
185
Application code should normally not call this but instead
186
nested_progress_bar().
188
return NullProgressView()
190
def recommend_upgrade(self,
193
# this should perhaps be in the TextUIFactory and the default can do
195
trace.warning("%s is deprecated "
196
"and a better format is available.\n"
197
"It is recommended that you upgrade by "
198
"running the command\n"
203
def report_transport_activity(self, transport, byte_count, direction):
204
"""Called by transports as they do IO.
206
This may update a progress bar, spinner, or similar display.
207
By default it does nothing.
213
90
class CLIUIFactory(UIFactory):
214
"""Deprecated in favor of TextUIFactory."""
216
@deprecated_method(deprecated_in((1, 18, 0)))
217
def __init__(self, stdin=None, stdout=None, stderr=None):
218
UIFactory.__init__(self)
219
self.stdin = stdin or sys.stdin
220
self.stdout = stdout or sys.stdout
221
self.stderr = stderr or sys.stderr
223
_accepted_boolean_strings = dict(y=True, n=False, yes=True, no=False)
91
"""Common behaviour for command line UI factories."""
94
super(CLIUIFactory, self).__init__()
95
self.stdin = sys.stdin
225
97
def get_boolean(self, prompt):
99
# FIXME: make a regexp and handle case variations as well.
227
self.prompt(prompt + "? [y/n]: ")
228
102
line = self.stdin.readline()
229
line = line.rstrip('\n')
230
val = bool_from_string(line, self._accepted_boolean_strings)
234
def get_non_echoed_password(self):
235
isatty = getattr(self.stdin, 'isatty', None)
236
if isatty is not None and isatty():
237
# getpass() ensure the password is not echoed and other
238
# cross-platform niceties
239
password = getpass.getpass('')
241
# echo doesn't make sense without a terminal
242
password = self.stdin.readline()
245
elif password[-1] == '\n':
246
password = password[:-1]
249
def get_password(self, prompt='', **kwargs):
250
"""Prompt the user for a password.
252
:param prompt: The prompt to present the user
253
:param kwargs: Arguments which will be expanded into the prompt.
254
This lets front ends display different things if
256
:return: The password string, return None if the user
257
canceled the request.
260
self.prompt(prompt, **kwargs)
261
# There's currently no way to say 'i decline to enter a password'
262
# as opposed to 'my password is empty' -- does it matter?
263
return self.get_non_echoed_password()
265
def get_username(self, prompt, **kwargs):
266
"""Prompt the user for a username.
268
:param prompt: The prompt to present the user
269
:param kwargs: Arguments which will be expanded into the prompt.
270
This lets front ends display different things if
272
:return: The username string, return None if the user
273
canceled the request.
276
self.prompt(prompt, **kwargs)
277
username = self.stdin.readline()
280
elif username[-1] == '\n':
281
username = username[:-1]
284
def prompt(self, prompt, **kwargs):
285
"""Emit prompt on the CLI.
287
:param kwargs: Dictionary of arguments to insert into the prompt,
288
to allow UIs to reformat the prompt.
291
# See <https://launchpad.net/bugs/365891>
292
prompt = prompt % kwargs
293
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
295
self.stderr.write(prompt)
298
"""Write an already-formatted message."""
299
self.stdout.write(msg + '\n')
302
class SilentUIFactory(UIFactory):
103
if line in ('y\n', 'yes\n'):
105
if line in ('n\n', 'no\n'):
108
def prompt(self, prompt):
109
"""Emit prompt on the CLI."""
112
class SilentUIFactory(CLIUIFactory):
303
113
"""A UI Factory which never prints anything.
305
This is the default UI, if another one is never registered by a program
306
using bzrlib, and it's also active for example inside 'bzr serve'.
308
Methods that try to read from the user raise an error; methods that do
115
This is the default UI, if another one is never registered.
313
UIFactory.__init__(self)
318
def get_username(self, prompt, **kwargs):
118
@deprecated_method(zero_eight)
119
def progress_bar(self):
120
"""See UIFactory.nested_progress_bar()."""
121
return bzrlib.progress.DummyProgress()
123
def get_password(self, prompt='', **kwargs):
322
class CannedInputUIFactory(SilentUIFactory):
323
"""A silent UI that return canned input."""
325
def __init__(self, responses):
326
self.responses = responses
329
return "%s(%r)" % (self.__class__.__name__, self.responses)
331
def get_boolean(self, prompt):
332
return self.responses.pop(0)
334
def get_password(self, prompt='', **kwargs):
335
return self.responses.pop(0)
337
def get_username(self, prompt, **kwargs):
338
return self.responses.pop(0)
340
def assert_all_input_consumed(self):
342
raise AssertionError("expected all input in %r to be consumed"
346
@deprecated_function(deprecated_in((1, 18, 0)))
126
def nested_progress_bar(self):
127
if self._progress_bar_stack is None:
128
self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
129
klass=bzrlib.progress.DummyProgress)
130
return self._progress_bar_stack.get_nested()
132
def clear_term(self):
347
136
def clear_decorator(func, *args, **kwargs):
348
137
"""Decorator that clears the term"""
349
138
ui_factory.clear_term()
added
removed
bzrlib/ui/__init__.py
