← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

(gz) Fix test failure on alpha by correcting format string for
 gc_chk_sha1_record (Martin [gz])

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
30
31
import errno
31
32
import threading
 
33
from warnings import warn
32
34
 
33
35
import bzrlib
34
36
from bzrlib import (
36
38
    cmdline,
37
39
    debug,
38
40
    errors,
39
 
    i18n,
40
41
    option,
41
42
    osutils,
42
43
    trace,
43
44
    ui,
 
45
    win32utils,
44
46
    )
45
47
""")
46
48
 
47
 
from bzrlib.hooks import Hooks
48
 
from bzrlib.i18n import gettext
 
49
from bzrlib.hooks import HookPoint, Hooks
49
50
# Compatibility - Option used to be in commands.
50
51
from bzrlib.option import Option
51
52
from bzrlib.plugin import disable_plugins, load_plugins
164
165
    return cmd[4:].replace('_','-')
165
166
 
166
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
 
169
def _builtin_commands():
 
170
    """Return a dict of {name: cmd_class} for builtin commands.
 
171
 
 
172
    :deprecated: Use the builtin_command_registry registry instead
 
173
    """
 
174
    # return dict(name: cmd_class)
 
175
    return dict(builtin_command_registry.items())
 
176
 
 
177
 
167
178
def _register_builtin_commands():
168
179
    if builtin_command_registry.keys():
169
180
        # only load once
229
240
    try:
230
241
        return _get_cmd_object(cmd_name, plugins_override)
231
242
    except KeyError:
232
 
        raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
 
243
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
233
244
 
234
245
 
235
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
265
276
    # Allow plugins to extend commands
266
277
    for hook in Command.hooks['extend_command']:
267
278
        hook(cmd)
268
 
    if getattr(cmd, 'invoked_as', None) is None:
269
 
        cmd.invoked_as = cmd_name
270
279
    return cmd
271
280
 
272
281
 
349
358
    summary, then a complete description of the command.  A grammar
350
359
    description will be inserted.
351
360
 
352
 
    :cvar aliases: Other accepted names for this command.
353
 
 
354
 
    :cvar takes_args: List of argument forms, marked with whether they are
355
 
        optional, repeated, etc.  Examples::
356
 
 
357
 
            ['to_location', 'from_branch?', 'file*']
358
 
 
359
 
        * 'to_location' is required
360
 
        * 'from_branch' is optional
361
 
        * 'file' can be specified 0 or more times
362
 
 
363
 
    :cvar takes_options: List of options that may be given for this command.
364
 
        These can be either strings, referring to globally-defined options, or
365
 
        option objects.  Retrieve through options().
366
 
 
367
 
    :cvar hidden: If true, this command isn't advertised.  This is typically
 
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
368
383
        for commands intended for expert users.
369
384
 
370
 
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
 
        been setup to properly handle encoding of unicode strings.
372
 
        encoding_type determines what will happen when characters cannot be
373
 
        encoded:
374
 
 
375
 
        * strict - abort if we cannot decode
376
 
        * replace - put in a bogus character (typically '?')
377
 
        * exact - do not encode sys.stdout
378
 
 
379
 
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
 
        therefore LF line-endings are converted to CRLF.  When a command uses
381
 
        encoding_type = 'exact', then sys.stdout is forced to be a binary
382
 
        stream, and line-endings will not mangled.
383
 
 
384
 
    :cvar invoked_as:
385
 
        A string indicating the real name under which this command was
386
 
        invoked, before expansion of aliases.
387
 
        (This may be None if the command was constructed and run in-process.)
 
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.
388
399
 
389
400
    :cvar hooks: An instance of CommandHooks.
390
 
 
391
 
    :cvar __doc__: The help shown by 'bzr help command' for this command.
 
401
    :ivar __doc__: The help shown by 'bzr help command' for this command.
392
402
        This is set by assigning explicitly to __doc__ so that -OO can
393
403
        be used::
394
404
 
395
 
            class Foo(Command):
396
 
                __doc__ = "My help goes here"
 
405
        class Foo(Command):
 
406
            __doc__ = "My help goes here"
397
407
    """
398
408
    aliases = []
399
409
    takes_args = []
400
410
    takes_options = []
401
411
    encoding_type = 'strict'
402
 
    invoked_as = None
403
 
    l10n = True
404
412
 
405
413
    hidden = False
406
414
 
432
440
        """
433
441
        self._operation.cleanup_now()
434
442
 
 
443
    @deprecated_method(deprecated_in((2, 1, 0)))
 
444
    def _maybe_expand_globs(self, file_list):
 
445
        """Glob expand file_list if the platform does not do that itself.
 
446
 
 
447
        Not used anymore, now that the bzr command-line parser globs on
 
448
        Windows.
 
449
 
 
450
        :return: A possibly empty list of unicode paths.
 
451
 
 
452
        Introduced in bzrlib 0.18.
 
453
        """
 
454
        return file_list
 
455
 
435
456
    def _usage(self):
436
457
        """Return single-line grammar for this command.
437
458
 
465
486
            usage help (e.g. Purpose, Usage, Options) with a
466
487
            message explaining how to obtain full help.
467
488
        """
468
 
        if self.l10n:
469
 
            i18n.install()  # Install i18n only for get_help_text for now.
470
489
        doc = self.help()
471
 
        if doc:
472
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
473
 
            # be shown after "Description" section and we don't want to
474
 
            # translate the usage string.
475
 
            # Though, bzr export-pot don't exports :Usage: section and it must
476
 
            # not be translated.
477
 
            doc = self.gettext(doc)
478
 
        else:
479
 
            doc = gettext("No help for this command.")
 
490
        if not doc:
 
491
            doc = "No help for this command."
480
492
 
481
493
        # Extract the summary (purpose) and sections out from the text
482
494
        purpose,sections,order = self._get_help_parts(doc)
489
501
 
490
502
        # The header is the purpose and usage
491
503
        result = ""
492
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
504
        result += ':Purpose: %s\n' % purpose
493
505
        if usage.find('\n') >= 0:
494
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
506
            result += ':Usage:\n%s\n' % usage
495
507
        else:
496
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
508
            result += ':Usage:   %s\n' % usage
497
509
        result += '\n'
498
510
 
499
511
        # Add the options
501
513
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
502
514
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
503
515
        # 20090319
504
 
        parser = option.get_optparser(self.options())
505
 
        options = parser.format_option_help()
506
 
        # FIXME: According to the spec, ReST option lists actually don't
507
 
        # support options like --1.14 so that causes syntax errors (in Sphinx
508
 
        # at least).  As that pattern always appears in the commands that
509
 
        # break, we trap on that and then format that block of 'format' options
510
 
        # as a literal block. We use the most recent format still listed so we
511
 
        # don't have to do that too often -- vila 20110514
512
 
        if not plain and options.find('  --1.14  ') != -1:
 
516
        options = option.get_optparser(self.options()).format_option_help()
 
517
        # XXX: According to the spec, ReST option lists actually don't support 
 
518
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
519
        # As that pattern always appears in the commands that break, we trap
 
520
        # on that and then format that block of 'format' options as a literal
 
521
        # block.
 
522
        if not plain and options.find('  --1.9  ') != -1:
513
523
            options = options.replace(' format:\n', ' format::\n\n', 1)
514
524
        if options.startswith('Options:'):
515
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
525
            result += ':' + options
 
526
        elif options.startswith('options:'):
 
527
            # Python 2.4 version of optparse
 
528
            result += ':Options:' + options[len('options:'):]
516
529
        else:
517
530
            result += options
518
531
        result += '\n'
523
536
            if sections.has_key(None):
524
537
                text = sections.pop(None)
525
538
                text = '\n  '.join(text.splitlines())
526
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
539
                result += ':%s:\n  %s\n\n' % ('Description',text)
527
540
 
528
541
            # Add the custom sections (e.g. Examples). Note that there's no need
529
542
            # to indent these as they must be indented already in the source.
530
543
            if sections:
531
544
                for label in order:
532
 
                    if label in sections:
533
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
545
                    if sections.has_key(label):
 
546
                        result += ':%s:\n%s\n' % (label,sections[label])
534
547
                result += '\n'
535
548
        else:
536
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
549
            result += ("See bzr help %s for more details and examples.\n\n"
537
550
                % self.name())
538
551
 
539
552
        # Add the aliases, source (plug-in) and see also links, if any
540
553
        if self.aliases:
541
 
            result += gettext(':Aliases:  ')
 
554
            result += ':Aliases:  '
542
555
            result += ', '.join(self.aliases) + '\n'
543
556
        plugin_name = self.plugin_name()
544
557
        if plugin_name is not None:
545
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
558
            result += ':From:     plugin "%s"\n' % plugin_name
546
559
        see_also = self.get_see_also(additional_see_also)
547
560
        if see_also:
548
561
            if not plain and see_also_as_links:
554
567
                        see_also_links.append(item)
555
568
                    else:
556
569
                        # Use a Sphinx link for this entry
557
 
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
558
 
                                                                    item, item)
 
570
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
559
571
                        see_also_links.append(link_text)
560
572
                see_also = see_also_links
561
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
573
            result += ':See also: '
 
574
            result += ', '.join(see_also) + '\n'
562
575
 
563
576
        # If this will be rendered as plain text, convert it
564
577
        if plain:
645
658
    def run_argv_aliases(self, argv, alias_argv=None):
646
659
        """Parse the command line and run with extra aliases in alias_argv."""
647
660
        args, opts = parse_args(self, argv, alias_argv)
648
 
        self._setup_outf()
649
661
 
650
662
        # Process the standard options
651
663
        if 'help' in opts:  # e.g. bzr add --help
652
 
            self.outf.write(self.get_help_text())
 
664
            sys.stdout.write(self.get_help_text())
653
665
            return 0
654
666
        if 'usage' in opts:  # e.g. bzr add --usage
655
 
            self.outf.write(self.get_help_text(verbose=False))
 
667
            sys.stdout.write(self.get_help_text(verbose=False))
656
668
            return 0
657
669
        trace.set_verbosity_level(option._verbosity_level)
658
670
        if 'verbose' in self.supported_std_options:
673
685
        all_cmd_args = cmdargs.copy()
674
686
        all_cmd_args.update(cmdopts)
675
687
 
 
688
        self._setup_outf()
 
689
 
676
690
        try:
677
691
            return self.run(**all_cmd_args)
678
692
        finally:
701
715
                del self._operation
702
716
        self.run = run
703
717
 
 
718
    @deprecated_method(deprecated_in((2, 2, 0)))
 
719
    def run_direct(self, *args, **kwargs):
 
720
        """Deprecated thunk from bzrlib 2.1."""
 
721
        return self.run(*args, **kwargs)
 
722
 
704
723
    def run(self):
705
724
        """Actually run the command.
706
725
 
732
751
            return None
733
752
        return getdoc(self)
734
753
 
735
 
    def gettext(self, message):
736
 
        """Returns the gettext function used to translate this command's help.
737
 
 
738
 
        Commands provided by plugins should override this to use their
739
 
        own i18n system.
740
 
        """
741
 
        return i18n.gettext_per_paragraph(message)
742
 
 
743
754
    def name(self):
744
 
        """Return the canonical name for this command.
745
 
 
746
 
        The name under which it was actually invoked is available in invoked_as.
747
 
        """
748
755
        return _unsquish_command_name(self.__class__.__name__)
749
756
 
750
757
    def plugin_name(self):
768
775
        These are all empty initially, because by default nothing should get
769
776
        notified.
770
777
        """
771
 
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
 
        self.add_hook('extend_command',
 
778
        Hooks.__init__(self)
 
779
        self.create_hook(HookPoint('extend_command',
773
780
            "Called after creating a command object to allow modifications "
774
781
            "such as adding or removing options, docs etc. Called with the "
775
 
            "new bzrlib.commands.Command object.", (1, 13))
776
 
        self.add_hook('get_command',
 
782
            "new bzrlib.commands.Command object.", (1, 13), None))
 
783
        self.create_hook(HookPoint('get_command',
777
784
            "Called when creating a single command. Called with "
778
785
            "(cmd_or_None, command_name). get_command should either return "
779
786
            "the cmd_or_None parameter, or a replacement Command object that "
780
787
            "should be used for the command. Note that the Command.hooks "
781
788
            "hooks are core infrastructure. Many users will prefer to use "
782
789
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
 
            (1, 17))
784
 
        self.add_hook('get_missing_command',
 
790
            (1, 17), None))
 
791
        self.create_hook(HookPoint('get_missing_command',
785
792
            "Called when creating a single command if no command could be "
786
793
            "found. Called with (command_name). get_missing_command should "
787
794
            "either return None, or a Command object to be used for the "
788
 
            "command.", (1, 17))
789
 
        self.add_hook('list_commands',
 
795
            "command.", (1, 17), None))
 
796
        self.create_hook(HookPoint('list_commands',
790
797
            "Called when enumerating commands. Called with a set of "
791
798
            "cmd_name strings for all the commands found so far. This set "
792
799
            " is safe to mutate - e.g. to remove a command. "
793
800
            "list_commands should return the updated set of command names.",
794
 
            (1, 17))
 
801
            (1, 17), None))
795
802
 
796
803
Command.hooks = CommandHooks()
797
804
 
816
823
    try:
817
824
        options, args = parser.parse_args(args)
818
825
    except UnicodeEncodeError,e:
819
 
        raise errors.BzrCommandError(gettext('Only ASCII permitted in option names'))
 
826
        raise errors.BzrCommandError('Only ASCII permitted in option names')
820
827
 
821
828
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
822
829
                 v is not option.OptionParser.DEFAULT_VALUE])
840
847
                argdict[argname + '_list'] = None
841
848
        elif ap[-1] == '+':
842
849
            if not args:
843
 
                raise errors.BzrCommandError(gettext(
844
 
                      "command {0!r} needs one or more {1}").format(
845
 
                      cmd, argname.upper()))
 
850
                raise errors.BzrCommandError("command %r needs one or more %s"
 
851
                                             % (cmd, argname.upper()))
846
852
            else:
847
853
                argdict[argname + '_list'] = args[:]
848
854
                args = []
849
855
        elif ap[-1] == '$': # all but one
850
856
            if len(args) < 2:
851
 
                raise errors.BzrCommandError(
852
 
                      gettext("command {0!r} needs one or more {1}").format(
853
 
                                             cmd, argname.upper()))
 
857
                raise errors.BzrCommandError("command %r needs one or more %s"
 
858
                                             % (cmd, argname.upper()))
854
859
            argdict[argname + '_list'] = args[:-1]
855
860
            args[:-1] = []
856
861
        else:
857
862
            # just a plain arg
858
863
            argname = ap
859
864
            if not args:
860
 
                raise errors.BzrCommandError(
861
 
                     gettext("command {0!r} requires argument {1}").format(
862
 
                               cmd, argname.upper()))
 
865
                raise errors.BzrCommandError("command %r requires argument %s"
 
866
                               % (cmd, argname.upper()))
863
867
            else:
864
868
                argdict[argname] = args.pop(0)
865
869
 
866
870
    if args:
867
 
        raise errors.BzrCommandError( gettext(
868
 
                              "extra argument to command {0}: {1}").format(
869
 
                                       cmd, args[0]) )
 
871
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
872
                                     % (cmd, args[0]))
870
873
 
871
874
    return argdict
872
875
 
955
958
 
956
959
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
960
    from bzrlib.lsprof import profile
958
 
    ret, stats = profile(exception_to_return_code, the_callable,
959
 
                         *args, **kwargs)
 
961
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
960
962
    stats.sort()
961
963
    if filename is None:
962
964
        stats.pprint()
963
965
    else:
964
966
        stats.save(filename)
965
 
        trace.note(gettext('Profile data written to "%s".'), filename)
 
967
        trace.note('Profile data written to "%s".', filename)
966
968
    return ret
967
969
 
968
970
 
 
971
@deprecated_function(deprecated_in((2, 2, 0)))
 
972
def shlex_split_unicode(unsplit):
 
973
    return cmdline.split(unsplit)
 
974
 
 
975
 
969
976
def get_alias(cmd, config=None):
970
977
    """Return an expanded alias, or None if no alias exists.
971
978
 
1027
1034
        Specify the number of processes that can be run concurrently (selftest).
1028
1035
    """
1029
1036
    trace.mutter("bazaar version: " + bzrlib.__version__)
1030
 
    argv = _specified_or_unicode_argv(argv)
 
1037
    argv = list(argv)
1031
1038
    trace.mutter("bzr arguments: %r", argv)
1032
1039
 
1033
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1034
 
            opt_no_l10n = opt_no_aliases = False
 
1040
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1041
                opt_no_aliases = False
1035
1042
    opt_lsprof_file = opt_coverage_dir = None
1036
1043
 
1037
1044
    # --no-plugins is handled specially at a very early stage. We need
1054
1061
            opt_no_plugins = True
1055
1062
        elif a == '--no-aliases':
1056
1063
            opt_no_aliases = True
1057
 
        elif a == '--no-l10n':
1058
 
            opt_no_l10n = True
1059
1064
        elif a == '--builtin':
1060
1065
            opt_builtin = True
1061
1066
        elif a == '--concurrency':
1097
1102
 
1098
1103
    cmd = argv.pop(0)
1099
1104
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1100
 
    if opt_no_l10n:
1101
 
        cmd.l10n = False
1102
1105
    run = cmd_obj.run_argv_aliases
1103
1106
    run_argv = [argv, alias_argv]
1104
1107
 
1177
1180
        new_argv = []
1178
1181
        try:
1179
1182
            # ensure all arguments are unicode strings
1180
 
            for a in argv:
 
1183
            for a in argv[1:]:
1181
1184
                if isinstance(a, unicode):
1182
1185
                    new_argv.append(a)
1183
1186
                else:
1199
1202
 
1200
1203
    :return: exit code of bzr command.
1201
1204
    """
1202
 
    if argv is not None:
1203
 
        argv = argv[1:]
 
1205
    argv = _specified_or_unicode_argv(argv)
1204
1206
    _register_builtin_commands()
1205
1207
    ret = run_bzr_catch_errors(argv)
1206
1208
    trace.mutter("return code %d", ret)
1261
1263
 
1262
1264
 
1263
1265
class Provider(object):
1264
 
    """Generic class to be overriden by plugins"""
 
1266
    '''Generic class to be overriden by plugins'''
1265
1267
 
1266
1268
    def plugin_for_command(self, cmd_name):
1267
 
        """Takes a command and returns the information for that plugin
 
1269
        '''Takes a command and returns the information for that plugin
1268
1270
 
1269
1271
        :return: A dictionary with all the available information
1270
 
            for the requested plugin
1271
 
        """
 
1272
        for the requested plugin
 
1273
        '''
1272
1274
        raise NotImplementedError
1273
1275
 
1274
1276
 
1275
1277
class ProvidersRegistry(registry.Registry):
1276
 
    """This registry exists to allow other providers to exist"""
 
1278
    '''This registry exists to allow other providers to exist'''
1277
1279
 
1278
1280
    def __iter__(self):
1279
1281
        for key, provider in self.iteritems():