95
class ConfirmationUserInterfacePolicy(object):
96
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
98
def __init__(self, wrapped_ui, default_answer, specific_answers):
99
"""Generate a proxy UI that does no confirmations.
101
:param wrapped_ui: Underlying UIFactory.
102
:param default_answer: Bool for whether requests for
103
confirmation from the user should be noninteractively accepted or
105
:param specific_answers: Map from confirmation_id to bool answer.
107
self.wrapped_ui = wrapped_ui
108
self.default_answer = default_answer
109
self.specific_answers = specific_answers
111
def __getattr__(self, name):
112
return getattr(self.wrapped_ui, name)
115
return '%s(%r, %r, %r)' % (
116
self.__class__.__name__,
119
self.specific_answers)
121
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
122
if confirmation_id in self.specific_answers:
123
return self.specific_answers[confirmation_id]
124
elif self.default_answer is not None:
125
return self.default_answer
127
return self.wrapped_ui.confirm_action(
128
prompt, confirmation_id, prompt_kwargs)
103
131
class UIFactory(object):
104
132
"""UI abstraction.
106
134
This tells the library how to display things to the user. Through this
107
135
layer different applications can choose the style of UI.
137
UI Factories are also context managers, for some syntactic sugar some users
140
:ivar suppressed_warnings: Identifiers for user warnings that should
144
_user_warning_templates = dict(
145
cross_format_fetch=("Doing on-the-fly conversion from "
146
"%(from_format)s to %(to_format)s.\n"
147
"This may take some time. Upgrade the repositories to the "
148
"same format for better performance."
150
experimental_format_fetch=("Fetching into experimental format "
152
"This format may be unreliable or change in the future "
153
"without an upgrade path.\n"),
155
"The command 'bzr %(deprecated_name)s' "
156
"has been deprecated in bzr %(deprecated_in_version)s. "
157
"Please use 'bzr %(recommended_name)s' instead."),
158
deprecated_command_option=(
159
"The option '%(deprecated_name)s' to 'bzr %(command)s' "
160
"has been deprecated in bzr %(deprecated_in_version)s. "
161
"Please use '%(recommended_name)s' instead."),
162
recommend_upgrade=("%(current_format_name)s is deprecated "
163
"and a better format is available.\n"
164
"It is recommended that you upgrade by "
165
"running the command\n"
166
" bzr upgrade %(basedir)s"),
168
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
110
171
def __init__(self):
111
172
self._task_stack = []
173
self.suppressed_warnings = set()
112
174
self._quiet = False
177
"""Context manager entry support.
179
Override in a concrete factory class if initialisation before use is
182
return self # This is bound to the 'as' clause in a with statement.
184
def __exit__(self, exc_type, exc_val, exc_tb):
185
"""Context manager exit support.
187
Override in a concrete factory class if more cleanup than a simple
188
self.clear_term() is needed when the UIFactory is finished with.
191
return False # propogate exceptions.
114
193
def be_quiet(self, state):
115
194
"""Tell the UI to be more quiet, or not.
120
199
self._quiet = state
122
def get_password(self, prompt='', **kwargs):
201
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
202
"""Seek user confirmation for an action.
204
If the UI is noninteractive, or the user does not want to be asked
205
about this action, True is returned, indicating bzr should just
208
The confirmation id allows the user to configure certain actions to
209
always be confirmed or always denied, and for UIs to specialize the
210
display of particular confirmations.
212
:param prompt: Suggested text to display to the user.
213
:param prompt_kwargs: A dictionary of arguments that can be
214
string-interpolated into the prompt.
215
:param confirmation_id: Unique string identifier for the confirmation.
217
return self.get_boolean(prompt % prompt_kwargs)
219
def get_password(self, prompt=u'', **kwargs):
123
220
"""Prompt the user for a password.
125
:param prompt: The prompt to present the user
222
:param prompt: The prompt to present the user (must be unicode)
126
223
:param kwargs: Arguments which will be expanded into the prompt.
127
224
This lets front ends display different things if
313
def format_user_warning(self, warning_id, message_args):
315
template = self._user_warning_templates[warning_id]
317
fail = "bzr warning: %r, %r" % (warning_id, message_args)
318
warnings.warn("no template for warning: " + fail) # so tests will fail etc
321
return template % message_args
322
except ValueError, e:
323
fail = "bzr unprintable warning: %r, %r, %s" % (
324
warning_id, message_args, e)
325
warnings.warn(fail) # so tests will fail etc
328
def choose(self, msg, choices, default=None):
329
"""Prompt the user for a list of alternatives.
331
:param msg: message to be shown as part of the prompt.
333
:param choices: list of choices, with the individual choices separated
334
by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
335
letter after the '&' is the shortcut key for that choice. Thus you
336
can type 'c' to select "Cancel". Shorcuts are case insensitive.
337
The shortcut does not need to be the first letter. If a shorcut key
338
is not provided, the first letter for the choice will be used.
340
:param default: default choice (index), returned for example when enter
341
is pressed for the console version.
343
:return: the index fo the user choice (so '0', '1' or '2' for
344
respectively yes/no/cancel in the previous example).
346
raise NotImplementedError(self.choose)
213
348
def get_boolean(self, prompt):
214
349
"""Get a boolean question answered from the user.
216
351
:param prompt: a message to prompt the user with. Should be a single
217
line without terminating \n.
352
line without terminating \\n.
218
353
:return: True or False for y/yes or n/no.
220
raise NotImplementedError(self.get_boolean)
355
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
222
358
def get_integer(self, prompt):
223
359
"""Get an integer from the user.
225
361
:param prompt: a message to prompt the user with. Could be a multi-line
226
prompt but without a terminating \n.
362
prompt but without a terminating \\n.
228
364
:return: A signed integer.
238
374
return NullProgressView()
240
def recommend_upgrade(self,
243
# this should perhaps be in the TextUIFactory and the default can do
245
trace.warning("%s is deprecated "
246
"and a better format is available.\n"
247
"It is recommended that you upgrade by "
248
"running the command\n"
376
def recommend_upgrade(self, current_format_name, basedir):
377
"""Recommend the user upgrade a control directory.
379
:param current_format_name: Description of the current format
380
:param basedir: Location of the control dir
382
self.show_user_warning('recommend_upgrade',
383
current_format_name=current_format_name, basedir=basedir)
253
385
def report_transport_activity(self, transport, byte_count, direction):
254
386
"""Called by transports as they do IO.
271
403
# Default implementation just does nothing
406
def show_user_warning(self, warning_id, **message_args):
407
"""Show a warning to the user.
409
This is specifically for things that are under the user's control (eg
410
outdated formats), not for internal program warnings like deprecated
413
This can be overridden by UIFactory subclasses to show it in some
414
appropriate way; the default UIFactory is noninteractive and does
415
nothing. format_user_warning maps it to a string, though other
416
presentations can be used for particular UIs.
418
:param warning_id: An identifier like 'cross_format_fetch' used to
419
check if the message is suppressed and to look up the string.
420
:param message_args: Arguments to be interpolated into the message.
274
424
def show_error(self, msg):
275
425
"""Show an error message (not an exception) to the user.
287
437
"""Show a warning to the user."""
288
438
raise NotImplementedError(self.show_warning)
290
def warn_cross_format_fetch(self, from_format, to_format):
291
"""Warn about a potentially slow cross-format transfer"""
292
# See <https://launchpad.net/bugs/456077> asking for a warning here
293
trace.warning("Doing on-the-fly conversion from %s to %s.\n"
294
"This may take some time. Upgrade the repositories to the "
295
"same format for better performance.\n" %
296
(from_format, to_format))
299
class SilentUIFactory(UIFactory):
441
class NoninteractiveUIFactory(UIFactory):
442
"""Base class for UIs with no user."""
444
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
448
return '%s()' % (self.__class__.__name__, )
451
class SilentUIFactory(NoninteractiveUIFactory):
300
452
"""A UI Factory which never prints anything.
302
454
This is the default UI, if another one is never registered by a program
337
489
def __repr__(self):
338
490
return "%s(%r)" % (self.__class__.__name__, self.responses)
492
def confirm_action(self, prompt, confirmation_id, args):
493
return self.get_boolean(prompt % args)
340
495
def get_boolean(self, prompt):
341
496
return self.responses.pop(0)
343
498
def get_integer(self, prompt):
344
499
return self.responses.pop(0)
346
def get_password(self, prompt='', **kwargs):
501
def get_password(self, prompt=u'', **kwargs):
347
502
return self.responses.pop(0)
349
504
def get_username(self, prompt, **kwargs):
added
removed
bzrlib/ui/__init__.py
