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."),
169
not_checking_ssl_cert=(
170
u"Not checking SSL certificate for %(host)s."),
110
173
def __init__(self):
111
174
self._task_stack = []
175
self.suppressed_warnings = set()
112
176
self._quiet = False
179
"""Context manager entry support.
181
Override in a concrete factory class if initialisation before use is
184
return self # This is bound to the 'as' clause in a with statement.
186
def __exit__(self, exc_type, exc_val, exc_tb):
187
"""Context manager exit support.
189
Override in a concrete factory class if more cleanup than a simple
190
self.clear_term() is needed when the UIFactory is finished with.
193
return False # propogate exceptions.
114
195
def be_quiet(self, state):
115
196
"""Tell the UI to be more quiet, or not.
120
201
self._quiet = state
122
def get_password(self, prompt='', **kwargs):
203
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
204
"""Seek user confirmation for an action.
206
If the UI is noninteractive, or the user does not want to be asked
207
about this action, True is returned, indicating bzr should just
210
The confirmation id allows the user to configure certain actions to
211
always be confirmed or always denied, and for UIs to specialize the
212
display of particular confirmations.
214
:param prompt: Suggested text to display to the user.
215
:param prompt_kwargs: A dictionary of arguments that can be
216
string-interpolated into the prompt.
217
:param confirmation_id: Unique string identifier for the confirmation.
219
return self.get_boolean(prompt % prompt_kwargs)
221
def get_password(self, prompt=u'', **kwargs):
123
222
"""Prompt the user for a password.
125
:param prompt: The prompt to present the user
224
:param prompt: The prompt to present the user (must be unicode)
126
225
:param kwargs: Arguments which will be expanded into the prompt.
127
226
This lets front ends display different things if
315
def format_user_warning(self, warning_id, message_args):
317
template = self._user_warning_templates[warning_id]
319
fail = "bzr warning: %r, %r" % (warning_id, message_args)
320
warnings.warn("no template for warning: " + fail) # so tests will fail etc
323
return template % message_args
324
except ValueError, e:
325
fail = "bzr unprintable warning: %r, %r, %s" % (
326
warning_id, message_args, e)
327
warnings.warn(fail) # so tests will fail etc
330
def choose(self, msg, choices, default=None):
331
"""Prompt the user for a list of alternatives.
333
:param msg: message to be shown as part of the prompt.
335
:param choices: list of choices, with the individual choices separated
336
by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
337
letter after the '&' is the shortcut key for that choice. Thus you
338
can type 'c' to select "Cancel". Shorcuts are case insensitive.
339
The shortcut does not need to be the first letter. If a shorcut key
340
is not provided, the first letter for the choice will be used.
342
:param default: default choice (index), returned for example when enter
343
is pressed for the console version.
345
:return: the index fo the user choice (so '0', '1' or '2' for
346
respectively yes/no/cancel in the previous example).
348
raise NotImplementedError(self.choose)
213
350
def get_boolean(self, prompt):
214
351
"""Get a boolean question answered from the user.
216
353
:param prompt: a message to prompt the user with. Should be a single
217
line without terminating \n.
354
line without terminating \\n.
218
355
:return: True or False for y/yes or n/no.
220
raise NotImplementedError(self.get_boolean)
357
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
222
360
def get_integer(self, prompt):
223
361
"""Get an integer from the user.
225
363
:param prompt: a message to prompt the user with. Could be a multi-line
226
prompt but without a terminating \n.
364
prompt but without a terminating \\n.
228
366
:return: A signed integer.
238
376
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"
378
def recommend_upgrade(self, current_format_name, basedir):
379
"""Recommend the user upgrade a control directory.
381
:param current_format_name: Description of the current format
382
:param basedir: Location of the control dir
384
self.show_user_warning('recommend_upgrade',
385
current_format_name=current_format_name, basedir=basedir)
253
387
def report_transport_activity(self, transport, byte_count, direction):
254
388
"""Called by transports as they do IO.
271
405
# Default implementation just does nothing
408
def show_user_warning(self, warning_id, **message_args):
409
"""Show a warning to the user.
411
This is specifically for things that are under the user's control (eg
412
outdated formats), not for internal program warnings like deprecated
415
This can be overridden by UIFactory subclasses to show it in some
416
appropriate way; the default UIFactory is noninteractive and does
417
nothing. format_user_warning maps it to a string, though other
418
presentations can be used for particular UIs.
420
:param warning_id: An identifier like 'cross_format_fetch' used to
421
check if the message is suppressed and to look up the string.
422
:param message_args: Arguments to be interpolated into the message.
274
426
def show_error(self, msg):
275
427
"""Show an error message (not an exception) to the user.
287
439
"""Show a warning to the user."""
288
440
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))
298
def warn_experimental_format_fetch(self, inter):
299
"""Warn about fetching into experimental repository formats."""
300
if inter.target._format.experimental:
301
trace.warning("Fetching into experimental format %s.\n"
302
"This format may be unreliable or change in the future "
303
"without an upgrade path.\n" % (inter.target._format,))
307
class SilentUIFactory(UIFactory):
443
class NoninteractiveUIFactory(UIFactory):
444
"""Base class for UIs with no user."""
446
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
450
return '%s()' % (self.__class__.__name__, )
453
class SilentUIFactory(NoninteractiveUIFactory):
308
454
"""A UI Factory which never prints anything.
310
456
This is the default UI, if another one is never registered by a program
345
491
def __repr__(self):
346
492
return "%s(%r)" % (self.__class__.__name__, self.responses)
494
def confirm_action(self, prompt, confirmation_id, args):
495
return self.get_boolean(prompt % args)
348
497
def get_boolean(self, prompt):
349
498
return self.responses.pop(0)
351
500
def get_integer(self, prompt):
352
501
return self.responses.pop(0)
354
def get_password(self, prompt='', **kwargs):
503
def get_password(self, prompt=u'', **kwargs):
355
504
return self.responses.pop(0)
357
506
def get_username(self, prompt, **kwargs):
added
removed
bzrlib/ui/__init__.py
