106
106
This tells the library how to display things to the user. Through this
107
107
layer different applications can choose the style of UI.
109
UI Factories are also context managers, for some syntactic sugar some users
112
:ivar suppressed_warnings: Identifiers for user warnings that should
116
_user_warning_templates = dict(
117
cross_format_fetch=("Doing on-the-fly conversion from "
118
"%(from_format)s to %(to_format)s.\n"
119
"This may take some time. Upgrade the repositories to the "
120
"same format for better performance."
124
110
def __init__(self):
125
111
self._task_stack = []
126
self.suppressed_warnings = set()
130
"""Context manager entry support.
132
Override in a concrete factory class if initialisation before use is
135
return self # This is bound to the 'as' clause in a with statement.
137
def __exit__(self, exc_type, exc_val, exc_tb):
138
"""Context manager exit support.
140
Override in a concrete factory class if more cleanup than a simple
141
self.clear_term() is needed when the UIFactory is finished with.
144
return False # propogate exceptions.
146
def be_quiet(self, state):
147
"""Tell the UI to be more quiet, or not.
149
Typically this suppresses progress bars; the application may also look
150
at ui_factory.is_quiet().
154
113
def get_password(self, prompt='', **kwargs):
155
114
"""Prompt the user for a password.
167
126
raise NotImplementedError(self.get_password)
172
def make_output_stream(self, encoding=None, encoding_type=None):
173
"""Get a stream for sending out bulk text data.
175
This is used for commands that produce bulk text, such as log or diff
176
output, as opposed to user interaction. This should work even for
177
non-interactive user interfaces. Typically this goes to a decorated
178
version of stdout, but in a GUI it might be appropriate to send it to a
179
window displaying the text.
181
:param encoding: Unicode encoding for output; if not specified
182
uses the configured 'output_encoding' if any; otherwise the
184
(See get_terminal_encoding.)
186
:param encoding_type: How to handle encoding errors:
187
replace/strict/escape/exact. Default is replace.
189
# XXX: is the caller supposed to close the resulting object?
191
from bzrlib import config
192
encoding = config.GlobalConfig().get_user_option(
195
encoding = osutils.get_terminal_encoding(trace=True)
196
if encoding_type is None:
197
encoding_type = 'replace'
198
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
201
def _make_output_stream_explicit(self, encoding, encoding_type):
202
raise NotImplementedError("%s doesn't support make_output_stream"
203
% (self.__class__.__name__))
205
128
def nested_progress_bar(self):
206
129
"""Return a nested progress bar.
316
def log_transport_activity(self, display=False):
317
"""Write out whatever transport activity has been measured.
319
Implementations are allowed to do nothing, but it is useful if they can
320
write a line to the log file.
322
:param display: If False, only log to disk, if True also try to display
323
a message to the user.
326
# Default implementation just does nothing
329
def show_user_warning(self, warning_id, **message_args):
330
"""Show a warning to the user.
332
This is specifically for things that are under the user's control (eg
333
outdated formats), not for internal program warnings like deprecated
336
This can be overridden by UIFactory subclasses to show it in some
337
appropriate way; the default UIFactory is noninteractive and does
338
nothing. format_user_warning maps it to a string, though other
339
presentations can be used for particular UIs.
341
:param warning_id: An identifier like 'cross_format_fetch' used to
342
check if the message is suppressed and to look up the string.
343
:param message_args: Arguments to be interpolated into the message.
347
def show_error(self, msg):
348
"""Show an error message (not an exception) to the user.
350
The message should not have an error prefix or trailing newline. That
351
will be added by the factory if appropriate.
353
raise NotImplementedError(self.show_error)
355
def show_message(self, msg):
356
"""Show a message to the user."""
357
raise NotImplementedError(self.show_message)
359
def show_warning(self, msg):
360
"""Show a warning to the user."""
361
raise NotImplementedError(self.show_warning)
363
def warn_cross_format_fetch(self, from_format, to_format):
364
"""Warn about a potentially slow cross-format transfer.
366
This is deprecated in favor of show_user_warning, but retained for api
367
compatibility in 2.0 and 2.1.
369
self.show_user_warning('cross_format_fetch', from_format=from_format,
372
def warn_experimental_format_fetch(self, inter):
373
"""Warn about fetching into experimental repository formats."""
374
if inter.target._format.experimental:
375
trace.warning("Fetching into experimental format %s.\n"
376
"This format may be unreliable or change in the future "
377
"without an upgrade path.\n" % (inter.target._format,))
213
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)
225
def get_boolean(self, prompt):
227
self.prompt(prompt + "? [y/n]: ")
228
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')
380
302
class SilentUIFactory(UIFactory):
421
331
def get_boolean(self, prompt):
422
332
return self.responses.pop(0)
424
def get_integer(self, prompt):
425
return self.responses.pop(0)
427
334
def get_password(self, prompt='', **kwargs):
428
335
return self.responses.pop(0)
430
337
def get_username(self, prompt, **kwargs):
431
338
return self.responses.pop(0)
433
340
def assert_all_input_consumed(self):
434
341
if self.responses:
435
342
raise AssertionError("expected all input in %r to be consumed"
346
@deprecated_function(deprecated_in((1, 18, 0)))
347
def clear_decorator(func, *args, **kwargs):
348
"""Decorator that clears the term"""
349
ui_factory.clear_term()
350
func(*args, **kwargs)
439
353
ui_factory = SilentUIFactory()
440
354
# IMPORTANT: never import this symbol directly. ONLY ever access it as
441
355
# ui.ui_factory, so that you refer to the current value.
added
removed
bzrlib/ui/__init__.py
