← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/__init__.py
41
41
    back to working through the terminal.
42
42
"""
43
43
 
 
44
from __future__ import absolute_import
44
45
 
45
46
import warnings
46
47
 
47
48
from bzrlib.lazy_import import lazy_import
48
49
lazy_import(globals(), """
49
50
from bzrlib import (
 
51
    config,
50
52
    osutils,
51
53
    progress,
52
54
    trace,
145
147
            "This may take some time. Upgrade the repositories to the "
146
148
            "same format for better performance."
147
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"),
148
154
        deprecated_command=(
149
155
            "The command 'bzr %(deprecated_name)s' "
150
156
            "has been deprecated in bzr %(deprecated_in_version)s. "
151
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."),
152
162
        recommend_upgrade=("%(current_format_name)s is deprecated "
153
163
            "and a better format is available.\n"
154
164
            "It is recommended that you upgrade by "
243
253
        """
244
254
        # XXX: is the caller supposed to close the resulting object?
245
255
        if encoding is None:
246
 
            from bzrlib import config
247
 
            encoding = config.GlobalConfig().get_user_option(
248
 
                'output_encoding')
 
256
            encoding = config.GlobalStack().get('output_encoding')
249
257
        if encoding is None:
250
258
            encoding = osutils.get_terminal_encoding(trace=True)
251
259
        if encoding_type is None:
317
325
            warnings.warn(fail)   # so tests will fail etc
318
326
            return fail
319
327
 
 
328
    def choose(self, msg, choices, default=None):
 
329
        """Prompt the user for a list of alternatives.
 
330
 
 
331
        :param msg: message to be shown as part of the prompt.
 
332
 
 
333
        :param choices: list of choices, with the individual choices separated
 
334
            by '\n', e.g.: choose("Save changes?", "&Yes\n&No\n&Cancel"). The
 
335
            letter after the '&' is the shortcut key for that choice. Thus you
 
336
            can type 'c' to select "Cancel".  Shorcuts are case insensitive.
 
337
            The shortcut does not need to be the first letter. If a shorcut key
 
338
            is not provided, the first letter for the choice will be used.
 
339
 
 
340
        :param default: default choice (index), returned for example when enter
 
341
            is pressed for the console version.
 
342
 
 
343
        :return: the index fo the user choice (so '0', '1' or '2' for
 
344
            respectively yes/no/cancel in the previous example).
 
345
        """
 
346
        raise NotImplementedError(self.choose)
 
347
 
320
348
    def get_boolean(self, prompt):
321
349
        """Get a boolean question answered from the user.
322
350
 
324
352
            line without terminating \\n.
325
353
        :return: True or False for y/yes or n/no.
326
354
        """
327
 
        raise NotImplementedError(self.get_boolean)
 
355
        choice = self.choose(prompt + '?', '&yes\n&no', default=None)
 
356
        return 0 == choice
328
357
 
329
358
    def get_integer(self, prompt):
330
359
        """Get an integer from the user.
408
437
        """Show a warning to the user."""
409
438
        raise NotImplementedError(self.show_warning)
410
439
 
411
 
    def warn_cross_format_fetch(self, from_format, to_format):
412
 
        """Warn about a potentially slow cross-format transfer.
413
 
        
414
 
        This is deprecated in favor of show_user_warning, but retained for api
415
 
        compatibility in 2.0 and 2.1.
416
 
        """
417
 
        self.show_user_warning('cross_format_fetch', from_format=from_format,
418
 
            to_format=to_format)
419
 
 
420
 
    def warn_experimental_format_fetch(self, inter):
421
 
        """Warn about fetching into experimental repository formats."""
422
 
        if inter.target._format.experimental:
423
 
            trace.warning("Fetching into experimental format %s.\n"
424
 
                "This format may be unreliable or change in the future "
425
 
                "without an upgrade path.\n" % (inter.target._format,))
426
 
 
427
440
 
428
441
class NoninteractiveUIFactory(UIFactory):
429
442
    """Base class for UIs with no user."""