93
class ConfirmationUserInterfacePolicy(object):
94
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
96
def __init__(self, wrapped_ui, default_answer, specific_answers):
97
"""Generate a proxy UI that does no confirmations.
99
:param wrapped_ui: Underlying UIFactory.
100
:param default_answer: Bool for whether requests for
101
confirmation from the user should be noninteractively accepted or
103
:param specific_answers: Map from confirmation_id to bool answer.
105
self.wrapped_ui = wrapped_ui
106
self.default_answer = default_answer
107
self.specific_answers = specific_answers
109
def __getattr__(self, name):
110
return getattr(self.wrapped_ui, name)
113
return '%s(%r, %r, %r)' % (
114
self.__class__.__name__,
117
self.specific_answers)
119
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
120
if confirmation_id in self.specific_answers:
121
return self.specific_answers[confirmation_id]
122
elif self.default_answer is not None:
123
return self.default_answer
125
return self.wrapped_ui.confirm_action(
126
prompt, confirmation_id, prompt_kwargs)
129
103
class UIFactory(object):
130
104
"""UI abstraction.
132
106
This tells the library how to display things to the user. Through this
133
107
layer different applications can choose the style of UI.
135
UI Factories are also context managers, for some syntactic sugar some users
138
:ivar suppressed_warnings: Identifiers for user warnings that should
142
_user_warning_templates = dict(
143
cross_format_fetch=("Doing on-the-fly conversion from "
144
"%(from_format)s to %(to_format)s.\n"
145
"This may take some time. Upgrade the repositories to the "
146
"same format for better performance."
149
"The command 'bzr %(deprecated_name)s' "
150
"has been deprecated in bzr %(deprecated_in_version)s. "
151
"Please use 'bzr %(recommended_name)s' instead."),
152
recommend_upgrade=("%(current_format_name)s is deprecated "
153
"and a better format is available.\n"
154
"It is recommended that you upgrade by "
155
"running the command\n"
156
" bzr upgrade %(basedir)s"),
158
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
161
110
def __init__(self):
162
111
self._task_stack = []
163
self.suppressed_warnings = set()
164
112
self._quiet = False
167
"""Context manager entry support.
169
Override in a concrete factory class if initialisation before use is
172
return self # This is bound to the 'as' clause in a with statement.
174
def __exit__(self, exc_type, exc_val, exc_tb):
175
"""Context manager exit support.
177
Override in a concrete factory class if more cleanup than a simple
178
self.clear_term() is needed when the UIFactory is finished with.
181
return False # propogate exceptions.
183
114
def be_quiet(self, state):
184
115
"""Tell the UI to be more quiet, or not.
189
120
self._quiet = state
191
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
192
"""Seek user confirmation for an action.
194
If the UI is noninteractive, or the user does not want to be asked
195
about this action, True is returned, indicating bzr should just
198
The confirmation id allows the user to configure certain actions to
199
always be confirmed or always denied, and for UIs to specialize the
200
display of particular confirmations.
202
:param prompt: Suggested text to display to the user.
203
:param prompt_kwargs: A dictionary of arguments that can be
204
string-interpolated into the prompt.
205
:param confirmation_id: Unique string identifier for the confirmation.
207
return self.get_boolean(prompt % prompt_kwargs)
209
def get_password(self, prompt=u'', **kwargs):
122
def get_password(self, prompt='', **kwargs):
210
123
"""Prompt the user for a password.
212
:param prompt: The prompt to present the user (must be unicode)
125
:param prompt: The prompt to present the user
213
126
:param kwargs: Arguments which will be expanded into the prompt.
214
127
This lets front ends display different things if
233
146
version of stdout, but in a GUI it might be appropriate to send it to a
234
147
window displaying the text.
236
:param encoding: Unicode encoding for output; if not specified
237
uses the configured 'output_encoding' if any; otherwise the
149
:param encoding: Unicode encoding for output; default is the
150
terminal encoding, which may be different from the user encoding.
239
151
(See get_terminal_encoding.)
241
153
:param encoding_type: How to handle encoding errors:
244
156
# XXX: is the caller supposed to close the resulting object?
245
157
if encoding is None:
246
from bzrlib import config
247
encoding = config.GlobalConfig().get_user_option(
250
encoding = osutils.get_terminal_encoding(trace=True)
158
encoding = osutils.get_terminal_encoding()
251
159
if encoding_type is None:
252
160
encoding_type = 'replace'
253
161
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
305
def format_user_warning(self, warning_id, message_args):
307
template = self._user_warning_templates[warning_id]
309
fail = "bzr warning: %r, %r" % (warning_id, message_args)
310
warnings.warn("no template for warning: " + fail) # so tests will fail etc
313
return template % message_args
314
except ValueError, e:
315
fail = "bzr unprintable warning: %r, %r, %s" % (
316
warning_id, message_args, e)
317
warnings.warn(fail) # so tests will fail etc
320
213
def get_boolean(self, prompt):
321
214
"""Get a boolean question answered from the user.
323
216
:param prompt: a message to prompt the user with. Should be a single
324
line without terminating \\n.
217
line without terminating \n.
325
218
:return: True or False for y/yes or n/no.
327
220
raise NotImplementedError(self.get_boolean)
345
238
return NullProgressView()
347
def recommend_upgrade(self, current_format_name, basedir):
348
"""Recommend the user upgrade a control directory.
350
:param current_format_name: Description of the current format
351
:param basedir: Location of the control dir
353
self.show_user_warning('recommend_upgrade',
354
current_format_name=current_format_name, basedir=basedir)
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"
356
253
def report_transport_activity(self, transport, byte_count, direction):
357
254
"""Called by transports as they do IO.
374
271
# Default implementation just does nothing
377
def show_user_warning(self, warning_id, **message_args):
378
"""Show a warning to the user.
380
This is specifically for things that are under the user's control (eg
381
outdated formats), not for internal program warnings like deprecated
384
This can be overridden by UIFactory subclasses to show it in some
385
appropriate way; the default UIFactory is noninteractive and does
386
nothing. format_user_warning maps it to a string, though other
387
presentations can be used for particular UIs.
389
:param warning_id: An identifier like 'cross_format_fetch' used to
390
check if the message is suppressed and to look up the string.
391
:param message_args: Arguments to be interpolated into the message.
395
274
def show_error(self, msg):
396
275
"""Show an error message (not an exception) to the user.
409
288
raise NotImplementedError(self.show_warning)
411
290
def warn_cross_format_fetch(self, from_format, to_format):
412
"""Warn about a potentially slow cross-format transfer.
414
This is deprecated in favor of show_user_warning, but retained for api
415
compatibility in 2.0 and 2.1.
417
self.show_user_warning('cross_format_fetch', from_format=from_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))
420
298
def warn_experimental_format_fetch(self, inter):
421
299
"""Warn about fetching into experimental repository formats."""
425
303
"without an upgrade path.\n" % (inter.target._format,))
428
class NoninteractiveUIFactory(UIFactory):
429
"""Base class for UIs with no user."""
431
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
435
return '%s()' % (self.__class__.__name__, )
438
class SilentUIFactory(NoninteractiveUIFactory):
307
class SilentUIFactory(UIFactory):
439
308
"""A UI Factory which never prints anything.
441
310
This is the default UI, if another one is never registered by a program
476
345
def __repr__(self):
477
346
return "%s(%r)" % (self.__class__.__name__, self.responses)
479
def confirm_action(self, prompt, confirmation_id, args):
480
return self.get_boolean(prompt % args)
482
348
def get_boolean(self, prompt):
483
349
return self.responses.pop(0)
485
351
def get_integer(self, prompt):
486
352
return self.responses.pop(0)
488
def get_password(self, prompt=u'', **kwargs):
354
def get_password(self, prompt='', **kwargs):
489
355
return self.responses.pop(0)
491
357
def get_username(self, prompt, **kwargs):
added
removed
bzrlib/ui/__init__.py
