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)
131
103
class UIFactory(object):
132
104
"""UI abstraction.
134
106
This tells the library how to display things to the user. Through this
135
107
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."),
173
110
def __init__(self):
174
111
self._task_stack = []
175
self.suppressed_warnings = set()
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.
195
def be_quiet(self, state):
196
"""Tell the UI to be more quiet, or not.
198
Typically this suppresses progress bars; the application may also look
199
at ui_factory.is_quiet().
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):
113
def get_password(self, prompt='', **kwargs):
222
114
"""Prompt the user for a password.
224
:param prompt: The prompt to present the user (must be unicode)
116
:param prompt: The prompt to present the user
225
117
:param kwargs: Arguments which will be expanded into the prompt.
226
118
This lets front ends display different things if
234
126
raise NotImplementedError(self.get_password)
239
def make_output_stream(self, encoding=None, encoding_type=None):
240
"""Get a stream for sending out bulk text data.
242
This is used for commands that produce bulk text, such as log or diff
243
output, as opposed to user interaction. This should work even for
244
non-interactive user interfaces. Typically this goes to a decorated
245
version of stdout, but in a GUI it might be appropriate to send it to a
246
window displaying the text.
248
:param encoding: Unicode encoding for output; if not specified
249
uses the configured 'output_encoding' if any; otherwise the
251
(See get_terminal_encoding.)
253
:param encoding_type: How to handle encoding errors:
254
replace/strict/escape/exact. Default is replace.
256
# XXX: is the caller supposed to close the resulting object?
258
encoding = config.GlobalStack().get('output_encoding')
260
encoding = osutils.get_terminal_encoding(trace=True)
261
if encoding_type is None:
262
encoding_type = 'replace'
263
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
266
def _make_output_stream_explicit(self, encoding, encoding_type):
267
raise NotImplementedError("%s doesn't support make_output_stream"
268
% (self.__class__.__name__))
270
128
def nested_progress_bar(self):
271
129
"""Return a nested progress bar.
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)
350
173
def get_boolean(self, prompt):
351
174
"""Get a boolean question answered from the user.
353
176
:param prompt: a message to prompt the user with. Should be a single
354
line without terminating \\n.
177
line without terminating \n.
355
178
:return: True or False for y/yes or n/no.
357
choice = self.choose(prompt + '?', '&yes\n&no', default=None)
360
def get_integer(self, prompt):
361
"""Get an integer from the user.
363
:param prompt: a message to prompt the user with. Could be a multi-line
364
prompt but without a terminating \\n.
366
:return: A signed integer.
368
raise NotImplementedError(self.get_integer)
180
raise NotImplementedError(self.get_boolean)
370
182
def make_progress_view(self):
371
183
"""Construct a new ProgressView object for this UI.
376
188
return NullProgressView()
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)
190
def recommend_upgrade(self,
193
# this should perhaps be in the TextUIFactory and the default can do
195
trace.warning("%s is deprecated "
196
"and a better format is available.\n"
197
"It is recommended that you upgrade by "
198
"running the command\n"
387
203
def report_transport_activity(self, transport, byte_count, direction):
388
204
"""Called by transports as they do IO.
395
def log_transport_activity(self, display=False):
396
"""Write out whatever transport activity has been measured.
398
Implementations are allowed to do nothing, but it is useful if they can
399
write a line to the log file.
401
:param display: If False, only log to disk, if True also try to display
402
a message to the user.
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.
426
211
def show_error(self, msg):
427
212
"""Show an error message (not an exception) to the user.
429
214
The message should not have an error prefix or trailing newline. That
430
will be added by the factory if appropriate.
215
will be added by the factory if appropriate.
432
217
raise NotImplementedError(self.show_error)
491
264
def __repr__(self):
492
265
return "%s(%r)" % (self.__class__.__name__, self.responses)
494
def confirm_action(self, prompt, confirmation_id, args):
495
return self.get_boolean(prompt % args)
497
267
def get_boolean(self, prompt):
498
268
return self.responses.pop(0)
500
def get_integer(self, prompt):
501
return self.responses.pop(0)
503
def get_password(self, prompt=u'', **kwargs):
270
def get_password(self, prompt='', **kwargs):
504
271
return self.responses.pop(0)
506
273
def get_username(self, prompt, **kwargs):
507
274
return self.responses.pop(0)
509
276
def assert_all_input_consumed(self):
510
277
if self.responses:
511
278
raise AssertionError("expected all input in %r to be consumed"