~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

  • Committer: Patch Queue Manager
  • Date: 2014-09-22 19:14:34 UTC
  • mfrom: (6598.1.2 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20140922191434-6bbnpnxi5jab4vim
(richard-wilbur) Allows launchpad APIs to use proxies by default(Paul Gear).
 (Paul Gear)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
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
41
41
    back to working through the terminal.
42
42
"""
43
43
 
 
44
from __future__ import absolute_import
44
45
 
45
 
import os
46
 
import sys
47
46
import warnings
48
47
 
49
48
from bzrlib.lazy_import import lazy_import
50
49
lazy_import(globals(), """
51
 
import getpass
52
 
 
53
50
from bzrlib import (
54
 
    errors,
 
51
    config,
55
52
    osutils,
56
53
    progress,
57
54
    trace,
58
55
    )
59
56
""")
60
 
from bzrlib.symbol_versioning import (
61
 
    deprecated_function,
62
 
    deprecated_in,
63
 
    deprecated_method,
64
 
    )
65
57
 
66
58
 
67
59
_valid_boolean_strings = dict(yes=True, no=False,
154
146
            "%(from_format)s to %(to_format)s.\n"
155
147
            "This may take some time. Upgrade the repositories to the "
156
148
            "same format for better performance."
157
 
            )
 
149
            ),
 
150
        experimental_format_fetch=("Fetching into experimental format "
 
151
            "%(to_format)s.\n"
 
152
            "This format may be unreliable or change in the future "
 
153
            "without an upgrade path.\n"),
 
154
        deprecated_command=(
 
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"),
 
167
        locks_steal_dead=(
 
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."),
158
171
        )
159
172
 
160
173
    def __init__(self):
205
218
        """
206
219
        return self.get_boolean(prompt % prompt_kwargs)
207
220
 
208
 
    def get_password(self, prompt='', **kwargs):
 
221
    def get_password(self, prompt=u'', **kwargs):
209
222
        """Prompt the user for a password.
210
223
 
211
 
        :param prompt: The prompt to present the user
 
224
        :param prompt: The prompt to present the user (must be unicode)
212
225
        :param kwargs: Arguments which will be expanded into the prompt.
213
226
                       This lets front ends display different things if
214
227
                       they so choose.
242
255
        """
243
256
        # XXX: is the caller supposed to close the resulting object?
244
257
        if encoding is None:
245
 
            from bzrlib import config
246
 
            encoding = config.GlobalConfig().get_user_option(
247
 
                'output_encoding')
 
258
            encoding = config.GlobalStack().get('output_encoding')
248
259
        if encoding is None:
249
260
            encoding = osutils.get_terminal_encoding(trace=True)
250
261
        if encoding_type is None:
305
316
        try:
306
317
            template = self._user_warning_templates[warning_id]
307
318
        except KeyError:
308
 
            fail = "failed to format warning %r, %r" % (warning_id, message_args)
309
 
            warnings.warn(fail)   # so tests will fail etc
 
319
            fail = "bzr warning: %r, %r" % (warning_id, message_args)
 
320
            warnings.warn("no template for warning: " + fail)   # so tests will fail etc
310
321
            return fail
311
322
        try:
312
323
            return template % message_args
313
324
        except ValueError, e:
314
 
            fail = "failed to format warning %r, %r: %s" % (
 
325
            fail = "bzr unprintable warning: %r, %r, %s" % (
315
326
                warning_id, message_args, e)
316
327
            warnings.warn(fail)   # so tests will fail etc
317
328
            return fail
318
329
 
 
330
    def choose(self, msg, choices, default=None):
 
331
        """Prompt the user for a list of alternatives.
 
332
 
 
333
        :param msg: message to be shown as part of the prompt.
 
334
 
 
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.
 
341
 
 
342
        :param default: default choice (index), returned for example when enter
 
343
            is pressed for the console version.
 
344
 
 
345
        :return: the index fo the user choice (so '0', '1' or '2' for
 
346
            respectively yes/no/cancel in the previous example).
 
347
        """
 
348
        raise NotImplementedError(self.choose)
 
349
 
319
350
    def get_boolean(self, prompt):
320
351
        """Get a boolean question answered from the user.
321
352
 
322
353
        :param prompt: a message to prompt the user with. Should be a single
323
 
        line without terminating \n.
 
354
            line without terminating \\n.
324
355
        :return: True or False for y/yes or n/no.
325
356
        """
326
 
        raise NotImplementedError(self.get_boolean)
 
357
        choice = self.choose(prompt + '?', '&yes\n&no', default=None)
 
358
        return 0 == choice
327
359
 
328
360
    def get_integer(self, prompt):
329
361
        """Get an integer from the user.
330
362
 
331
363
        :param prompt: a message to prompt the user with. Could be a multi-line
332
 
            prompt but without a terminating \n.
 
364
            prompt but without a terminating \\n.
333
365
 
334
366
        :return: A signed integer.
335
367
        """
343
375
        """
344
376
        return NullProgressView()
345
377
 
346
 
    def recommend_upgrade(self,
347
 
        current_format_name,
348
 
        basedir):
349
 
        # XXX: this should perhaps be in the TextUIFactory and the default can do
350
 
        # nothing
351
 
        #
352
 
        # XXX: Change to show_user_warning - that will accomplish the previous
353
 
        # xxx. -- mbp 2010-02-25
354
 
        trace.warning("%s is deprecated "
355
 
            "and a better format is available.\n"
356
 
            "It is recommended that you upgrade by "
357
 
            "running the command\n"
358
 
            "  bzr upgrade %s",
359
 
            current_format_name,
360
 
            basedir)
 
378
    def recommend_upgrade(self, current_format_name, basedir):
 
379
        """Recommend the user upgrade a control directory.
 
380
 
 
381
        :param current_format_name: Description of the current format
 
382
        :param basedir: Location of the control dir
 
383
        """
 
384
        self.show_user_warning('recommend_upgrade',
 
385
            current_format_name=current_format_name, basedir=basedir)
361
386
 
362
387
    def report_transport_activity(self, transport, byte_count, direction):
363
388
        """Called by transports as they do IO.
414
439
        """Show a warning to the user."""
415
440
        raise NotImplementedError(self.show_warning)
416
441
 
417
 
    def warn_cross_format_fetch(self, from_format, to_format):
418
 
        """Warn about a potentially slow cross-format transfer.
419
 
        
420
 
        This is deprecated in favor of show_user_warning, but retained for api
421
 
        compatibility in 2.0 and 2.1.
422
 
        """
423
 
        self.show_user_warning('cross_format_fetch', from_format=from_format,
424
 
            to_format=to_format)
425
 
 
426
 
    def warn_experimental_format_fetch(self, inter):
427
 
        """Warn about fetching into experimental repository formats."""
428
 
        if inter.target._format.experimental:
429
 
            trace.warning("Fetching into experimental format %s.\n"
430
 
                "This format may be unreliable or change in the future "
431
 
                "without an upgrade path.\n" % (inter.target._format,))
432
 
 
433
442
 
434
443
class NoninteractiveUIFactory(UIFactory):
435
444
    """Base class for UIs with no user."""
491
500
    def get_integer(self, prompt):
492
501
        return self.responses.pop(0)
493
502
 
494
 
    def get_password(self, prompt='', **kwargs):
 
503
    def get_password(self, prompt=u'', **kwargs):
495
504
        return self.responses.pop(0)
496
505
 
497
506
    def get_username(self, prompt, **kwargs):