← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: John Arbash Meinel
  • Date: 2011-04-20 15:06:17 UTC
  • mto: This revision was merged to the branch mainline in revision 5836.
  • Revision ID: john@arbash-meinel.com-20110420150617-i41caxgemg32tq1r
Start adding tests that _worth_saving_limit works as expected.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# TODO: Define arguments by objects, rather than just using names.
20
19
# Those objects can specify the expected type of the argument, which
33
32
 
34
33
import bzrlib
35
34
from bzrlib import (
36
 
    config,
37
35
    cleanup,
38
36
    cmdline,
39
37
    debug,
40
38
    errors,
41
 
    i18n,
42
39
    option,
43
40
    osutils,
44
41
    trace,
47
44
""")
48
45
 
49
46
from bzrlib.hooks import Hooks
50
 
from bzrlib.i18n import gettext
51
47
# Compatibility - Option used to be in commands.
52
48
from bzrlib.option import Option
53
49
from bzrlib.plugin import disable_plugins, load_plugins
54
50
from bzrlib import registry
 
51
from bzrlib.symbol_versioning import (
 
52
    deprecated_function,
 
53
    deprecated_in,
 
54
    deprecated_method,
 
55
    )
55
56
 
56
57
 
57
58
class CommandInfo(object):
161
162
    return cmd[4:].replace('_','-')
162
163
 
163
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
 
164
175
def _register_builtin_commands():
165
176
    if builtin_command_registry.keys():
166
177
        # only load once
226
237
    try:
227
238
        return _get_cmd_object(cmd_name, plugins_override)
228
239
    except KeyError:
229
 
        raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
 
240
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
230
241
 
231
242
 
232
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
346
357
    summary, then a complete description of the command.  A grammar
347
358
    description will be inserted.
348
359
 
349
 
    :cvar aliases: Other accepted names for this command.
350
 
 
351
 
    :cvar takes_args: List of argument forms, marked with whether they are
352
 
        optional, repeated, etc.  Examples::
353
 
 
354
 
            ['to_location', 'from_branch?', 'file*']
355
 
 
356
 
        * 'to_location' is required
357
 
        * 'from_branch' is optional
358
 
        * 'file' can be specified 0 or more times
359
 
 
360
 
    :cvar takes_options: List of options that may be given for this command.
361
 
        These can be either strings, referring to globally-defined options, or
362
 
        option objects.  Retrieve through options().
363
 
 
364
 
    :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
365
382
        for commands intended for expert users.
366
383
 
367
 
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
 
        been setup to properly handle encoding of unicode strings.
369
 
        encoding_type determines what will happen when characters cannot be
370
 
        encoded:
371
 
 
372
 
        * strict - abort if we cannot decode
373
 
        * replace - put in a bogus character (typically '?')
374
 
        * exact - do not encode sys.stdout
375
 
 
376
 
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
 
        therefore LF line-endings are converted to CRLF.  When a command uses
378
 
        encoding_type = 'exact', then sys.stdout is forced to be a binary
379
 
        stream, and line-endings will not mangled.
380
 
 
381
 
    :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:
382
400
        A string indicating the real name under which this command was
383
 
        invoked, before expansion of aliases.
 
401
        invoked, before expansion of aliases. 
384
402
        (This may be None if the command was constructed and run in-process.)
385
403
 
386
404
    :cvar hooks: An instance of CommandHooks.
387
405
 
388
 
    :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.
389
407
        This is set by assigning explicitly to __doc__ so that -OO can
390
408
        be used::
391
409
 
392
 
            class Foo(Command):
393
 
                __doc__ = "My help goes here"
 
410
        class Foo(Command):
 
411
            __doc__ = "My help goes here"
394
412
    """
395
413
    aliases = []
396
414
    takes_args = []
397
415
    takes_options = []
398
416
    encoding_type = 'strict'
399
417
    invoked_as = None
400
 
    l10n = True
401
418
 
402
419
    hidden = False
403
420
 
429
446
        """
430
447
        self._operation.cleanup_now()
431
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
 
432
462
    def _usage(self):
433
463
        """Return single-line grammar for this command.
434
464
 
462
492
            usage help (e.g. Purpose, Usage, Options) with a
463
493
            message explaining how to obtain full help.
464
494
        """
465
 
        if self.l10n:
466
 
            i18n.install()  # Install i18n only for get_help_text for now.
467
495
        doc = self.help()
468
 
        if doc:
469
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
470
 
            # be shown after "Description" section and we don't want to
471
 
            # translate the usage string.
472
 
            # Though, bzr export-pot don't exports :Usage: section and it must
473
 
            # not be translated.
474
 
            doc = self.gettext(doc)
475
 
        else:
476
 
            doc = gettext("No help for this command.")
 
496
        if not doc:
 
497
            doc = "No help for this command."
477
498
 
478
499
        # Extract the summary (purpose) and sections out from the text
479
500
        purpose,sections,order = self._get_help_parts(doc)
486
507
 
487
508
        # The header is the purpose and usage
488
509
        result = ""
489
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
510
        result += ':Purpose: %s\n' % purpose
490
511
        if usage.find('\n') >= 0:
491
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
512
            result += ':Usage:\n%s\n' % usage
492
513
        else:
493
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
514
            result += ':Usage:   %s\n' % usage
494
515
        result += '\n'
495
516
 
496
517
        # Add the options
498
519
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
499
520
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
500
521
        # 20090319
501
 
        parser = option.get_optparser(self.options())
502
 
        options = parser.format_option_help()
503
 
        # FIXME: According to the spec, ReST option lists actually don't
504
 
        # support options like --1.14 so that causes syntax errors (in Sphinx
505
 
        # at least).  As that pattern always appears in the commands that
506
 
        # break, we trap on that and then format that block of 'format' options
507
 
        # as a literal block. We use the most recent format still listed so we
508
 
        # don't have to do that too often -- vila 20110514
509
 
        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:
510
529
            options = options.replace(' format:\n', ' format::\n\n', 1)
511
530
        if options.startswith('Options:'):
512
 
            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:'):]
513
535
        else:
514
536
            result += options
515
537
        result += '\n'
520
542
            if sections.has_key(None):
521
543
                text = sections.pop(None)
522
544
                text = '\n  '.join(text.splitlines())
523
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
545
                result += ':%s:\n  %s\n\n' % ('Description',text)
524
546
 
525
547
            # Add the custom sections (e.g. Examples). Note that there's no need
526
548
            # to indent these as they must be indented already in the source.
527
549
            if sections:
528
550
                for label in order:
529
 
                    if label in sections:
530
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
551
                    if sections.has_key(label):
 
552
                        result += ':%s:\n%s\n' % (label,sections[label])
531
553
                result += '\n'
532
554
        else:
533
 
            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"
534
556
                % self.name())
535
557
 
536
558
        # Add the aliases, source (plug-in) and see also links, if any
537
559
        if self.aliases:
538
 
            result += gettext(':Aliases:  ')
 
560
            result += ':Aliases:  '
539
561
            result += ', '.join(self.aliases) + '\n'
540
562
        plugin_name = self.plugin_name()
541
563
        if plugin_name is not None:
542
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
564
            result += ':From:     plugin "%s"\n' % plugin_name
543
565
        see_also = self.get_see_also(additional_see_also)
544
566
        if see_also:
545
567
            if not plain and see_also_as_links:
551
573
                        see_also_links.append(item)
552
574
                    else:
553
575
                        # Use a Sphinx link for this entry
554
 
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
555
 
                                                                    item, item)
 
576
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
556
577
                        see_also_links.append(link_text)
557
578
                see_also = see_also_links
558
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
579
            result += ':See also: '
 
580
            result += ', '.join(see_also) + '\n'
559
581
 
560
582
        # If this will be rendered as plain text, convert it
561
583
        if plain:
642
664
    def run_argv_aliases(self, argv, alias_argv=None):
643
665
        """Parse the command line and run with extra aliases in alias_argv."""
644
666
        args, opts = parse_args(self, argv, alias_argv)
645
 
        self._setup_outf()
646
667
 
647
668
        # Process the standard options
648
669
        if 'help' in opts:  # e.g. bzr add --help
649
 
            self.outf.write(self.get_help_text())
 
670
            sys.stdout.write(self.get_help_text())
650
671
            return 0
651
672
        if 'usage' in opts:  # e.g. bzr add --usage
652
 
            self.outf.write(self.get_help_text(verbose=False))
 
673
            sys.stdout.write(self.get_help_text(verbose=False))
653
674
            return 0
654
675
        trace.set_verbosity_level(option._verbosity_level)
655
676
        if 'verbose' in self.supported_std_options:
660
681
            opts['quiet'] = trace.is_quiet()
661
682
        elif opts.has_key('quiet'):
662
683
            del opts['quiet']
 
684
 
663
685
        # mix arguments and options into one dictionary
664
686
        cmdargs = _match_argform(self.name(), self.takes_args, args)
665
687
        cmdopts = {}
669
691
        all_cmd_args = cmdargs.copy()
670
692
        all_cmd_args.update(cmdopts)
671
693
 
 
694
        self._setup_outf()
 
695
 
672
696
        try:
673
697
            return self.run(**all_cmd_args)
674
698
        finally:
690
714
        """
691
715
        class_run = self.run
692
716
        def run(*args, **kwargs):
693
 
            for hook in Command.hooks['pre_command']:
694
 
                hook(self)
695
717
            self._operation = cleanup.OperationWithCleanups(class_run)
696
718
            try:
697
719
                return self._operation.run_simple(*args, **kwargs)
698
720
            finally:
699
721
                del self._operation
700
 
                for hook in Command.hooks['post_command']:
701
 
                    hook(self)
702
722
        self.run = run
703
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
 
704
729
    def run(self):
705
730
        """Actually run the command.
706
731
 
732
757
            return None
733
758
        return getdoc(self)
734
759
 
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
760
    def name(self):
744
761
        """Return the canonical name for this command.
745
762
 
792
809
            " is safe to mutate - e.g. to remove a command. "
793
810
            "list_commands should return the updated set of command names.",
794
811
            (1, 17))
795
 
        self.add_hook('pre_command',
796
 
            "Called prior to executing a command. Called with the command "
797
 
            "object.", (2, 6))
798
 
        self.add_hook('post_command',
799
 
            "Called after executing a command. Called with the command "
800
 
            "object.", (2, 6))
801
812
 
802
813
Command.hooks = CommandHooks()
803
814
 
822
833
    try:
823
834
        options, args = parser.parse_args(args)
824
835
    except UnicodeEncodeError,e:
825
 
        raise errors.BzrCommandError(
826
 
            gettext('Only ASCII permitted in option names'))
 
836
        raise errors.BzrCommandError('Only ASCII permitted in option names')
827
837
 
828
838
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
839
                 v is not option.OptionParser.DEFAULT_VALUE])
847
857
                argdict[argname + '_list'] = None
848
858
        elif ap[-1] == '+':
849
859
            if not args:
850
 
                raise errors.BzrCommandError(gettext(
851
 
                      "command {0!r} needs one or more {1}").format(
852
 
                      cmd, argname.upper()))
 
860
                raise errors.BzrCommandError("command %r needs one or more %s"
 
861
                                             % (cmd, argname.upper()))
853
862
            else:
854
863
                argdict[argname + '_list'] = args[:]
855
864
                args = []
856
865
        elif ap[-1] == '$': # all but one
857
866
            if len(args) < 2:
858
 
                raise errors.BzrCommandError(
859
 
                      gettext("command {0!r} needs one or more {1}").format(
860
 
                                             cmd, argname.upper()))
 
867
                raise errors.BzrCommandError("command %r needs one or more %s"
 
868
                                             % (cmd, argname.upper()))
861
869
            argdict[argname + '_list'] = args[:-1]
862
870
            args[:-1] = []
863
871
        else:
864
872
            # just a plain arg
865
873
            argname = ap
866
874
            if not args:
867
 
                raise errors.BzrCommandError(
868
 
                     gettext("command {0!r} requires argument {1}").format(
869
 
                               cmd, argname.upper()))
 
875
                raise errors.BzrCommandError("command %r requires argument %s"
 
876
                               % (cmd, argname.upper()))
870
877
            else:
871
878
                argdict[argname] = args.pop(0)
872
879
 
873
880
    if args:
874
 
        raise errors.BzrCommandError( gettext(
875
 
                              "extra argument to command {0}: {1}").format(
876
 
                                       cmd, args[0]) )
 
881
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
882
                                     % (cmd, args[0]))
877
883
 
878
884
    return argdict
879
885
 
935
941
        exitcode = trace.report_exception(exc_info, sys.stderr)
936
942
        if os.environ.get('BZR_PDB'):
937
943
            print '**** entering debugger'
 
944
            tb = exc_info[2]
938
945
            import pdb
939
 
            pdb.post_mortem(exc_info[2])
 
946
            if sys.version_info[:2] < (2, 6):
 
947
                # XXX: we want to do
 
948
                #    pdb.post_mortem(tb)
 
949
                # but because pdb.post_mortem gives bad results for tracebacks
 
950
                # from inside generators, we do it manually.
 
951
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
 
952
 
 
953
                # Setup pdb on the traceback
 
954
                p = pdb.Pdb()
 
955
                p.reset()
 
956
                p.setup(tb.tb_frame, tb)
 
957
                # Point the debugger at the deepest frame of the stack
 
958
                p.curindex = len(p.stack) - 1
 
959
                p.curframe = p.stack[p.curindex][0]
 
960
                # Start the pdb prompt.
 
961
                p.print_stack_entry(p.stack[p.curindex])
 
962
                p.execRcLines()
 
963
                p.cmdloop()
 
964
            else:
 
965
                pdb.post_mortem(tb)
940
966
        return exitcode
941
967
 
942
968
 
943
969
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
944
970
    from bzrlib.lsprof import profile
945
 
    ret, stats = profile(exception_to_return_code, the_callable,
946
 
                         *args, **kwargs)
 
971
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
947
972
    stats.sort()
948
973
    if filename is None:
949
974
        stats.pprint()
950
975
    else:
951
976
        stats.save(filename)
952
 
        trace.note(gettext('Profile data written to "%s".'), filename)
 
977
        trace.note('Profile data written to "%s".', filename)
953
978
    return ret
954
979
 
955
980
 
 
981
@deprecated_function(deprecated_in((2, 2, 0)))
 
982
def shlex_split_unicode(unsplit):
 
983
    return cmdline.split(unsplit)
 
984
 
 
985
 
956
986
def get_alias(cmd, config=None):
957
987
    """Return an expanded alias, or None if no alias exists.
958
988
 
1017
1047
    argv = _specified_or_unicode_argv(argv)
1018
1048
    trace.mutter("bzr arguments: %r", argv)
1019
1049
 
1020
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1021
 
            opt_no_l10n = opt_no_aliases = False
 
1050
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1051
                opt_no_aliases = False
1022
1052
    opt_lsprof_file = opt_coverage_dir = None
1023
1053
 
1024
1054
    # --no-plugins is handled specially at a very early stage. We need
1027
1057
 
1028
1058
    argv_copy = []
1029
1059
    i = 0
1030
 
    override_config = []
1031
1060
    while i < len(argv):
1032
1061
        a = argv[i]
1033
1062
        if a == '--profile':
1042
1071
            opt_no_plugins = True
1043
1072
        elif a == '--no-aliases':
1044
1073
            opt_no_aliases = True
1045
 
        elif a == '--no-l10n':
1046
 
            opt_no_l10n = True
1047
1074
        elif a == '--builtin':
1048
1075
            opt_builtin = True
1049
1076
        elif a == '--concurrency':
1056
1083
            pass # already handled in startup script Bug #588277
1057
1084
        elif a.startswith('-D'):
1058
1085
            debug.debug_flags.add(a[2:])
1059
 
        elif a.startswith('-O'):
1060
 
            override_config.append(a[2:])
1061
1086
        else:
1062
1087
            argv_copy.append(a)
1063
1088
        i += 1
1064
1089
 
1065
 
    if bzrlib.global_state is None:
1066
 
        # FIXME: Workaround for users that imported bzrlib but didn't call
1067
 
        # bzrlib.initialize -- vila 2012-01-19
1068
 
        cmdline_overrides = config.CommandLineStore()
1069
 
    else:
1070
 
        cmdline_overrides = bzrlib.global_state.cmdline_overrides
1071
 
    cmdline_overrides._from_cmdline(override_config)
1072
 
 
1073
1090
    debug.set_debug_flags_from_config()
1074
1091
 
1075
1092
    if not opt_no_plugins:
1095
1112
 
1096
1113
    cmd = argv.pop(0)
1097
1114
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1098
 
    if opt_no_l10n:
1099
 
        cmd.l10n = False
1100
1115
    run = cmd_obj.run_argv_aliases
1101
1116
    run_argv = [argv, alias_argv]
1102
1117
 
1127
1142
        if 'memory' in debug.debug_flags:
1128
1143
            trace.debug_memory('Process status after command:', short=False)
1129
1144
        option._verbosity_level = saved_verbosity_level
1130
 
        # Reset the overrides 
1131
 
        cmdline_overrides._reset()
1132
1145
 
1133
1146
 
1134
1147
def display_command(func):
1163
1176
        "bzr plugin commands")
1164
1177
    Command.hooks.install_named_hook("get_command", _get_external_command,
1165
1178
        "bzr external command lookup")
1166
 
    Command.hooks.install_named_hook("get_missing_command",
1167
 
                                     _try_plugin_provider,
1168
 
                                     "bzr plugin-provider-db check")
 
1179
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
 
1180
        "bzr plugin-provider-db check")
1169
1181
 
1170
1182
 
1171
1183
 
1262
1274
 
1263
1275
 
1264
1276
class Provider(object):
1265
 
    """Generic class to be overriden by plugins"""
 
1277
    '''Generic class to be overriden by plugins'''
1266
1278
 
1267
1279
    def plugin_for_command(self, cmd_name):
1268
 
        """Takes a command and returns the information for that plugin
 
1280
        '''Takes a command and returns the information for that plugin
1269
1281
 
1270
1282
        :return: A dictionary with all the available information
1271
 
            for the requested plugin
1272
 
        """
 
1283
        for the requested plugin
 
1284
        '''
1273
1285
        raise NotImplementedError
1274
1286
 
1275
1287
 
1276
1288
class ProvidersRegistry(registry.Registry):
1277
 
    """This registry exists to allow other providers to exist"""
 
1289
    '''This registry exists to allow other providers to exist'''
1278
1290
 
1279
1291
    def __iter__(self):
1280
1292
        for key, provider in self.iteritems():