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
:ivar suppressed_warnings: Identifiers for user warnings that should
113
_user_warning_templates = dict(
114
cross_format_fetch=("Doing on-the-fly conversion from "
115
"%(from_format)s to %(to_format)s.\n"
116
"This may take some time. Upgrade the repositories to the "
117
"same format for better performance."
121
110
def __init__(self):
122
111
self._task_stack = []
123
self.suppressed_warnings = set()
126
def be_quiet(self, state):
127
"""Tell the UI to be more quiet, or not.
129
Typically this suppresses progress bars; the application may also look
130
at ui_factory.is_quiet().
134
113
def get_password(self, prompt='', **kwargs):
135
114
"""Prompt the user for a password.
147
126
raise NotImplementedError(self.get_password)
152
def make_output_stream(self, encoding=None, encoding_type=None):
153
"""Get a stream for sending out bulk text data.
155
This is used for commands that produce bulk text, such as log or diff
156
output, as opposed to user interaction. This should work even for
157
non-interactive user interfaces. Typically this goes to a decorated
158
version of stdout, but in a GUI it might be appropriate to send it to a
159
window displaying the text.
161
:param encoding: Unicode encoding for output; default is the
162
terminal encoding, which may be different from the user encoding.
163
(See get_terminal_encoding.)
165
:param encoding_type: How to handle encoding errors:
166
replace/strict/escape/exact. Default is replace.
168
# XXX: is the caller supposed to close the resulting object?
170
encoding = osutils.get_terminal_encoding()
171
if encoding_type is None:
172
encoding_type = 'replace'
173
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
176
def _make_output_stream_explicit(self, encoding, encoding_type):
177
raise NotImplementedError("%s doesn't support make_output_stream"
178
% (self.__class__.__name__))
180
128
def nested_progress_bar(self):
181
129
"""Return a nested progress bar.
225
def format_user_warning(self, warning_id, message_args):
227
template = self._user_warning_templates[warning_id]
229
fail = "failed to format warning %r, %r" % (warning_id, message_args)
230
warnings.warn(fail) # so tests will fail etc
233
return template % message_args
234
except ValueError, e:
235
fail = "failed to format warning %r, %r: %s" % (
236
warning_id, message_args, e)
237
warnings.warn(fail) # so tests will fail etc
240
173
def get_boolean(self, prompt):
241
174
"""Get a boolean question answered from the user.
291
def log_transport_activity(self, display=False):
292
"""Write out whatever transport activity has been measured.
294
Implementations are allowed to do nothing, but it is useful if they can
295
write a line to the log file.
297
:param display: If False, only log to disk, if True also try to display
298
a message to the user.
301
# Default implementation just does nothing
304
def show_user_warning(self, warning_id, **message_args):
305
"""Show a warning to the user.
307
This is specifically for things that are under the user's control (eg
308
outdated formats), not for internal program warnings like deprecated
311
This can be overridden by UIFactory subclasses to show it in some
312
appropriate way; the default UIFactory is noninteractive and does
313
nothing. format_user_warning maps it to a string, though other
314
presentations can be used for particular UIs.
316
:param warning_id: An identifier like 'cross_format_fetch' used to
317
check if the message is suppressed and to look up the string.
318
:param message_args: Arguments to be interpolated into the message.
322
211
def show_error(self, msg):
323
212
"""Show an error message (not an exception) to the user.
325
214
The message should not have an error prefix or trailing newline. That
326
will be added by the factory if appropriate.
215
will be added by the factory if appropriate.
328
217
raise NotImplementedError(self.show_error)
335
224
"""Show a warning to the user."""
336
225
raise NotImplementedError(self.show_warning)
338
def warn_cross_format_fetch(self, from_format, to_format):
339
"""Warn about a potentially slow cross-format transfer.
229
class CLIUIFactory(UIFactory):
230
"""Deprecated in favor of TextUIFactory."""
232
@deprecated_method(deprecated_in((1, 18, 0)))
233
def __init__(self, stdin=None, stdout=None, stderr=None):
234
UIFactory.__init__(self)
235
self.stdin = stdin or sys.stdin
236
self.stdout = stdout or sys.stdout
237
self.stderr = stderr or sys.stderr
239
_accepted_boolean_strings = dict(y=True, n=False, yes=True, no=False)
241
def get_boolean(self, prompt):
243
self.prompt(prompt + "? [y/n]: ")
244
line = self.stdin.readline()
245
line = line.rstrip('\n')
246
val = bool_from_string(line, self._accepted_boolean_strings)
250
def get_non_echoed_password(self):
251
isatty = getattr(self.stdin, 'isatty', None)
252
if isatty is not None and isatty():
253
# getpass() ensure the password is not echoed and other
254
# cross-platform niceties
255
password = getpass.getpass('')
257
# echo doesn't make sense without a terminal
258
password = self.stdin.readline()
261
elif password[-1] == '\n':
262
password = password[:-1]
265
def get_password(self, prompt='', **kwargs):
266
"""Prompt the user for a password.
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 password string, return None if the user
273
canceled the request.
276
self.prompt(prompt, **kwargs)
277
# There's currently no way to say 'i decline to enter a password'
278
# as opposed to 'my password is empty' -- does it matter?
279
return self.get_non_echoed_password()
281
def get_username(self, prompt, **kwargs):
282
"""Prompt the user for a username.
284
:param prompt: The prompt to present the user
285
:param kwargs: Arguments which will be expanded into the prompt.
286
This lets front ends display different things if
288
:return: The username string, return None if the user
289
canceled the request.
292
self.prompt(prompt, **kwargs)
293
username = self.stdin.readline()
296
elif username[-1] == '\n':
297
username = username[:-1]
300
def prompt(self, prompt, **kwargs):
301
"""Emit prompt on the CLI.
341
This is deprecated in favor of show_user_warning, but retained for api
342
compatibility in 2.0 and 2.1.
303
:param kwargs: Dictionary of arguments to insert into the prompt,
304
to allow UIs to reformat the prompt.
344
self.show_user_warning('cross_format_fetch', from_format=from_format,
347
def warn_experimental_format_fetch(self, inter):
348
"""Warn about fetching into experimental repository formats."""
349
if inter.target._format.experimental:
350
trace.warning("Fetching into experimental format %s.\n"
351
"This format may be unreliable or change in the future "
352
"without an upgrade path.\n" % (inter.target._format,))
307
# See <https://launchpad.net/bugs/365891>
308
prompt = prompt % kwargs
309
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
311
self.stderr.write(prompt)
314
"""Write an already-formatted message."""
315
self.stdout.write(msg + '\n')
356
318
class SilentUIFactory(UIFactory):
397
356
def get_boolean(self, prompt):
398
357
return self.responses.pop(0)
400
def get_integer(self, prompt):
401
return self.responses.pop(0)
403
359
def get_password(self, prompt='', **kwargs):
404
360
return self.responses.pop(0)
406
362
def get_username(self, prompt, **kwargs):
407
363
return self.responses.pop(0)
409
365
def assert_all_input_consumed(self):
410
366
if self.responses:
411
367
raise AssertionError("expected all input in %r to be consumed"
371
@deprecated_function(deprecated_in((1, 18, 0)))
372
def clear_decorator(func, *args, **kwargs):
373
"""Decorator that clears the term"""
374
ui_factory.clear_term()
375
func(*args, **kwargs)
415
378
ui_factory = SilentUIFactory()
416
379
# IMPORTANT: never import this symbol directly. ONLY ever access it as
417
380
# ui.ui_factory, so that you refer to the current value.
added
removed
bzrlib/ui/__init__.py
