← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Jelmer Vernooij
  • Date: 2011-05-04 13:09:19 UTC
  • mfrom: (5820 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5844.
  • Revision ID: jelmer@samba.org-20110504130919-dhvgkeyvw04xsuv3
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
36
36
    cmdline,
37
37
    debug,
38
38
    errors,
39
 
    i18n,
40
39
    option,
41
40
    osutils,
42
41
    trace,
45
44
""")
46
45
 
47
46
from bzrlib.hooks import Hooks
48
 
from bzrlib.i18n import gettext
49
47
# Compatibility - Option used to be in commands.
50
48
from bzrlib.option import Option
51
49
from bzrlib.plugin import disable_plugins, load_plugins
164
162
    return cmd[4:].replace('_','-')
165
163
 
166
164
 
 
165
@deprecated_function(deprecated_in((2, 2, 0)))
 
166
def _builtin_commands():
 
167
    """Return a dict of {name: cmd_class} for builtin commands.
 
168
 
 
169
    :deprecated: Use the builtin_command_registry registry instead
 
170
    """
 
171
    # return dict(name: cmd_class)
 
172
    return dict(builtin_command_registry.items())
 
173
 
 
174
 
167
175
def _register_builtin_commands():
168
176
    if builtin_command_registry.keys():
169
177
        # only load once
229
237
    try:
230
238
        return _get_cmd_object(cmd_name, plugins_override)
231
239
    except KeyError:
232
 
        raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
 
240
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
233
241
 
234
242
 
235
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
349
357
    summary, then a complete description of the command.  A grammar
350
358
    description will be inserted.
351
359
 
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
 
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
368
382
        for commands intended for expert users.
369
383
 
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:
 
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.
 
398
 
 
399
    :ivar invoked_as:
385
400
        A string indicating the real name under which this command was
386
 
        invoked, before expansion of aliases.
 
401
        invoked, before expansion of aliases. 
387
402
        (This may be None if the command was constructed and run in-process.)
388
403
 
389
404
    :cvar hooks: An instance of CommandHooks.
390
405
 
391
 
    :cvar __doc__: The help shown by 'bzr help command' for this command.
 
406
    :ivar __doc__: The help shown by 'bzr help command' for this command.
392
407
        This is set by assigning explicitly to __doc__ so that -OO can
393
408
        be used::
394
409
 
395
 
            class Foo(Command):
396
 
                __doc__ = "My help goes here"
 
410
        class Foo(Command):
 
411
            __doc__ = "My help goes here"
397
412
    """
398
413
    aliases = []
399
414
    takes_args = []
400
415
    takes_options = []
401
416
    encoding_type = 'strict'
402
417
    invoked_as = None
403
 
    l10n = True
404
418
 
405
419
    hidden = False
406
420
 
432
446
        """
433
447
        self._operation.cleanup_now()
434
448
 
 
449
    @deprecated_method(deprecated_in((2, 1, 0)))
 
450
    def _maybe_expand_globs(self, file_list):
 
451
        """Glob expand file_list if the platform does not do that itself.
 
452
 
 
453
        Not used anymore, now that the bzr command-line parser globs on
 
454
        Windows.
 
455
 
 
456
        :return: A possibly empty list of unicode paths.
 
457
 
 
458
        Introduced in bzrlib 0.18.
 
459
        """
 
460
        return file_list
 
461
 
435
462
    def _usage(self):
436
463
        """Return single-line grammar for this command.
437
464
 
465
492
            usage help (e.g. Purpose, Usage, Options) with a
466
493
            message explaining how to obtain full help.
467
494
        """
468
 
        if self.l10n:
469
 
            i18n.install()  # Install i18n only for get_help_text for now.
470
495
        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.")
 
496
        if not doc:
 
497
            doc = "No help for this command."
480
498
 
481
499
        # Extract the summary (purpose) and sections out from the text
482
500
        purpose,sections,order = self._get_help_parts(doc)
489
507
 
490
508
        # The header is the purpose and usage
491
509
        result = ""
492
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
510
        result += ':Purpose: %s\n' % purpose
493
511
        if usage.find('\n') >= 0:
494
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
512
            result += ':Usage:\n%s\n' % usage
495
513
        else:
496
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
514
            result += ':Usage:   %s\n' % usage
497
515
        result += '\n'
498
516
 
499
517
        # Add the options
501
519
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
502
520
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
503
521
        # 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:
 
522
        options = option.get_optparser(self.options()).format_option_help()
 
523
        # XXX: According to the spec, ReST option lists actually don't support 
 
524
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
525
        # As that pattern always appears in the commands that break, we trap
 
526
        # on that and then format that block of 'format' options as a literal
 
527
        # block.
 
528
        if not plain and options.find('  --1.9  ') != -1:
513
529
            options = options.replace(' format:\n', ' format::\n\n', 1)
514
530
        if options.startswith('Options:'):
515
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
531
            result += ':' + options
 
532
        elif options.startswith('options:'):
 
533
            # Python 2.4 version of optparse
 
534
            result += ':Options:' + options[len('options:'):]
516
535
        else:
517
536
            result += options
518
537
        result += '\n'
523
542
            if sections.has_key(None):
524
543
                text = sections.pop(None)
525
544
                text = '\n  '.join(text.splitlines())
526
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
545
                result += ':%s:\n  %s\n\n' % ('Description',text)
527
546
 
528
547
            # Add the custom sections (e.g. Examples). Note that there's no need
529
548
            # to indent these as they must be indented already in the source.
530
549
            if sections:
531
550
                for label in order:
532
 
                    if label in sections:
533
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
551
                    if sections.has_key(label):
 
552
                        result += ':%s:\n%s\n' % (label,sections[label])
534
553
                result += '\n'
535
554
        else:
536
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
555
            result += ("See bzr help %s for more details and examples.\n\n"
537
556
                % self.name())
538
557
 
539
558
        # Add the aliases, source (plug-in) and see also links, if any
540
559
        if self.aliases:
541
 
            result += gettext(':Aliases:  ')
 
560
            result += ':Aliases:  '
542
561
            result += ', '.join(self.aliases) + '\n'
543
562
        plugin_name = self.plugin_name()
544
563
        if plugin_name is not None:
545
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
564
            result += ':From:     plugin "%s"\n' % plugin_name
546
565
        see_also = self.get_see_also(additional_see_also)
547
566
        if see_also:
548
567
            if not plain and see_also_as_links:
554
573
                        see_also_links.append(item)
555
574
                    else:
556
575
                        # Use a Sphinx link for this entry
557
 
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
558
 
                                                                    item, item)
 
576
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
559
577
                        see_also_links.append(link_text)
560
578
                see_also = see_also_links
561
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
579
            result += ':See also: '
 
580
            result += ', '.join(see_also) + '\n'
562
581
 
563
582
        # If this will be rendered as plain text, convert it
564
583
        if plain:
645
664
    def run_argv_aliases(self, argv, alias_argv=None):
646
665
        """Parse the command line and run with extra aliases in alias_argv."""
647
666
        args, opts = parse_args(self, argv, alias_argv)
648
 
        self._setup_outf()
649
667
 
650
668
        # Process the standard options
651
669
        if 'help' in opts:  # e.g. bzr add --help
652
 
            self.outf.write(self.get_help_text())
 
670
            sys.stdout.write(self.get_help_text())
653
671
            return 0
654
672
        if 'usage' in opts:  # e.g. bzr add --usage
655
 
            self.outf.write(self.get_help_text(verbose=False))
 
673
            sys.stdout.write(self.get_help_text(verbose=False))
656
674
            return 0
657
675
        trace.set_verbosity_level(option._verbosity_level)
658
676
        if 'verbose' in self.supported_std_options:
663
681
            opts['quiet'] = trace.is_quiet()
664
682
        elif opts.has_key('quiet'):
665
683
            del opts['quiet']
 
684
 
666
685
        # mix arguments and options into one dictionary
667
686
        cmdargs = _match_argform(self.name(), self.takes_args, args)
668
687
        cmdopts = {}
672
691
        all_cmd_args = cmdargs.copy()
673
692
        all_cmd_args.update(cmdopts)
674
693
 
 
694
        self._setup_outf()
 
695
 
675
696
        try:
676
697
            return self.run(**all_cmd_args)
677
698
        finally:
700
721
                del self._operation
701
722
        self.run = run
702
723
 
 
724
    @deprecated_method(deprecated_in((2, 2, 0)))
 
725
    def run_direct(self, *args, **kwargs):
 
726
        """Deprecated thunk from bzrlib 2.1."""
 
727
        return self.run(*args, **kwargs)
 
728
 
703
729
    def run(self):
704
730
        """Actually run the command.
705
731
 
731
757
            return None
732
758
        return getdoc(self)
733
759
 
734
 
    def gettext(self, message):
735
 
        """Returns the gettext function used to translate this command's help.
736
 
 
737
 
        Commands provided by plugins should override this to use their
738
 
        own i18n system.
739
 
        """
740
 
        return i18n.gettext_per_paragraph(message)
741
 
 
742
760
    def name(self):
743
761
        """Return the canonical name for this command.
744
762
 
815
833
    try:
816
834
        options, args = parser.parse_args(args)
817
835
    except UnicodeEncodeError,e:
818
 
        raise errors.BzrCommandError(
819
 
            gettext('Only ASCII permitted in option names'))
 
836
        raise errors.BzrCommandError('Only ASCII permitted in option names')
820
837
 
821
838
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
822
839
                 v is not option.OptionParser.DEFAULT_VALUE])
840
857
                argdict[argname + '_list'] = None
841
858
        elif ap[-1] == '+':
842
859
            if not args:
843
 
                raise errors.BzrCommandError(gettext(
844
 
                      "command {0!r} needs one or more {1}").format(
845
 
                      cmd, argname.upper()))
 
860
                raise errors.BzrCommandError("command %r needs one or more %s"
 
861
                                             % (cmd, argname.upper()))
846
862
            else:
847
863
                argdict[argname + '_list'] = args[:]
848
864
                args = []
849
865
        elif ap[-1] == '$': # all but one
850
866
            if len(args) < 2:
851
 
                raise errors.BzrCommandError(
852
 
                      gettext("command {0!r} needs one or more {1}").format(
853
 
                                             cmd, argname.upper()))
 
867
                raise errors.BzrCommandError("command %r needs one or more %s"
 
868
                                             % (cmd, argname.upper()))
854
869
            argdict[argname + '_list'] = args[:-1]
855
870
            args[:-1] = []
856
871
        else:
857
872
            # just a plain arg
858
873
            argname = ap
859
874
            if not args:
860
 
                raise errors.BzrCommandError(
861
 
                     gettext("command {0!r} requires argument {1}").format(
862
 
                               cmd, argname.upper()))
 
875
                raise errors.BzrCommandError("command %r requires argument %s"
 
876
                               % (cmd, argname.upper()))
863
877
            else:
864
878
                argdict[argname] = args.pop(0)
865
879
 
866
880
    if args:
867
 
        raise errors.BzrCommandError( gettext(
868
 
                              "extra argument to command {0}: {1}").format(
869
 
                                       cmd, args[0]) )
 
881
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
882
                                     % (cmd, args[0]))
870
883
 
871
884
    return argdict
872
885
 
955
968
 
956
969
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
970
    from bzrlib.lsprof import profile
958
 
    ret, stats = profile(exception_to_return_code, the_callable,
959
 
                         *args, **kwargs)
 
971
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
960
972
    stats.sort()
961
973
    if filename is None:
962
974
        stats.pprint()
963
975
    else:
964
976
        stats.save(filename)
965
 
        trace.note(gettext('Profile data written to "%s".'), filename)
 
977
        trace.note('Profile data written to "%s".', filename)
966
978
    return ret
967
979
 
968
980
 
 
981
@deprecated_function(deprecated_in((2, 2, 0)))
 
982
def shlex_split_unicode(unsplit):
 
983
    return cmdline.split(unsplit)
 
984
 
 
985
 
969
986
def get_alias(cmd, config=None):
970
987
    """Return an expanded alias, or None if no alias exists.
971
988
 
1030
1047
    argv = _specified_or_unicode_argv(argv)
1031
1048
    trace.mutter("bzr arguments: %r", argv)
1032
1049
 
1033
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1034
 
            opt_no_l10n = opt_no_aliases = False
 
1050
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1051
                opt_no_aliases = False
1035
1052
    opt_lsprof_file = opt_coverage_dir = None
1036
1053
 
1037
1054
    # --no-plugins is handled specially at a very early stage. We need
1040
1057
 
1041
1058
    argv_copy = []
1042
1059
    i = 0
1043
 
    override_config = []
1044
1060
    while i < len(argv):
1045
1061
        a = argv[i]
1046
1062
        if a == '--profile':
1055
1071
            opt_no_plugins = True
1056
1072
        elif a == '--no-aliases':
1057
1073
            opt_no_aliases = True
1058
 
        elif a == '--no-l10n':
1059
 
            opt_no_l10n = True
1060
1074
        elif a == '--builtin':
1061
1075
            opt_builtin = True
1062
1076
        elif a == '--concurrency':
1069
1083
            pass # already handled in startup script Bug #588277
1070
1084
        elif a.startswith('-D'):
1071
1085
            debug.debug_flags.add(a[2:])
1072
 
        elif a.startswith('-O'):
1073
 
            override_config.append(a[2:])
1074
1086
        else:
1075
1087
            argv_copy.append(a)
1076
1088
        i += 1
1077
1089
 
1078
 
    bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1079
 
 
1080
1090
    debug.set_debug_flags_from_config()
1081
1091
 
1082
1092
    if not opt_no_plugins:
1102
1112
 
1103
1113
    cmd = argv.pop(0)
1104
1114
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1105
 
    if opt_no_l10n:
1106
 
        cmd.l10n = False
1107
1115
    run = cmd_obj.run_argv_aliases
1108
1116
    run_argv = [argv, alias_argv]
1109
1117
 
1134
1142
        if 'memory' in debug.debug_flags:
1135
1143
            trace.debug_memory('Process status after command:', short=False)
1136
1144
        option._verbosity_level = saved_verbosity_level
1137
 
        # Reset the overrides 
1138
 
        bzrlib.global_state.cmdline_overrides._reset()
1139
1145
 
1140
1146
 
1141
1147
def display_command(func):
1170
1176
        "bzr plugin commands")
1171
1177
    Command.hooks.install_named_hook("get_command", _get_external_command,
1172
1178
        "bzr external command lookup")
1173
 
    Command.hooks.install_named_hook("get_missing_command",
1174
 
                                     _try_plugin_provider,
1175
 
                                     "bzr plugin-provider-db check")
 
1179
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
 
1180
        "bzr plugin-provider-db check")
1176
1181
 
1177
1182
 
1178
1183
 
1269
1274
 
1270
1275
 
1271
1276
class Provider(object):
1272
 
    """Generic class to be overriden by plugins"""
 
1277
    '''Generic class to be overriden by plugins'''
1273
1278
 
1274
1279
    def plugin_for_command(self, cmd_name):
1275
 
        """Takes a command and returns the information for that plugin
 
1280
        '''Takes a command and returns the information for that plugin
1276
1281
 
1277
1282
        :return: A dictionary with all the available information
1278
 
            for the requested plugin
1279
 
        """
 
1283
        for the requested plugin
 
1284
        '''
1280
1285
        raise NotImplementedError
1281
1286
 
1282
1287
 
1283
1288
class ProvidersRegistry(registry.Registry):
1284
 
    """This registry exists to allow other providers to exist"""
 
1289
    '''This registry exists to allow other providers to exist'''
1285
1290
 
1286
1291
    def __iter__(self):
1287
1292
        for key, provider in self.iteritems():