58
_valid_boolean_strings = dict(yes=True, no=False,
61
true=True, false=False)
62
_valid_boolean_strings['1'] = True
63
_valid_boolean_strings['0'] = False
66
def bool_from_string(s, accepted_values=None):
67
"""Returns a boolean if the string can be interpreted as such.
69
Interpret case insensitive strings as booleans. The default values
70
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
71
'off'. Alternative values can be provided with the 'accepted_values'
74
:param s: A string that should be interpreted as a boolean. It should be of
75
type string or unicode.
77
:param accepted_values: An optional dict with accepted strings as keys and
78
True/False as values. The strings will be tested against a lowered
81
:return: True or False for accepted strings, None otherwise.
83
if accepted_values is None:
84
accepted_values = _valid_boolean_strings
86
if type(s) in (str, unicode):
88
val = accepted_values[s.lower()]
94
class ConfirmationUserInterfacePolicy(object):
95
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
97
def __init__(self, wrapped_ui, default_answer, specific_answers):
98
"""Generate a proxy UI that does no confirmations.
100
:param wrapped_ui: Underlying UIFactory.
101
:param default_answer: Bool for whether requests for
102
confirmation from the user should be noninteractively accepted or
104
:param specific_answers: Map from confirmation_id to bool answer.
106
self.wrapped_ui = wrapped_ui
107
self.default_answer = default_answer
108
self.specific_answers = specific_answers
110
def __getattr__(self, name):
111
return getattr(self.wrapped_ui, name)
114
return '%s(%r, %r, %r)' % (
115
self.__class__.__name__,
118
self.specific_answers)
120
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
121
if confirmation_id in self.specific_answers:
122
return self.specific_answers[confirmation_id]
123
elif self.default_answer is not None:
124
return self.default_answer
126
return self.wrapped_ui.confirm_action(
127
prompt, confirmation_id, prompt_kwargs)
46
130
class UIFactory(object):
47
131
"""UI abstraction.
49
133
This tells the library how to display things to the user. Through this
50
134
layer different applications can choose the style of UI.
136
UI Factories are also context managers, for some syntactic sugar some users
139
:ivar suppressed_warnings: Identifiers for user warnings that should
143
_user_warning_templates = dict(
144
cross_format_fetch=("Doing on-the-fly conversion from "
145
"%(from_format)s to %(to_format)s.\n"
146
"This may take some time. Upgrade the repositories to the "
147
"same format for better performance."
149
experimental_format_fetch=("Fetching into experimental format "
151
"This format may be unreliable or change in the future "
152
"without an upgrade path.\n"),
154
"The command 'bzr %(deprecated_name)s' "
155
"has been deprecated in bzr %(deprecated_in_version)s. "
156
"Please use 'bzr %(recommended_name)s' instead."),
157
deprecated_command_option=(
158
"The option '%(deprecated_name)s' to 'bzr %(command)s' "
159
"has been deprecated in bzr %(deprecated_in_version)s. "
160
"Please use '%(recommended_name)s' instead."),
161
recommend_upgrade=("%(current_format_name)s is deprecated "
162
"and a better format is available.\n"
163
"It is recommended that you upgrade by "
164
"running the command\n"
165
" bzr upgrade %(basedir)s"),
167
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
53
170
def __init__(self):
54
171
self._task_stack = []
56
def get_password(self, prompt='', **kwargs):
172
self.suppressed_warnings = set()
176
"""Context manager entry support.
178
Override in a concrete factory class if initialisation before use is
181
return self # This is bound to the 'as' clause in a with statement.
183
def __exit__(self, exc_type, exc_val, exc_tb):
184
"""Context manager exit support.
186
Override in a concrete factory class if more cleanup than a simple
187
self.clear_term() is needed when the UIFactory is finished with.
190
return False # propogate exceptions.
192
def be_quiet(self, state):
193
"""Tell the UI to be more quiet, or not.
195
Typically this suppresses progress bars; the application may also look
196
at ui_factory.is_quiet().
200
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
201
"""Seek user confirmation for an action.
203
If the UI is noninteractive, or the user does not want to be asked
204
about this action, True is returned, indicating bzr should just
207
The confirmation id allows the user to configure certain actions to
208
always be confirmed or always denied, and for UIs to specialize the
209
display of particular confirmations.
211
:param prompt: Suggested text to display to the user.
212
:param prompt_kwargs: A dictionary of arguments that can be
213
string-interpolated into the prompt.
214
:param confirmation_id: Unique string identifier for the confirmation.
216
return self.get_boolean(prompt % prompt_kwargs)
218
def get_password(self, prompt=u'', **kwargs):
57
219
"""Prompt the user for a password.
59
:param prompt: The prompt to present the user
221
:param prompt: The prompt to present the user (must be unicode)
60
222
:param kwargs: Arguments which will be expanded into the prompt.
61
223
This lets front ends display different things if
312
def format_user_warning(self, warning_id, message_args):
314
template = self._user_warning_templates[warning_id]
316
fail = "bzr warning: %r, %r" % (warning_id, message_args)
317
warnings.warn("no template for warning: " + fail) # so tests will fail etc
320
return template % message_args
321
except ValueError, e:
322
fail = "bzr unprintable warning: %r, %r, %s" % (
323
warning_id, message_args, e)
324
warnings.warn(fail) # so tests will fail etc
116
327
def get_boolean(self, prompt):
117
"""Get a boolean question answered from the user.
328
"""Get a boolean question answered from the user.
119
330
:param prompt: a message to prompt the user with. Should be a single
120
line without terminating \n.
331
line without terminating \\n.
121
332
:return: True or False for y/yes or n/no.
123
334
raise NotImplementedError(self.get_boolean)
125
def recommend_upgrade(self,
128
# this should perhaps be in the TextUIFactory and the default can do
130
trace.warning("%s is deprecated "
131
"and a better format is available.\n"
132
"It is recommended that you upgrade by "
133
"running the command\n"
336
def get_integer(self, prompt):
337
"""Get an integer from the user.
339
:param prompt: a message to prompt the user with. Could be a multi-line
340
prompt but without a terminating \\n.
342
:return: A signed integer.
344
raise NotImplementedError(self.get_integer)
346
def make_progress_view(self):
347
"""Construct a new ProgressView object for this UI.
349
Application code should normally not call this but instead
350
nested_progress_bar().
352
return NullProgressView()
354
def recommend_upgrade(self, current_format_name, basedir):
355
"""Recommend the user upgrade a control directory.
357
:param current_format_name: Description of the current format
358
:param basedir: Location of the control dir
360
self.show_user_warning('recommend_upgrade',
361
current_format_name=current_format_name, basedir=basedir)
138
363
def report_transport_activity(self, transport, byte_count, direction):
139
364
"""Called by transports as they do IO.
141
366
This may update a progress bar, spinner, or similar display.
142
367
By default it does nothing.
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):
371
def log_transport_activity(self, display=False):
372
"""Write out whatever transport activity has been measured.
374
Implementations are allowed to do nothing, but it is useful if they can
375
write a line to the log file.
377
:param display: If False, only log to disk, if True also try to display
378
a message to the user.
381
# Default implementation just does nothing
384
def show_user_warning(self, warning_id, **message_args):
385
"""Show a warning to the user.
387
This is specifically for things that are under the user's control (eg
388
outdated formats), not for internal program warnings like deprecated
391
This can be overridden by UIFactory subclasses to show it in some
392
appropriate way; the default UIFactory is noninteractive and does
393
nothing. format_user_warning maps it to a string, though other
394
presentations can be used for particular UIs.
396
:param warning_id: An identifier like 'cross_format_fetch' used to
397
check if the message is suppressed and to look up the string.
398
:param message_args: Arguments to be interpolated into the message.
402
def show_error(self, msg):
403
"""Show an error message (not an exception) to the user.
405
The message should not have an error prefix or trailing newline. That
406
will be added by the factory if appropriate.
408
raise NotImplementedError(self.show_error)
410
def show_message(self, msg):
411
"""Show a message to the user."""
412
raise NotImplementedError(self.show_message)
414
def show_warning(self, msg):
415
"""Show a warning to the user."""
416
raise NotImplementedError(self.show_warning)
419
class NoninteractiveUIFactory(UIFactory):
420
"""Base class for UIs with no user."""
422
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
426
return '%s()' % (self.__class__.__name__, )
429
class SilentUIFactory(NoninteractiveUIFactory):
430
"""A UI Factory which never prints anything.
432
This is the default UI, if another one is never registered by a program
433
using bzrlib, and it's also active for example inside 'bzr serve'.
435
Methods that try to read from the user raise an error; methods that do
154
440
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)
196
442
def note(self, msg):
197
"""Write an already-formatted message."""
198
self.stdout.write(msg + '\n')
201
class SilentUIFactory(CLIUIFactory):
202
"""A UI Factory which never prints anything.
204
This is the default UI, if another one is never registered.
208
CLIUIFactory.__init__(self)
210
def get_password(self, prompt='', **kwargs):
445
def get_username(self, prompt, **kwargs):
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)
448
def _make_output_stream_explicit(self, encoding, encoding_type):
449
return NullOutputStream(encoding)
451
def show_error(self, msg):
454
def show_message(self, msg):
457
def show_warning(self, msg):
461
class CannedInputUIFactory(SilentUIFactory):
462
"""A silent UI that return canned input."""
464
def __init__(self, responses):
465
self.responses = responses
468
return "%s(%r)" % (self.__class__.__name__, self.responses)
470
def confirm_action(self, prompt, confirmation_id, args):
471
return self.get_boolean(prompt % args)
473
def get_boolean(self, prompt):
474
return self.responses.pop(0)
476
def get_integer(self, prompt):
477
return self.responses.pop(0)
479
def get_password(self, prompt=u'', **kwargs):
480
return self.responses.pop(0)
482
def get_username(self, prompt, **kwargs):
483
return self.responses.pop(0)
485
def assert_all_input_consumed(self):
487
raise AssertionError("expected all input in %r to be consumed"
226
491
ui_factory = SilentUIFactory()
227
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
492
# IMPORTANT: never import this symbol directly. ONLY ever access it as
493
# ui.ui_factory, so that you refer to the current value.
231
496
def make_ui_for_terminal(stdin, stdout, stderr):
232
497
"""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.
238
isatty = getattr(stdin, 'isatty', None)
243
elif os.environ.get('TERM') in (None, '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)
499
# this is now always TextUIFactory, which in turn decides whether it
500
# should display progress bars etc
501
from bzrlib.ui.text import TextUIFactory
502
return TextUIFactory(stdin, stdout, stderr)
505
class NullProgressView(object):
506
"""Soak up and ignore progress information."""
511
def show_progress(self, task):
514
def show_transport_activity(self, transport, direction, byte_count):
517
def log_transport_activity(self, display=False):
521
class NullOutputStream(object):
522
"""Acts like a file, but discard all output."""
524
def __init__(self, encoding):
525
self.encoding = encoding
527
def write(self, data):
530
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
