13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Abstraction for interacting with the user.
19
Applications can choose different types of UI, and they deal with displaying
20
messages or progress to the user, and with gathering different types of input.
22
Several levels are supported, and you can also register new factories such as
26
Semi-abstract base class
28
bzrlib.ui.SilentUIFactory
29
Produces no output and cannot take any input; useful for programs using
30
bzrlib in batch mode or for programs such as loggerhead.
32
bzrlib.ui.CannedInputUIFactory
33
For use in testing; the input values to be returned are provided
36
bzrlib.ui.text.TextUIFactory
37
Standard text command-line interface, with stdin, stdout, stderr.
38
May make more or less advanced use of them, eg in drawing progress bars,
39
depending on the detected capabilities of the terminal.
40
GUIs may choose to subclass this so that unimplemented methods fall
41
back to working through the terminal.
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
This tells the library how to display things to the user. Through this
20
layer different applications can choose the style of UI.
22
At the moment this layer is almost trivial: the application can just
23
choose the style of progress bar.
25
Set the ui_factory member to define the behaviour. The default
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,))
380
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):
161
# FIXME: make a regexp and handle case variations as well.
163
self.prompt(prompt + "? [y/n]: ")
164
line = self.stdin.readline()
165
if line in ('y\n', 'yes\n'):
167
if line in ('n\n', 'no\n'):
170
def get_non_echoed_password(self, prompt):
171
if not sys.stdin.isatty():
172
raise errors.NotATerminal()
173
encoding = osutils.get_terminal_encoding()
174
return getpass.getpass(prompt.encode(encoding, 'replace'))
176
def get_password(self, prompt='', **kwargs):
177
"""Prompt the user for a password.
179
:param prompt: The prompt to present the user
180
:param kwargs: Arguments which will be expanded into the prompt.
181
This lets front ends display different things if
183
:return: The password string, return None if the user
184
canceled the request.
187
prompt = (prompt % kwargs)
188
# There's currently no way to say 'i decline to enter a password'
189
# as opposed to 'my password is empty' -- does it matter?
190
return self.get_non_echoed_password(prompt)
192
def prompt(self, prompt):
193
"""Emit prompt on the CLI."""
194
self.stdout.write(prompt)
197
"""Write an already-formatted message."""
198
self.stdout.write(msg + '\n')
201
class SilentUIFactory(CLIUIFactory):
381
202
"""A UI Factory which never prints anything.
383
This is the default UI, if another one is never registered by a program
384
using bzrlib, and it's also active for example inside 'bzr serve'.
386
Methods that try to read from the user raise an error; methods that do
204
This is the default UI, if another one is never registered.
390
207
def __init__(self):
391
UIFactory.__init__(self)
396
def get_username(self, prompt, **kwargs):
208
CLIUIFactory.__init__(self)
210
def get_password(self, prompt='', **kwargs):
399
def _make_output_stream_explicit(self, encoding, encoding_type):
400
return NullOutputStream(encoding)
402
def show_error(self, msg):
405
def show_message(self, msg):
408
def show_warning(self, msg):
412
class CannedInputUIFactory(SilentUIFactory):
413
"""A silent UI that return canned input."""
415
def __init__(self, responses):
416
self.responses = responses
419
return "%s(%r)" % (self.__class__.__name__, self.responses)
421
def get_boolean(self, prompt):
422
return self.responses.pop(0)
424
def get_integer(self, prompt):
425
return self.responses.pop(0)
427
def get_password(self, prompt='', **kwargs):
428
return self.responses.pop(0)
430
def get_username(self, prompt, **kwargs):
431
return self.responses.pop(0)
433
def assert_all_input_consumed(self):
435
raise AssertionError("expected all input in %r to be consumed"
213
def prompt(self, prompt):
220
def clear_decorator(func, *args, **kwargs):
221
"""Decorator that clears the term"""
222
ui_factory.clear_term()
223
func(*args, **kwargs)
439
226
ui_factory = SilentUIFactory()
440
# IMPORTANT: never import this symbol directly. ONLY ever access it as
441
# ui.ui_factory, so that you refer to the current value.
227
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
444
231
def make_ui_for_terminal(stdin, stdout, stderr):
445
232
"""Construct and return a suitable UIFactory for a text mode program.
234
If stdout is a smart terminal, this gets a smart UIFactory with
235
progress indicators, etc. If it's a dumb terminal, just plain text output.
447
# this is now always TextUIFactory, which in turn decides whether it
448
# should display progress bars etc
449
from bzrlib.ui.text import TextUIFactory
450
return TextUIFactory(stdin, stdout, stderr)
453
class NullProgressView(object):
454
"""Soak up and ignore progress information."""
459
def show_progress(self, task):
462
def show_transport_activity(self, transport, direction, byte_count):
465
def log_transport_activity(self, display=False):
469
class NullOutputStream(object):
470
"""Acts like a file, but discard all output."""
472
def __init__(self, encoding):
473
self.encoding = encoding
475
def write(self, data):
478
def writelines(self, data):
238
isatty = getattr(stdin, 'isatty', None)
243
elif os.environ.get('TERM') in ('dumb', ''):
244
# e.g. emacs compile window
246
# User may know better, otherwise default to TextUIFactory
247
if ( os.environ.get('BZR_USE_TEXT_UI', None) is not None
249
from bzrlib.ui.text import TextUIFactory
251
return cls(stdin=stdin, stdout=stdout, stderr=stderr)
added
removed
bzrlib/ui/__init__.py
