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
def warn_cross_format_fetch(self, from_format, to_format):
339
"""Warn about a potentially slow cross-format transfer.
341
This is deprecated in favor of show_user_warning, but retained for api
342
compatibility in 2.0 and 2.1.
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,))
356
class SilentUIFactory(UIFactory):
184
class CLIUIFactory(UIFactory):
185
"""Common behaviour for command line UI factories.
187
This is suitable for dumb terminals that can't repaint existing text."""
189
def __init__(self, stdin=None, stdout=None, stderr=None):
190
UIFactory.__init__(self)
191
self.stdin = stdin or sys.stdin
192
self.stdout = stdout or sys.stdout
193
self.stderr = stderr or sys.stderr
195
_accepted_boolean_strings = dict(y=True, n=False, yes=True, no=False)
197
def get_boolean(self, prompt):
199
self.prompt(prompt + "? [y/n]: ")
200
line = self.stdin.readline()
201
line = line.rstrip('\n')
202
val = bool_from_string(line, self._accepted_boolean_strings)
206
def get_non_echoed_password(self):
207
isatty = getattr(self.stdin, 'isatty', None)
208
if isatty is not None and isatty():
209
# getpass() ensure the password is not echoed and other
210
# cross-platform niceties
211
password = getpass.getpass('')
213
# echo doesn't make sense without a terminal
214
password = self.stdin.readline()
217
elif password[-1] == '\n':
218
password = password[:-1]
221
def get_password(self, prompt='', **kwargs):
222
"""Prompt the user for a password.
224
:param prompt: The prompt to present the user
225
:param kwargs: Arguments which will be expanded into the prompt.
226
This lets front ends display different things if
228
:return: The password string, return None if the user
229
canceled the request.
232
self.prompt(prompt, **kwargs)
233
# There's currently no way to say 'i decline to enter a password'
234
# as opposed to 'my password is empty' -- does it matter?
235
return self.get_non_echoed_password()
237
def get_username(self, prompt, **kwargs):
238
"""Prompt the user for a username.
240
:param prompt: The prompt to present the user
241
:param kwargs: Arguments which will be expanded into the prompt.
242
This lets front ends display different things if
244
:return: The username string, return None if the user
245
canceled the request.
248
self.prompt(prompt, **kwargs)
249
username = self.stdin.readline()
252
elif username[-1] == '\n':
253
username = username[:-1]
256
def prompt(self, prompt, **kwargs):
257
"""Emit prompt on the CLI.
259
:param kwargs: Dictionary of arguments to insert into the prompt,
260
to allow UIs to reformat the prompt.
263
# See <https://launchpad.net/bugs/365891>
264
prompt = prompt % kwargs
265
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
267
self.stderr.write(prompt)
270
"""Write an already-formatted message."""
271
self.stdout.write(msg + '\n')
274
class SilentUIFactory(CLIUIFactory):
357
275
"""A UI Factory which never prints anything.
359
This is the default UI, if another one is never registered by a program
360
using bzrlib, and it's also active for example inside 'bzr serve'.
362
Methods that try to read from the user raise an error; methods that do
277
This is the default UI, if another one is never registered.
366
280
def __init__(self):
367
UIFactory.__init__(self)
281
CLIUIFactory.__init__(self)
283
def get_password(self, prompt='', **kwargs):
286
def get_username(self, prompt='', **kwargs):
289
def prompt(self, prompt, **kwargs):
369
292
def note(self, msg):
372
def get_username(self, prompt, **kwargs):
375
def _make_output_stream_explicit(self, encoding, encoding_type):
376
return NullOutputStream(encoding)
378
def show_error(self, msg):
381
def show_message(self, msg):
384
def show_warning(self, msg):
388
class CannedInputUIFactory(SilentUIFactory):
389
"""A silent UI that return canned input."""
391
def __init__(self, responses):
392
self.responses = responses
395
return "%s(%r)" % (self.__class__.__name__, self.responses)
397
def get_boolean(self, prompt):
398
return self.responses.pop(0)
400
def get_integer(self, prompt):
401
return self.responses.pop(0)
403
def get_password(self, prompt='', **kwargs):
404
return self.responses.pop(0)
406
def get_username(self, prompt, **kwargs):
407
return self.responses.pop(0)
409
def assert_all_input_consumed(self):
411
raise AssertionError("expected all input in %r to be consumed"
296
def clear_decorator(func, *args, **kwargs):
297
"""Decorator that clears the term"""
298
ui_factory.clear_term()
299
func(*args, **kwargs)
415
302
ui_factory = SilentUIFactory()
416
# IMPORTANT: never import this symbol directly. ONLY ever access it as
417
# ui.ui_factory, so that you refer to the current value.
303
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
420
307
def make_ui_for_terminal(stdin, stdout, stderr):
421
308
"""Construct and return a suitable UIFactory for a text mode program.
310
If stdout is a smart terminal, this gets a smart UIFactory with
311
progress indicators, etc. If it's a dumb terminal, just plain text output.
423
# this is now always TextUIFactory, which in turn decides whether it
424
# should display progress bars etc
425
from bzrlib.ui.text import TextUIFactory
426
return TextUIFactory(stdin, stdout, stderr)
429
class NullProgressView(object):
430
"""Soak up and ignore progress information."""
435
def show_progress(self, task):
438
def show_transport_activity(self, transport, direction, byte_count):
441
def log_transport_activity(self, display=False):
445
class NullOutputStream(object):
446
"""Acts like a file, but discard all output."""
448
def __init__(self, encoding):
449
self.encoding = encoding
451
def write(self, data):
454
def writelines(self, data):
314
isatty = getattr(stdin, 'isatty', None)
319
elif os.environ.get('TERM') in ('dumb', ''):
320
# e.g. emacs compile window
322
# User may know better, otherwise default to TextUIFactory
323
if ( os.environ.get('BZR_USE_TEXT_UI', None) is not None
325
from bzrlib.ui.text import TextUIFactory
327
return cls(stdin=stdin, stdout=stdout, stderr=stderr)
added
removed
bzrlib/ui/__init__.py
