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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
This tells the library how to display things to the user. Through this
20
layer different applications can choose the style of UI.
22
At the moment this layer is almost trivial: the application can just
23
choose the style of progress bar.
25
Set the ui_factory member to define the behaviour. The default
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.
31
49
from bzrlib.lazy_import import lazy_import
32
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()]
44
103
class UIFactory(object):
73
131
When the bar has been finished with, it should be released by calling
76
raise NotImplementedError(self.nested_progress_bar)
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.
78
165
def clear_term(self):
79
166
"""Prepare the terminal for output.
81
168
This will, for example, clear text progress bars, and leave the
82
cursor at the leftmost position."""
83
raise NotImplementedError(self.clear_term)
169
cursor at the leftmost position.
85
173
def get_boolean(self, prompt):
86
"""Get a boolean question answered from the user.
174
"""Get a boolean question answered from the user.
88
176
:param prompt: a message to prompt the user with. Should be a single
89
177
line without terminating \n.
104
200
current_format_name,
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.
211
def warn_cross_format_fetch(self, from_format, to_format):
212
"""Warn about a potentially slow cross-format transfer"""
213
# See <https://launchpad.net/bugs/456077> asking for a warning here
214
trace.warning("Doing on-the-fly conversion from %s to %s.\n"
215
"This may take some time. Upgrade the repositories to the "
216
"same format for better performance.\n" %
217
(from_format, to_format))
108
220
class CLIUIFactory(UIFactory):
109
"""Common behaviour for command line UI factories."""
112
super(CLIUIFactory, self).__init__()
113
self.stdin = sys.stdin
221
"""Deprecated in favor of TextUIFactory."""
223
@deprecated_method(deprecated_in((1, 18, 0)))
224
def __init__(self, stdin=None, stdout=None, stderr=None):
225
UIFactory.__init__(self)
226
self.stdin = stdin or sys.stdin
227
self.stdout = stdout or sys.stdout
228
self.stderr = stderr or sys.stderr
230
_accepted_boolean_strings = dict(y=True, n=False, yes=True, no=False)
115
232
def get_boolean(self, prompt):
117
# FIXME: make a regexp and handle case variations as well.
119
234
self.prompt(prompt + "? [y/n]: ")
120
235
line = self.stdin.readline()
121
if line in ('y\n', 'yes\n'):
123
if line in ('n\n', 'no\n'):
236
line = line.rstrip('\n')
237
val = bool_from_string(line, self._accepted_boolean_strings)
126
def get_non_echoed_password(self, prompt):
127
if not sys.stdin.isatty():
128
raise errors.NotATerminal()
129
encoding = osutils.get_terminal_encoding()
130
return getpass.getpass(prompt.encode(encoding, 'replace'))
241
def get_non_echoed_password(self):
242
isatty = getattr(self.stdin, 'isatty', None)
243
if isatty is not None and isatty():
244
# getpass() ensure the password is not echoed and other
245
# cross-platform niceties
246
password = getpass.getpass('')
248
# echo doesn't make sense without a terminal
249
password = self.stdin.readline()
252
elif password[-1] == '\n':
253
password = password[:-1]
132
256
def get_password(self, prompt='', **kwargs):
133
257
"""Prompt the user for a password.
136
260
:param kwargs: Arguments which will be expanded into the prompt.
137
261
This lets front ends display different things if
139
:return: The password string, return None if the user
263
:return: The password string, return None if the user
140
264
canceled the request.
143
prompt = (prompt % kwargs)
267
self.prompt(prompt, **kwargs)
144
268
# There's currently no way to say 'i decline to enter a password'
145
269
# as opposed to 'my password is empty' -- does it matter?
146
return self.get_non_echoed_password(prompt)
148
def prompt(self, prompt):
149
"""Emit prompt on the CLI."""
152
class SilentUIFactory(CLIUIFactory):
270
return self.get_non_echoed_password()
272
def get_username(self, prompt, **kwargs):
273
"""Prompt the user for a username.
275
:param prompt: The prompt to present the user
276
:param kwargs: Arguments which will be expanded into the prompt.
277
This lets front ends display different things if
279
:return: The username string, return None if the user
280
canceled the request.
283
self.prompt(prompt, **kwargs)
284
username = self.stdin.readline()
287
elif username[-1] == '\n':
288
username = username[:-1]
291
def prompt(self, prompt, **kwargs):
292
"""Emit prompt on the CLI.
294
:param kwargs: Dictionary of arguments to insert into the prompt,
295
to allow UIs to reformat the prompt.
298
# See <https://launchpad.net/bugs/365891>
299
prompt = prompt % kwargs
300
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
302
self.stderr.write(prompt)
305
"""Write an already-formatted message."""
306
self.stdout.write(msg + '\n')
309
class SilentUIFactory(UIFactory):
153
310
"""A UI Factory which never prints anything.
155
This is the default UI, if another one is never registered.
312
This is the default UI, if another one is never registered by a program
313
using bzrlib, and it's also active for example inside 'bzr serve'.
315
Methods that try to read from the user raise an error; methods that do
158
def get_password(self, prompt='', **kwargs):
320
UIFactory.__init__(self)
325
def get_username(self, prompt, **kwargs):
161
def nested_progress_bar(self):
162
if self._progress_bar_stack is None:
163
self._progress_bar_stack = progress.ProgressBarStack(
164
klass=progress.DummyProgress)
165
return self._progress_bar_stack.get_nested()
167
def clear_term(self):
170
def recommend_upgrade(self, *args):
329
class CannedInputUIFactory(SilentUIFactory):
330
"""A silent UI that return canned input."""
332
def __init__(self, responses):
333
self.responses = responses
336
return "%s(%r)" % (self.__class__.__name__, self.responses)
338
def get_boolean(self, prompt):
339
return self.responses.pop(0)
341
def get_password(self, prompt='', **kwargs):
342
return self.responses.pop(0)
344
def get_username(self, prompt, **kwargs):
345
return self.responses.pop(0)
347
def assert_all_input_consumed(self):
349
raise AssertionError("expected all input in %r to be consumed"
353
@deprecated_function(deprecated_in((1, 18, 0)))
174
354
def clear_decorator(func, *args, **kwargs):
175
355
"""Decorator that clears the term"""
176
356
ui_factory.clear_term()
180
360
ui_factory = SilentUIFactory()
181
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
361
# IMPORTANT: never import this symbol directly. ONLY ever access it as
362
# ui.ui_factory, so that you refer to the current value.
365
def make_ui_for_terminal(stdin, stdout, stderr):
366
"""Construct and return a suitable UIFactory for a text mode program.
368
# this is now always TextUIFactory, which in turn decides whether it
369
# should display progress bars etc
370
from bzrlib.ui.text import TextUIFactory
371
return TextUIFactory(stdin, stdout, stderr)
374
class NullProgressView(object):
375
"""Soak up and ignore progress information."""
380
def show_progress(self, task):
383
def show_transport_activity(self, transport, direction, byte_count):
added
removed
bzrlib/ui/__init__.py
