← 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-06-27 15:42:09 UTC
  • mfrom: (5993 +trunk)
  • mto: (5993.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 5994.
  • Revision ID: v.ladeuil+lp@free.fr-20110627154209-azubuhbuxsz109hq
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
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
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
222
221
    Use of all_command_names() is encouraged rather than builtin_command_names
223
222
    and/or plugin_command_names.
224
223
    """
 
224
    _register_builtin_commands()
225
225
    return builtin_command_registry.keys()
226
226
 
227
227
 
275
275
    # Allow plugins to extend commands
276
276
    for hook in Command.hooks['extend_command']:
277
277
        hook(cmd)
 
278
    if getattr(cmd, 'invoked_as', None) is None:
 
279
        cmd.invoked_as = cmd_name
278
280
    return cmd
279
281
 
280
282
 
357
359
    summary, then a complete description of the command.  A grammar
358
360
    description will be inserted.
359
361
 
360
 
    aliases
361
 
        Other accepted names for this command.
362
 
 
363
 
    takes_args
364
 
        List of argument forms, marked with whether they are optional,
365
 
        repeated, etc.
366
 
 
367
 
                Examples:
368
 
 
369
 
                ['to_location', 'from_branch?', 'file*']
370
 
 
371
 
                'to_location' is required
372
 
                'from_branch' is optional
373
 
                'file' can be specified 0 or more times
374
 
 
375
 
    takes_options
376
 
        List of options that may be given for this command.  These can
377
 
        be either strings, referring to globally-defined options,
378
 
        or option objects.  Retrieve through options().
379
 
 
380
 
    hidden
381
 
        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
382
378
        for commands intended for expert users.
383
379
 
384
 
    encoding_type
385
 
        Command objects will get a 'outf' attribute, which has been
386
 
        setup to properly handle encoding of unicode strings.
387
 
        encoding_type determines what will happen when characters cannot
388
 
        be encoded
389
 
            strict - abort if we cannot decode
390
 
            replace - put in a bogus character (typically '?')
391
 
            exact - do not encode sys.stdout
392
 
 
393
 
            NOTE: by default on Windows, sys.stdout is opened as a text
394
 
            stream, therefore LF line-endings are converted to CRLF.
395
 
            When a command uses encoding_type = 'exact', then
396
 
            sys.stdout is forced to be a binary stream, and line-endings
397
 
            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.)
398
398
 
399
399
    :cvar hooks: An instance of CommandHooks.
 
400
 
 
401
    :cvar __doc__: The help shown by 'bzr help command' for this command.
 
402
        This is set by assigning explicitly to __doc__ so that -OO can
 
403
        be used::
 
404
 
 
405
            class Foo(Command):
 
406
                __doc__ = "My help goes here"
400
407
    """
401
408
    aliases = []
402
409
    takes_args = []
403
410
    takes_options = []
404
411
    encoding_type = 'strict'
 
412
    invoked_as = None
 
413
    l10n = True
405
414
 
406
415
    hidden = False
407
416
 
408
417
    def __init__(self):
409
418
        """Construct an instance of this command."""
410
 
        if self.__doc__ == Command.__doc__:
411
 
            warn("No help message set for %r" % self)
412
419
        # List of standard options directly supported
413
420
        self.supported_std_options = []
414
421
        self._setup_run()
481
488
            usage help (e.g. Purpose, Usage, Options) with a
482
489
            message explaining how to obtain full help.
483
490
        """
 
491
        if self.l10n and not i18n.installed():
 
492
            i18n.install()  # Install i18n only for get_help_text for now.
484
493
        doc = self.help()
485
 
        if doc is None:
486
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
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.")
487
503
 
488
504
        # Extract the summary (purpose) and sections out from the text
489
505
        purpose,sections,order = self._get_help_parts(doc)
496
512
 
497
513
        # The header is the purpose and usage
498
514
        result = ""
499
 
        result += ':Purpose: %s\n' % purpose
 
515
        result += gettext(':Purpose: %s\n') % (purpose,)
500
516
        if usage.find('\n') >= 0:
501
 
            result += ':Usage:\n%s\n' % usage
 
517
            result += gettext(':Usage:\n%s\n') % (usage,)
502
518
        else:
503
 
            result += ':Usage:   %s\n' % usage
 
519
            result += gettext(':Usage:   %s\n') % (usage,)
504
520
        result += '\n'
505
521
 
506
522
        # Add the options
508
524
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
509
525
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
510
526
        # 20090319
511
 
        options = option.get_optparser(self.options()).format_option_help()
512
 
        # XXX: According to the spec, ReST option lists actually don't support 
513
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
514
 
        # As that pattern always appears in the commands that break, we trap
515
 
        # on that and then format that block of 'format' options as a literal
516
 
        # block.
517
 
        if not plain and options.find('  --1.9  ') != -1:
 
527
        parser = option.get_optparser(self.options())
 
528
        options = parser.format_option_help()
 
529
        # FIXME: According to the spec, ReST option lists actually don't
 
530
        # support options like --1.14 so that causes syntax errors (in Sphinx
 
531
        # at least).  As that pattern always appears in the commands that
 
532
        # break, we trap on that and then format that block of 'format' options
 
533
        # as a literal block. We use the most recent format still listed so we
 
534
        # don't have to do that too often -- vila 20110514
 
535
        if not plain and options.find('  --1.14  ') != -1:
518
536
            options = options.replace(' format:\n', ' format::\n\n', 1)
519
537
        if options.startswith('Options:'):
520
 
            result += ':' + options
521
 
        elif options.startswith('options:'):
522
 
            # Python 2.4 version of optparse
523
 
            result += ':Options:' + options[len('options:'):]
 
538
            result += gettext(':Options:%s') % (options[len('options:'):],)
524
539
        else:
525
540
            result += options
526
541
        result += '\n'
531
546
            if sections.has_key(None):
532
547
                text = sections.pop(None)
533
548
                text = '\n  '.join(text.splitlines())
534
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
549
                result += gettext(':Description:\n  %s\n\n') % (text,)
535
550
 
536
551
            # Add the custom sections (e.g. Examples). Note that there's no need
537
552
            # to indent these as they must be indented already in the source.
538
553
            if sections:
539
554
                for label in order:
540
 
                    if sections.has_key(label):
541
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
555
                    if label in sections:
 
556
                        result += ':%s:\n%s\n' % (label, sections[label])
542
557
                result += '\n'
543
558
        else:
544
 
            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")
545
560
                % self.name())
546
561
 
547
562
        # Add the aliases, source (plug-in) and see also links, if any
548
563
        if self.aliases:
549
 
            result += ':Aliases:  '
 
564
            result += gettext(':Aliases:  ')
550
565
            result += ', '.join(self.aliases) + '\n'
551
566
        plugin_name = self.plugin_name()
552
567
        if plugin_name is not None:
553
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
568
            result += gettext(':From:     plugin "%s"\n') % plugin_name
554
569
        see_also = self.get_see_also(additional_see_also)
555
570
        if see_also:
556
571
            if not plain and see_also_as_links:
562
577
                        see_also_links.append(item)
563
578
                    else:
564
579
                        # Use a Sphinx link for this entry
565
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
580
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
566
581
                        see_also_links.append(link_text)
567
582
                see_also = see_also_links
568
 
            result += ':See also: '
569
 
            result += ', '.join(see_also) + '\n'
 
583
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
570
584
 
571
585
        # If this will be rendered as plain text, convert it
572
586
        if plain:
653
667
    def run_argv_aliases(self, argv, alias_argv=None):
654
668
        """Parse the command line and run with extra aliases in alias_argv."""
655
669
        args, opts = parse_args(self, argv, alias_argv)
 
670
        self._setup_outf()
656
671
 
657
672
        # Process the standard options
658
673
        if 'help' in opts:  # e.g. bzr add --help
659
 
            sys.stdout.write(self.get_help_text())
 
674
            self.outf.write(self.get_help_text())
660
675
            return 0
661
676
        if 'usage' in opts:  # e.g. bzr add --usage
662
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
677
            self.outf.write(self.get_help_text(verbose=False))
663
678
            return 0
664
679
        trace.set_verbosity_level(option._verbosity_level)
665
680
        if 'verbose' in self.supported_std_options:
680
695
        all_cmd_args = cmdargs.copy()
681
696
        all_cmd_args.update(cmdopts)
682
697
 
683
 
        self._setup_outf()
684
 
 
685
 
        return self.run(**all_cmd_args)
 
698
        try:
 
699
            return self.run(**all_cmd_args)
 
700
        finally:
 
701
            # reset it, so that other commands run in the same process won't
 
702
            # inherit state. Before we reset it, log any activity, so that it
 
703
            # gets properly tracked.
 
704
            ui.ui_factory.log_transport_activity(
 
705
                display=('bytes' in debug.debug_flags))
 
706
            trace.set_verbosity_level(0)
686
707
 
687
708
    def _setup_run(self):
688
709
        """Wrap the defined run method on self with a cleanup.
738
759
            return None
739
760
        return getdoc(self)
740
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
 
741
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
        """
742
775
        return _unsquish_command_name(self.__class__.__name__)
743
776
 
744
777
    def plugin_name(self):
762
795
        These are all empty initially, because by default nothing should get
763
796
        notified.
764
797
        """
765
 
        Hooks.__init__(self)
766
 
        self.create_hook(HookPoint('extend_command',
 
798
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
 
799
        self.add_hook('extend_command',
767
800
            "Called after creating a command object to allow modifications "
768
801
            "such as adding or removing options, docs etc. Called with the "
769
 
            "new bzrlib.commands.Command object.", (1, 13), None))
770
 
        self.create_hook(HookPoint('get_command',
 
802
            "new bzrlib.commands.Command object.", (1, 13))
 
803
        self.add_hook('get_command',
771
804
            "Called when creating a single command. Called with "
772
805
            "(cmd_or_None, command_name). get_command should either return "
773
806
            "the cmd_or_None parameter, or a replacement Command object that "
774
807
            "should be used for the command. Note that the Command.hooks "
775
808
            "hooks are core infrastructure. Many users will prefer to use "
776
809
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
777
 
            (1, 17), None))
778
 
        self.create_hook(HookPoint('get_missing_command',
 
810
            (1, 17))
 
811
        self.add_hook('get_missing_command',
779
812
            "Called when creating a single command if no command could be "
780
813
            "found. Called with (command_name). get_missing_command should "
781
814
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
 
815
            "command.", (1, 17))
 
816
        self.add_hook('list_commands',
784
817
            "Called when enumerating commands. Called with a set of "
785
818
            "cmd_name strings for all the commands found so far. This set "
786
819
            " is safe to mutate - e.g. to remove a command. "
787
820
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
 
821
            (1, 17))
789
822
 
790
823
Command.hooks = CommandHooks()
791
824
 
805
838
    else:
806
839
        args = argv
807
840
 
808
 
    options, args = parser.parse_args(args)
 
841
    # for python 2.5 and later, optparse raises this exception if a non-ascii
 
842
    # option name is given.  See http://bugs.python.org/issue2931
 
843
    try:
 
844
        options, args = parser.parse_args(args)
 
845
    except UnicodeEncodeError,e:
 
846
        raise errors.BzrCommandError('Only ASCII permitted in option names')
 
847
 
809
848
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
849
                 v is not option.OptionParser.DEFAULT_VALUE])
811
850
    return args, opts
1015
1054
        Specify the number of processes that can be run concurrently (selftest).
1016
1055
    """
1017
1056
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
 
    argv = list(argv)
 
1057
    argv = _specified_or_unicode_argv(argv)
1019
1058
    trace.mutter("bzr arguments: %r", argv)
1020
1059
 
1021
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1022
 
                opt_no_aliases = False
 
1060
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1061
            opt_no_l10n = opt_no_aliases = False
1023
1062
    opt_lsprof_file = opt_coverage_dir = None
1024
1063
 
1025
1064
    # --no-plugins is handled specially at a very early stage. We need
1042
1081
            opt_no_plugins = True
1043
1082
        elif a == '--no-aliases':
1044
1083
            opt_no_aliases = True
 
1084
        elif a == '--no-l10n':
 
1085
            opt_no_l10n = True
1045
1086
        elif a == '--builtin':
1046
1087
            opt_builtin = True
1047
1088
        elif a == '--concurrency':
1050
1091
        elif a == '--coverage':
1051
1092
            opt_coverage_dir = argv[i + 1]
1052
1093
            i += 1
 
1094
        elif a == '--profile-imports':
 
1095
            pass # already handled in startup script Bug #588277
1053
1096
        elif a.startswith('-D'):
1054
1097
            debug.debug_flags.add(a[2:])
1055
1098
        else:
1077
1120
    if not opt_no_aliases:
1078
1121
        alias_argv = get_alias(argv[0])
1079
1122
        if alias_argv:
1080
 
            user_encoding = osutils.get_user_encoding()
1081
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1123
            argv[0] = alias_argv.pop(0)
1083
1124
 
1084
1125
    cmd = argv.pop(0)
1085
 
    # We want only 'ascii' command names, but the user may have typed
1086
 
    # in a Unicode name. In that case, they should just get a
1087
 
    # 'command not found' error later.
1088
 
 
1089
1126
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1127
    if opt_no_l10n:
 
1128
        cmd.l10n = False
1090
1129
    run = cmd_obj.run_argv_aliases
1091
1130
    run_argv = [argv, alias_argv]
1092
1131
 
1165
1204
        new_argv = []
1166
1205
        try:
1167
1206
            # ensure all arguments are unicode strings
1168
 
            for a in argv[1:]:
 
1207
            for a in argv:
1169
1208
                if isinstance(a, unicode):
1170
1209
                    new_argv.append(a)
1171
1210
                else:
1187
1226
 
1188
1227
    :return: exit code of bzr command.
1189
1228
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
 
1229
    if argv is not None:
 
1230
        argv = argv[1:]
1191
1231
    _register_builtin_commands()
1192
1232
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
1233
    trace.mutter("return code %d", ret)
1196
1234
    return ret
1197
1235
 
1250
1288
 
1251
1289
 
1252
1290
class Provider(object):
1253
 
    '''Generic class to be overriden by plugins'''
 
1291
    """Generic class to be overriden by plugins"""
1254
1292
 
1255
1293
    def plugin_for_command(self, cmd_name):
1256
 
        '''Takes a command and returns the information for that plugin
 
1294
        """Takes a command and returns the information for that plugin
1257
1295
 
1258
1296
        :return: A dictionary with all the available information
1259
 
        for the requested plugin
1260
 
        '''
 
1297
            for the requested plugin
 
1298
        """
1261
1299
        raise NotImplementedError
1262
1300
 
1263
1301
 
1264
1302
class ProvidersRegistry(registry.Registry):
1265
 
    '''This registry exists to allow other providers to exist'''
 
1303
    """This registry exists to allow other providers to exist"""
1266
1304
 
1267
1305
    def __iter__(self):
1268
1306
        for key, provider in self.iteritems():