1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
47
49
from bzrlib.lazy_import import lazy_import
48
50
lazy_import(globals(), """
49
53
from bzrlib import (
60
from bzrlib.symbol_versioning import (
57
67
_valid_boolean_strings = dict(yes=True, no=False,
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.
144
118
"%(from_format)s to %(to_format)s.\n"
145
119
"This may take some time. Upgrade the repositories to the "
146
120
"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
124
def __init__(self):
189
152
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):
154
def get_password(self, prompt='', **kwargs):
210
155
"""Prompt the user for a password.
212
:param prompt: The prompt to present the user (must be unicode)
157
:param prompt: The prompt to present the user
213
158
:param kwargs: Arguments which will be expanded into the prompt.
214
159
This lets front ends display different things if
307
252
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
254
fail = "failed to format warning %r, %r" % (warning_id, message_args)
255
warnings.warn(fail) # so tests will fail etc
313
258
return template % message_args
314
259
except ValueError, e:
315
fail = "bzr unprintable warning: %r, %r, %s" % (
260
fail = "failed to format warning %r, %r: %s" % (
316
261
warning_id, message_args, e)
317
262
warnings.warn(fail) # so tests will fail etc
321
266
"""Get a boolean question answered from the user.
323
268
:param prompt: a message to prompt the user with. Should be a single
324
line without terminating \\n.
269
line without terminating \n.
325
270
:return: True or False for y/yes or n/no.
327
272
raise NotImplementedError(self.get_boolean)
330
275
"""Get an integer from the user.
332
277
:param prompt: a message to prompt the user with. Could be a multi-line
333
prompt but without a terminating \\n.
278
prompt but without a terminating \n.
335
280
:return: A signed integer.
345
290
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)
292
def recommend_upgrade(self,
295
# XXX: this should perhaps be in the TextUIFactory and the default can do
298
# XXX: Change to show_user_warning - that will accomplish the previous
299
# xxx. -- mbp 2010-02-25
300
trace.warning("%s is deprecated "
301
"and a better format is available.\n"
302
"It is recommended that you upgrade by "
303
"running the command\n"
356
308
def report_transport_activity(self, transport, byte_count, direction):
357
309
"""Called by transports as they do IO.
425
377
"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):
380
class SilentUIFactory(UIFactory):
439
381
"""A UI Factory which never prints anything.
441
383
This is the default UI, if another one is never registered by a program
476
418
def __repr__(self):
477
419
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
421
def get_boolean(self, prompt):
483
422
return self.responses.pop(0)
485
424
def get_integer(self, prompt):
486
425
return self.responses.pop(0)
488
def get_password(self, prompt=u'', **kwargs):
427
def get_password(self, prompt='', **kwargs):
489
428
return self.responses.pop(0)
491
430
def get_username(self, prompt, **kwargs):
added
removed
bzrlib/ui/__init__.py
