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.
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
def show_error(self, msg):
323
"""Show an error message (not an exception) to the user.
325
The message should not have an error prefix or trailing newline. That
326
will be added by the factory if appropriate.
328
raise NotImplementedError(self.show_error)
330
def show_message(self, msg):
331
"""Show a message to the user."""
332
raise NotImplementedError(self.show_message)
334
def show_warning(self, msg):
335
"""Show a warning to the user."""
336
raise NotImplementedError(self.show_warning)
338
211
def warn_cross_format_fetch(self, from_format, to_format):
339
"""Warn about a potentially slow cross-format transfer.
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))
220
class CLIUIFactory(UIFactory):
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)
232
def get_boolean(self, prompt):
234
self.prompt(prompt + "? [y/n]: ")
235
line = self.stdin.readline()
236
line = line.rstrip('\n')
237
val = bool_from_string(line, self._accepted_boolean_strings)
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]
256
def get_password(self, prompt='', **kwargs):
257
"""Prompt the user for a password.
259
:param prompt: The prompt to present the user
260
:param kwargs: Arguments which will be expanded into the prompt.
261
This lets front ends display different things if
263
:return: The password string, return None if the user
264
canceled the request.
267
self.prompt(prompt, **kwargs)
268
# There's currently no way to say 'i decline to enter a password'
269
# as opposed to 'my password is empty' -- does it matter?
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.
341
This is deprecated in favor of show_user_warning, but retained for api
342
compatibility in 2.0 and 2.1.
294
:param kwargs: Dictionary of arguments to insert into the prompt,
295
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,))
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')
356
309
class SilentUIFactory(UIFactory):
397
338
def get_boolean(self, prompt):
398
339
return self.responses.pop(0)
400
def get_integer(self, prompt):
401
return self.responses.pop(0)
403
341
def get_password(self, prompt='', **kwargs):
404
342
return self.responses.pop(0)
406
344
def get_username(self, prompt, **kwargs):
407
345
return self.responses.pop(0)
409
347
def assert_all_input_consumed(self):
410
348
if self.responses:
411
349
raise AssertionError("expected all input in %r to be consumed"
353
@deprecated_function(deprecated_in((1, 18, 0)))
354
def clear_decorator(func, *args, **kwargs):
355
"""Decorator that clears the term"""
356
ui_factory.clear_term()
357
func(*args, **kwargs)
415
360
ui_factory = SilentUIFactory()
416
361
# IMPORTANT: never import this symbol directly. ONLY ever access it as
417
362
# ui.ui_factory, so that you refer to the current value.
added
removed
bzrlib/ui/__init__.py
