60
from bzrlib.symbol_versioning import (
67
_valid_boolean_strings = dict(yes=True, no=False,
70
true=True, false=False)
71
_valid_boolean_strings['1'] = True
72
_valid_boolean_strings['0'] = False
75
def bool_from_string(s, accepted_values=None):
76
"""Returns a boolean if the string can be interpreted as such.
78
Interpret case insensitive strings as booleans. The default values
79
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
80
'off'. Alternative values can be provided with the 'accepted_values'
83
:param s: A string that should be interpreted as a boolean. It should be of
84
type string or unicode.
86
:param accepted_values: An optional dict with accepted strings as keys and
87
True/False as values. The strings will be tested against a lowered
90
:return: True or False for accepted strings, None otherwise.
92
if accepted_values is None:
93
accepted_values = _valid_boolean_strings
95
if type(s) in (str, unicode):
97
val = accepted_values[s.lower()]
103
class ConfirmationUserInterfacePolicy(object):
104
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
106
def __init__(self, wrapped_ui, default_answer, specific_answers):
107
"""Generate a proxy UI that does no confirmations.
109
:param wrapped_ui: Underlying UIFactory.
110
:param default_answer: Bool for whether requests for
111
confirmation from the user should be noninteractively accepted or
113
:param specific_answers: Map from confirmation_id to bool answer.
115
self.wrapped_ui = wrapped_ui
116
self.default_answer = default_answer
117
self.specific_answers = specific_answers
119
def __getattr__(self, name):
120
return getattr(self.wrapped_ui, name)
123
return '%s(%r, %r, %r)' % (
124
self.__class__.__name__,
127
self.specific_answers)
129
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
130
if confirmation_id in self.specific_answers:
131
return self.specific_answers[confirmation_id]
132
elif self.default_answer is not None:
133
return self.default_answer
135
return self.wrapped_ui.confirm_action(
136
prompt, confirmation_id, prompt_kwargs)
139
46
class UIFactory(object):
142
49
This tells the library how to display things to the user. Through this
143
50
layer different applications can choose the style of UI.
145
UI Factories are also context managers, for some syntactic sugar some users
148
:ivar suppressed_warnings: Identifiers for user warnings that should
152
_user_warning_templates = dict(
153
cross_format_fetch=("Doing on-the-fly conversion from "
154
"%(from_format)s to %(to_format)s.\n"
155
"This may take some time. Upgrade the repositories to the "
156
"same format for better performance."
160
53
def __init__(self):
161
54
self._task_stack = []
162
self.suppressed_warnings = set()
166
"""Context manager entry support.
168
Override in a concrete factory class if initialisation before use is
171
return self # This is bound to the 'as' clause in a with statement.
173
def __exit__(self, exc_type, exc_val, exc_tb):
174
"""Context manager exit support.
176
Override in a concrete factory class if more cleanup than a simple
177
self.clear_term() is needed when the UIFactory is finished with.
180
return False # propogate exceptions.
182
def be_quiet(self, state):
183
"""Tell the UI to be more quiet, or not.
185
Typically this suppresses progress bars; the application may also look
186
at ui_factory.is_quiet().
190
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
191
"""Seek user confirmation for an action.
193
If the UI is noninteractive, or the user does not want to be asked
194
about this action, True is returned, indicating bzr should just
197
The confirmation id allows the user to configure certain actions to
198
always be confirmed or always denied, and for UIs to specialize the
199
display of particular confirmations.
201
:param prompt: Suggested text to display to the user.
202
:param prompt_kwargs: A dictionary of arguments that can be
203
string-interpolated into the prompt.
204
:param confirmation_id: Unique string identifier for the confirmation.
206
return self.get_boolean(prompt % prompt_kwargs)
208
56
def get_password(self, prompt='', **kwargs):
209
57
"""Prompt the user for a password.
370
def log_transport_activity(self, display=False):
371
"""Write out whatever transport activity has been measured.
373
Implementations are allowed to do nothing, but it is useful if they can
374
write a line to the log file.
376
:param display: If False, only log to disk, if True also try to display
377
a message to the user.
380
# Default implementation just does nothing
383
def show_user_warning(self, warning_id, **message_args):
384
"""Show a warning to the user.
386
This is specifically for things that are under the user's control (eg
387
outdated formats), not for internal program warnings like deprecated
390
This can be overridden by UIFactory subclasses to show it in some
391
appropriate way; the default UIFactory is noninteractive and does
392
nothing. format_user_warning maps it to a string, though other
393
presentations can be used for particular UIs.
395
:param warning_id: An identifier like 'cross_format_fetch' used to
396
check if the message is suppressed and to look up the string.
397
:param message_args: Arguments to be interpolated into the message.
401
def show_error(self, msg):
402
"""Show an error message (not an exception) to the user.
404
The message should not have an error prefix or trailing newline. That
405
will be added by the factory if appropriate.
407
raise NotImplementedError(self.show_error)
409
def show_message(self, msg):
410
"""Show a message to the user."""
411
raise NotImplementedError(self.show_message)
413
def show_warning(self, msg):
414
"""Show a warning to the user."""
415
raise NotImplementedError(self.show_warning)
417
def warn_cross_format_fetch(self, from_format, to_format):
418
"""Warn about a potentially slow cross-format transfer.
420
This is deprecated in favor of show_user_warning, but retained for api
421
compatibility in 2.0 and 2.1.
423
self.show_user_warning('cross_format_fetch', from_format=from_format,
426
def warn_experimental_format_fetch(self, inter):
427
"""Warn about fetching into experimental repository formats."""
428
if inter.target._format.experimental:
429
trace.warning("Fetching into experimental format %s.\n"
430
"This format may be unreliable or change in the future "
431
"without an upgrade path.\n" % (inter.target._format,))
434
class NoninteractiveUIFactory(UIFactory):
435
"""Base class for UIs with no user."""
437
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
441
return '%s()' % (self.__class__.__name__, )
444
class SilentUIFactory(NoninteractiveUIFactory):
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
self.prompt(prompt + "? [y/n]: ")
162
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.stderr.write(prompt)
233
"""Write an already-formatted message."""
234
self.stdout.write(msg + '\n')
237
class SilentUIFactory(CLIUIFactory):
445
238
"""A UI Factory which never prints anything.
447
This is the default UI, if another one is never registered by a program
448
using bzrlib, and it's also active for example inside 'bzr serve'.
450
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.
454
243
def __init__(self):
455
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):
457
255
def note(self, msg):
460
def get_username(self, prompt, **kwargs):
463
def _make_output_stream_explicit(self, encoding, encoding_type):
464
return NullOutputStream(encoding)
466
def show_error(self, msg):
469
def show_message(self, msg):
472
def show_warning(self, msg):
476
class CannedInputUIFactory(SilentUIFactory):
477
"""A silent UI that return canned input."""
479
def __init__(self, responses):
480
self.responses = responses
483
return "%s(%r)" % (self.__class__.__name__, self.responses)
485
def confirm_action(self, prompt, confirmation_id, args):
486
return self.get_boolean(prompt % args)
488
def get_boolean(self, prompt):
489
return self.responses.pop(0)
491
def get_integer(self, prompt):
492
return self.responses.pop(0)
494
def get_password(self, prompt='', **kwargs):
495
return self.responses.pop(0)
497
def get_username(self, prompt, **kwargs):
498
return self.responses.pop(0)
500
def assert_all_input_consumed(self):
502
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)
506
265
ui_factory = SilentUIFactory()
507
# IMPORTANT: never import this symbol directly. ONLY ever access it as
508
# ui.ui_factory, so that you refer to the current value.
266
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
511
270
def make_ui_for_terminal(stdin, stdout, stderr):
512
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.
514
# this is now always TextUIFactory, which in turn decides whether it
515
# should display progress bars etc
516
from bzrlib.ui.text import TextUIFactory
517
return TextUIFactory(stdin, stdout, stderr)
520
class NullProgressView(object):
521
"""Soak up and ignore progress information."""
526
def show_progress(self, task):
529
def show_transport_activity(self, transport, direction, byte_count):
532
def log_transport_activity(self, display=False):
536
class NullOutputStream(object):
537
"""Acts like a file, but discard all output."""
539
def __init__(self, encoding):
540
self.encoding = encoding
542
def write(self, data):
545
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
