← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Vincent Ladeuil
  • Date: 2011-07-06 09:22:00 UTC
  • mfrom: (6008 +trunk)
  • mto: (6012.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6013.
  • Revision ID: v.ladeuil+lp@free.fr-20110706092200-7iai2mwzc0sqdsvf
Merging in trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
27
27
 
28
28
from bzrlib.lazy_import import lazy_import
29
29
lazy_import(globals(), """
30
 
import codecs
31
30
import errno
32
31
import threading
33
 
from warnings import warn
34
32
 
35
33
import bzrlib
36
34
from bzrlib import (
38
36
    cmdline,
39
37
    debug,
40
38
    errors,
 
39
    i18n,
41
40
    option,
42
41
    osutils,
43
42
    trace,
44
43
    ui,
45
 
    win32utils,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.hooks import HookPoint, Hooks
 
47
from bzrlib.hooks import Hooks
 
48
from bzrlib.i18n import gettext
50
49
# Compatibility - Option used to be in commands.
51
50
from bzrlib.option import Option
52
51
from bzrlib.plugin import disable_plugins, load_plugins
276
275
    # Allow plugins to extend commands
277
276
    for hook in Command.hooks['extend_command']:
278
277
        hook(cmd)
 
278
    if getattr(cmd, 'invoked_as', None) is None:
 
279
        cmd.invoked_as = cmd_name
279
280
    return cmd
280
281
 
281
282
 
358
359
    summary, then a complete description of the command.  A grammar
359
360
    description will be inserted.
360
361
 
361
 
    aliases
362
 
        Other accepted names for this command.
363
 
 
364
 
    takes_args
365
 
        List of argument forms, marked with whether they are optional,
366
 
        repeated, etc.
367
 
 
368
 
                Examples:
369
 
 
370
 
                ['to_location', 'from_branch?', 'file*']
371
 
 
372
 
                'to_location' is required
373
 
                'from_branch' is optional
374
 
                'file' can be specified 0 or more times
375
 
 
376
 
    takes_options
377
 
        List of options that may be given for this command.  These can
378
 
        be either strings, referring to globally-defined options,
379
 
        or option objects.  Retrieve through options().
380
 
 
381
 
    hidden
382
 
        If true, this command isn't advertised.  This is typically
 
362
    :cvar aliases: Other accepted names for this command.
 
363
 
 
364
    :cvar takes_args: List of argument forms, marked with whether they are
 
365
        optional, repeated, etc.  Examples::
 
366
 
 
367
            ['to_location', 'from_branch?', 'file*']
 
368
 
 
369
        * 'to_location' is required
 
370
        * 'from_branch' is optional
 
371
        * 'file' can be specified 0 or more times
 
372
 
 
373
    :cvar takes_options: List of options that may be given for this command.
 
374
        These can be either strings, referring to globally-defined options, or
 
375
        option objects.  Retrieve through options().
 
376
 
 
377
    :cvar hidden: If true, this command isn't advertised.  This is typically
383
378
        for commands intended for expert users.
384
379
 
385
 
    encoding_type
386
 
        Command objects will get a 'outf' attribute, which has been
387
 
        setup to properly handle encoding of unicode strings.
388
 
        encoding_type determines what will happen when characters cannot
389
 
        be encoded
390
 
            strict - abort if we cannot decode
391
 
            replace - put in a bogus character (typically '?')
392
 
            exact - do not encode sys.stdout
393
 
 
394
 
            NOTE: by default on Windows, sys.stdout is opened as a text
395
 
            stream, therefore LF line-endings are converted to CRLF.
396
 
            When a command uses encoding_type = 'exact', then
397
 
            sys.stdout is forced to be a binary stream, and line-endings
398
 
            will not mangled.
 
380
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
 
381
        been setup to properly handle encoding of unicode strings.
 
382
        encoding_type determines what will happen when characters cannot be
 
383
        encoded:
 
384
 
 
385
        * strict - abort if we cannot decode
 
386
        * replace - put in a bogus character (typically '?')
 
387
        * exact - do not encode sys.stdout
 
388
 
 
389
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
 
390
        therefore LF line-endings are converted to CRLF.  When a command uses
 
391
        encoding_type = 'exact', then sys.stdout is forced to be a binary
 
392
        stream, and line-endings will not mangled.
 
393
 
 
394
    :cvar invoked_as:
 
395
        A string indicating the real name under which this command was
 
396
        invoked, before expansion of aliases.
 
397
        (This may be None if the command was constructed and run in-process.)
399
398
 
400
399
    :cvar hooks: An instance of CommandHooks.
401
 
    :ivar __doc__: The help shown by 'bzr help command' for this command.
 
400
 
 
401
    :cvar __doc__: The help shown by 'bzr help command' for this command.
402
402
        This is set by assigning explicitly to __doc__ so that -OO can
403
403
        be used::
404
404
 
405
 
        class Foo(Command):
406
 
            __doc__ = "My help goes here"
 
405
            class Foo(Command):
 
406
                __doc__ = "My help goes here"
407
407
    """
408
408
    aliases = []
409
409
    takes_args = []
410
410
    takes_options = []
411
411
    encoding_type = 'strict'
 
412
    invoked_as = None
 
413
    l10n = True
412
414
 
413
415
    hidden = False
414
416
 
486
488
            usage help (e.g. Purpose, Usage, Options) with a
487
489
            message explaining how to obtain full help.
488
490
        """
 
491
        if self.l10n and not i18n.installed():
 
492
            i18n.install()  # Install i18n only for get_help_text for now.
489
493
        doc = self.help()
490
 
        if not doc:
491
 
            doc = "No help for this command."
 
494
        if doc:
 
495
            # Note: If self.gettext() translates ':Usage:\n', the section will
 
496
            # be shown after "Description" section and we don't want to
 
497
            # translate the usage string.
 
498
            # Though, bzr export-pot don't exports :Usage: section and it must
 
499
            # not be translated.
 
500
            doc = self.gettext(doc)
 
501
        else:
 
502
            doc = gettext("No help for this command.")
492
503
 
493
504
        # Extract the summary (purpose) and sections out from the text
494
505
        purpose,sections,order = self._get_help_parts(doc)
501
512
 
502
513
        # The header is the purpose and usage
503
514
        result = ""
504
 
        result += ':Purpose: %s\n' % purpose
 
515
        result += gettext(':Purpose: %s\n') % (purpose,)
505
516
        if usage.find('\n') >= 0:
506
 
            result += ':Usage:\n%s\n' % usage
 
517
            result += gettext(':Usage:\n%s\n') % (usage,)
507
518
        else:
508
 
            result += ':Usage:   %s\n' % usage
 
519
            result += gettext(':Usage:   %s\n') % (usage,)
509
520
        result += '\n'
510
521
 
511
522
        # Add the options
513
524
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
514
525
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
515
526
        # 20090319
516
 
        options = option.get_optparser(self.options()).format_option_help()
 
527
        parser = option.get_optparser(self.options())
 
528
        options = parser.format_option_help()
517
529
        # FIXME: According to the spec, ReST option lists actually don't
518
530
        # support options like --1.14 so that causes syntax errors (in Sphinx
519
531
        # at least).  As that pattern always appears in the commands that
523
535
        if not plain and options.find('  --1.14  ') != -1:
524
536
            options = options.replace(' format:\n', ' format::\n\n', 1)
525
537
        if options.startswith('Options:'):
526
 
            result += ':' + options
527
 
        elif options.startswith('options:'):
528
 
            # Python 2.4 version of optparse
529
 
            result += ':Options:' + options[len('options:'):]
 
538
            result += gettext(':Options:%s') % (options[len('options:'):],)
530
539
        else:
531
540
            result += options
532
541
        result += '\n'
537
546
            if sections.has_key(None):
538
547
                text = sections.pop(None)
539
548
                text = '\n  '.join(text.splitlines())
540
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
549
                result += gettext(':Description:\n  %s\n\n') % (text,)
541
550
 
542
551
            # Add the custom sections (e.g. Examples). Note that there's no need
543
552
            # to indent these as they must be indented already in the source.
544
553
            if sections:
545
554
                for label in order:
546
 
                    if sections.has_key(label):
547
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
555
                    if label in sections:
 
556
                        result += ':%s:\n%s\n' % (label, sections[label])
548
557
                result += '\n'
549
558
        else:
550
 
            result += ("See bzr help %s for more details and examples.\n\n"
 
559
            result += (gettext("See bzr help %s for more details and examples.\n\n")
551
560
                % self.name())
552
561
 
553
562
        # Add the aliases, source (plug-in) and see also links, if any
554
563
        if self.aliases:
555
 
            result += ':Aliases:  '
 
564
            result += gettext(':Aliases:  ')
556
565
            result += ', '.join(self.aliases) + '\n'
557
566
        plugin_name = self.plugin_name()
558
567
        if plugin_name is not None:
559
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
568
            result += gettext(':From:     plugin "%s"\n') % plugin_name
560
569
        see_also = self.get_see_also(additional_see_also)
561
570
        if see_also:
562
571
            if not plain and see_also_as_links:
568
577
                        see_also_links.append(item)
569
578
                    else:
570
579
                        # Use a Sphinx link for this entry
571
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
580
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
572
581
                        see_also_links.append(link_text)
573
582
                see_also = see_also_links
574
 
            result += ':See also: '
575
 
            result += ', '.join(see_also) + '\n'
 
583
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
576
584
 
577
585
        # If this will be rendered as plain text, convert it
578
586
        if plain:
659
667
    def run_argv_aliases(self, argv, alias_argv=None):
660
668
        """Parse the command line and run with extra aliases in alias_argv."""
661
669
        args, opts = parse_args(self, argv, alias_argv)
 
670
        self._setup_outf()
662
671
 
663
672
        # Process the standard options
664
673
        if 'help' in opts:  # e.g. bzr add --help
665
 
            sys.stdout.write(self.get_help_text())
 
674
            self.outf.write(self.get_help_text())
666
675
            return 0
667
676
        if 'usage' in opts:  # e.g. bzr add --usage
668
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
677
            self.outf.write(self.get_help_text(verbose=False))
669
678
            return 0
670
679
        trace.set_verbosity_level(option._verbosity_level)
671
680
        if 'verbose' in self.supported_std_options:
686
695
        all_cmd_args = cmdargs.copy()
687
696
        all_cmd_args.update(cmdopts)
688
697
 
689
 
        self._setup_outf()
690
 
 
691
698
        try:
692
699
            return self.run(**all_cmd_args)
693
700
        finally:
752
759
            return None
753
760
        return getdoc(self)
754
761
 
 
762
    def gettext(self, message):
 
763
        """Returns the gettext function used to translate this command's help.
 
764
 
 
765
        Commands provided by plugins should override this to use their
 
766
        own i18n system.
 
767
        """
 
768
        return i18n.gettext_per_paragraph(message)
 
769
 
755
770
    def name(self):
 
771
        """Return the canonical name for this command.
 
772
 
 
773
        The name under which it was actually invoked is available in invoked_as.
 
774
        """
756
775
        return _unsquish_command_name(self.__class__.__name__)
757
776
 
758
777
    def plugin_name(self):
776
795
        These are all empty initially, because by default nothing should get
777
796
        notified.
778
797
        """
779
 
        Hooks.__init__(self)
780
 
        self.create_hook(HookPoint('extend_command',
 
798
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
 
799
        self.add_hook('extend_command',
781
800
            "Called after creating a command object to allow modifications "
782
801
            "such as adding or removing options, docs etc. Called with the "
783
 
            "new bzrlib.commands.Command object.", (1, 13), None))
784
 
        self.create_hook(HookPoint('get_command',
 
802
            "new bzrlib.commands.Command object.", (1, 13))
 
803
        self.add_hook('get_command',
785
804
            "Called when creating a single command. Called with "
786
805
            "(cmd_or_None, command_name). get_command should either return "
787
806
            "the cmd_or_None parameter, or a replacement Command object that "
788
807
            "should be used for the command. Note that the Command.hooks "
789
808
            "hooks are core infrastructure. Many users will prefer to use "
790
809
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
791
 
            (1, 17), None))
792
 
        self.create_hook(HookPoint('get_missing_command',
 
810
            (1, 17))
 
811
        self.add_hook('get_missing_command',
793
812
            "Called when creating a single command if no command could be "
794
813
            "found. Called with (command_name). get_missing_command should "
795
814
            "either return None, or a Command object to be used for the "
796
 
            "command.", (1, 17), None))
797
 
        self.create_hook(HookPoint('list_commands',
 
815
            "command.", (1, 17))
 
816
        self.add_hook('list_commands',
798
817
            "Called when enumerating commands. Called with a set of "
799
818
            "cmd_name strings for all the commands found so far. This set "
800
819
            " is safe to mutate - e.g. to remove a command. "
801
820
            "list_commands should return the updated set of command names.",
802
 
            (1, 17), None))
 
821
            (1, 17))
803
822
 
804
823
Command.hooks = CommandHooks()
805
824
 
1035
1054
        Specify the number of processes that can be run concurrently (selftest).
1036
1055
    """
1037
1056
    trace.mutter("bazaar version: " + bzrlib.__version__)
1038
 
    argv = list(argv)
 
1057
    argv = _specified_or_unicode_argv(argv)
1039
1058
    trace.mutter("bzr arguments: %r", argv)
1040
1059
 
1041
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1042
 
                opt_no_aliases = False
 
1060
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1061
            opt_no_l10n = opt_no_aliases = False
1043
1062
    opt_lsprof_file = opt_coverage_dir = None
1044
1063
 
1045
1064
    # --no-plugins is handled specially at a very early stage. We need
1062
1081
            opt_no_plugins = True
1063
1082
        elif a == '--no-aliases':
1064
1083
            opt_no_aliases = True
 
1084
        elif a == '--no-l10n':
 
1085
            opt_no_l10n = True
1065
1086
        elif a == '--builtin':
1066
1087
            opt_builtin = True
1067
1088
        elif a == '--concurrency':
1103
1124
 
1104
1125
    cmd = argv.pop(0)
1105
1126
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1127
    if opt_no_l10n:
 
1128
        cmd.l10n = False
1106
1129
    run = cmd_obj.run_argv_aliases
1107
1130
    run_argv = [argv, alias_argv]
1108
1131
 
1181
1204
        new_argv = []
1182
1205
        try:
1183
1206
            # ensure all arguments are unicode strings
1184
 
            for a in argv[1:]:
 
1207
            for a in argv:
1185
1208
                if isinstance(a, unicode):
1186
1209
                    new_argv.append(a)
1187
1210
                else:
1203
1226
 
1204
1227
    :return: exit code of bzr command.
1205
1228
    """
1206
 
    argv = _specified_or_unicode_argv(argv)
 
1229
    if argv is not None:
 
1230
        argv = argv[1:]
1207
1231
    _register_builtin_commands()
1208
1232
    ret = run_bzr_catch_errors(argv)
1209
1233
    trace.mutter("return code %d", ret)
1264
1288
 
1265
1289
 
1266
1290
class Provider(object):
1267
 
    '''Generic class to be overriden by plugins'''
 
1291
    """Generic class to be overriden by plugins"""
1268
1292
 
1269
1293
    def plugin_for_command(self, cmd_name):
1270
 
        '''Takes a command and returns the information for that plugin
 
1294
        """Takes a command and returns the information for that plugin
1271
1295
 
1272
1296
        :return: A dictionary with all the available information
1273
 
        for the requested plugin
1274
 
        '''
 
1297
            for the requested plugin
 
1298
        """
1275
1299
        raise NotImplementedError
1276
1300
 
1277
1301
 
1278
1302
class ProvidersRegistry(registry.Registry):
1279
 
    '''This registry exists to allow other providers to exist'''
 
1303
    """This registry exists to allow other providers to exist"""
1280
1304
 
1281
1305
    def __iter__(self):
1282
1306
        for key, provider in self.iteritems():