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):
148
class CLIUIFactory(UIFactory):
149
"""Common behaviour for command line UI factories.
151
This is suitable for dumb terminals that can't repaint existing text."""
153
def __init__(self, stdin=None, stdout=None, stderr=None):
154
UIFactory.__init__(self)
155
self.stdin = stdin or sys.stdin
156
self.stdout = stdout or sys.stdout
157
self.stderr = stderr or sys.stderr
159
def get_boolean(self, prompt):
160
# FIXME: make a regexp and handle case variations as well.
162
self.prompt(prompt + "? [y/n]: ")
163
line = self.stdin.readline()
164
if line in ('y\n', 'yes\n'):
166
if line in ('n\n', 'no\n'):
169
def get_non_echoed_password(self):
170
isatty = getattr(self.stdin, 'isatty', None)
171
if isatty is not None and isatty():
172
# getpass() ensure the password is not echoed and other
173
# cross-platform niceties
174
password = getpass.getpass('')
176
# echo doesn't make sense without a terminal
177
password = self.stdin.readline()
180
elif password[-1] == '\n':
181
password = password[:-1]
184
def get_password(self, prompt='', **kwargs):
185
"""Prompt the user for a password.
187
:param prompt: The prompt to present the user
188
:param kwargs: Arguments which will be expanded into the prompt.
189
This lets front ends display different things if
191
:return: The password string, return None if the user
192
canceled the request.
195
self.prompt(prompt, **kwargs)
196
# There's currently no way to say 'i decline to enter a password'
197
# as opposed to 'my password is empty' -- does it matter?
198
return self.get_non_echoed_password()
200
def get_username(self, prompt, **kwargs):
201
"""Prompt the user for a username.
203
:param prompt: The prompt to present the user
204
:param kwargs: Arguments which will be expanded into the prompt.
205
This lets front ends display different things if
207
:return: The username string, return None if the user
208
canceled the request.
211
self.prompt(prompt, **kwargs)
212
username = self.stdin.readline()
215
elif username[-1] == '\n':
216
username = username[:-1]
219
def prompt(self, prompt, **kwargs):
220
"""Emit prompt on the CLI.
222
:param kwargs: Dictionary of arguments to insert into the prompt,
223
to allow UIs to reformat the prompt.
226
# See <https://launchpad.net/bugs/365891>
227
prompt = prompt % kwargs
228
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
230
self.stdout.write(prompt)
233
"""Write an already-formatted message."""
234
self.stdout.write(msg + '\n')
237
class SilentUIFactory(CLIUIFactory):
357
238
"""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
240
This is the default UI, if another one is never registered.
366
243
def __init__(self):
367
UIFactory.__init__(self)
244
CLIUIFactory.__init__(self)
246
def get_password(self, prompt='', **kwargs):
249
def get_username(self, prompt='', **kwargs):
252
def prompt(self, prompt, **kwargs):
369
255
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"
259
def clear_decorator(func, *args, **kwargs):
260
"""Decorator that clears the term"""
261
ui_factory.clear_term()
262
func(*args, **kwargs)
415
265
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.
266
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
420
270
def make_ui_for_terminal(stdin, stdout, stderr):
421
271
"""Construct and return a suitable UIFactory for a text mode program.
273
If stdout is a smart terminal, this gets a smart UIFactory with
274
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):
277
isatty = getattr(stdin, 'isatty', None)
282
elif os.environ.get('TERM') in ('dumb', ''):
283
# e.g. emacs compile window
285
# User may know better, otherwise default to TextUIFactory
286
if ( os.environ.get('BZR_USE_TEXT_UI', None) is not None
288
from bzrlib.ui.text import TextUIFactory
290
return cls(stdin=stdin, stdout=stdout, stderr=stderr)
added
removed
bzrlib/ui/__init__.py
