← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Benji York
  • Date: 2011-08-19 18:02:37 UTC
  • mto: This revision was merged to the branch mainline in revision 6101.
  • Revision ID: benji@benjiyork.com-20110819180237-2n0sdcfs5v7bxksi
fix bug 702914

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
165
164
    return cmd[4:].replace('_','-')
166
165
 
167
166
 
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
 
 
178
167
def _register_builtin_commands():
179
168
    if builtin_command_registry.keys():
180
169
        # only load once
222
211
    Use of all_command_names() is encouraged rather than builtin_command_names
223
212
    and/or plugin_command_names.
224
213
    """
 
214
    _register_builtin_commands()
225
215
    return builtin_command_registry.keys()
226
216
 
227
217
 
275
265
    # Allow plugins to extend commands
276
266
    for hook in Command.hooks['extend_command']:
277
267
        hook(cmd)
 
268
    if getattr(cmd, 'invoked_as', None) is None:
 
269
        cmd.invoked_as = cmd_name
278
270
    return cmd
279
271
 
280
272
 
357
349
    summary, then a complete description of the command.  A grammar
358
350
    description will be inserted.
359
351
 
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
 
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
382
368
        for commands intended for expert users.
383
369
 
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.
 
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.)
398
388
 
399
389
    :cvar hooks: An instance of CommandHooks.
 
390
 
 
391
    :cvar __doc__: The help shown by 'bzr help command' for this command.
 
392
        This is set by assigning explicitly to __doc__ so that -OO can
 
393
        be used::
 
394
 
 
395
            class Foo(Command):
 
396
                __doc__ = "My help goes here"
400
397
    """
401
398
    aliases = []
402
399
    takes_args = []
403
400
    takes_options = []
404
401
    encoding_type = 'strict'
 
402
    invoked_as = None
 
403
    l10n = True
405
404
 
406
405
    hidden = False
407
406
 
408
407
    def __init__(self):
409
408
        """Construct an instance of this command."""
410
 
        if self.__doc__ == Command.__doc__:
411
 
            warn("No help message set for %r" % self)
412
409
        # List of standard options directly supported
413
410
        self.supported_std_options = []
414
411
        self._setup_run()
435
432
        """
436
433
        self._operation.cleanup_now()
437
434
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
 
    def _maybe_expand_globs(self, file_list):
440
 
        """Glob expand file_list if the platform does not do that itself.
441
 
 
442
 
        Not used anymore, now that the bzr command-line parser globs on
443
 
        Windows.
444
 
 
445
 
        :return: A possibly empty list of unicode paths.
446
 
 
447
 
        Introduced in bzrlib 0.18.
448
 
        """
449
 
        return file_list
450
 
 
451
435
    def _usage(self):
452
436
        """Return single-line grammar for this command.
453
437
 
481
465
            usage help (e.g. Purpose, Usage, Options) with a
482
466
            message explaining how to obtain full help.
483
467
        """
 
468
        if self.l10n and not i18n.installed():
 
469
            i18n.install()  # Install i18n only for get_help_text for now.
484
470
        doc = self.help()
485
 
        if doc is None:
486
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
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.")
487
480
 
488
481
        # Extract the summary (purpose) and sections out from the text
489
482
        purpose,sections,order = self._get_help_parts(doc)
496
489
 
497
490
        # The header is the purpose and usage
498
491
        result = ""
499
 
        result += ':Purpose: %s\n' % purpose
 
492
        result += gettext(':Purpose: %s\n') % (purpose,)
500
493
        if usage.find('\n') >= 0:
501
 
            result += ':Usage:\n%s\n' % usage
 
494
            result += gettext(':Usage:\n%s\n') % (usage,)
502
495
        else:
503
 
            result += ':Usage:   %s\n' % usage
 
496
            result += gettext(':Usage:   %s\n') % (usage,)
504
497
        result += '\n'
505
498
 
506
499
        # Add the options
508
501
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
509
502
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
510
503
        # 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:
 
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:
518
513
            options = options.replace(' format:\n', ' format::\n\n', 1)
519
514
        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:'):]
 
515
            result += gettext(':Options:%s') % (options[len('options:'):],)
524
516
        else:
525
517
            result += options
526
518
        result += '\n'
531
523
            if sections.has_key(None):
532
524
                text = sections.pop(None)
533
525
                text = '\n  '.join(text.splitlines())
534
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
526
                result += gettext(':Description:\n  %s\n\n') % (text,)
535
527
 
536
528
            # Add the custom sections (e.g. Examples). Note that there's no need
537
529
            # to indent these as they must be indented already in the source.
538
530
            if sections:
539
531
                for label in order:
540
 
                    if sections.has_key(label):
541
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
532
                    if label in sections:
 
533
                        result += ':%s:\n%s\n' % (label, sections[label])
542
534
                result += '\n'
543
535
        else:
544
 
            result += ("See bzr help %s for more details and examples.\n\n"
 
536
            result += (gettext("See bzr help %s for more details and examples.\n\n")
545
537
                % self.name())
546
538
 
547
539
        # Add the aliases, source (plug-in) and see also links, if any
548
540
        if self.aliases:
549
 
            result += ':Aliases:  '
 
541
            result += gettext(':Aliases:  ')
550
542
            result += ', '.join(self.aliases) + '\n'
551
543
        plugin_name = self.plugin_name()
552
544
        if plugin_name is not None:
553
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
545
            result += gettext(':From:     plugin "%s"\n') % plugin_name
554
546
        see_also = self.get_see_also(additional_see_also)
555
547
        if see_also:
556
548
            if not plain and see_also_as_links:
562
554
                        see_also_links.append(item)
563
555
                    else:
564
556
                        # Use a Sphinx link for this entry
565
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
557
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
566
558
                        see_also_links.append(link_text)
567
559
                see_also = see_also_links
568
 
            result += ':See also: '
569
 
            result += ', '.join(see_also) + '\n'
 
560
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
570
561
 
571
562
        # If this will be rendered as plain text, convert it
572
563
        if plain:
653
644
    def run_argv_aliases(self, argv, alias_argv=None):
654
645
        """Parse the command line and run with extra aliases in alias_argv."""
655
646
        args, opts = parse_args(self, argv, alias_argv)
 
647
        self._setup_outf()
656
648
 
657
649
        # Process the standard options
658
650
        if 'help' in opts:  # e.g. bzr add --help
659
 
            sys.stdout.write(self.get_help_text())
 
651
            self.outf.write(self.get_help_text())
660
652
            return 0
661
653
        if 'usage' in opts:  # e.g. bzr add --usage
662
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
654
            self.outf.write(self.get_help_text(verbose=False))
663
655
            return 0
664
656
        trace.set_verbosity_level(option._verbosity_level)
665
657
        if 'verbose' in self.supported_std_options:
680
672
        all_cmd_args = cmdargs.copy()
681
673
        all_cmd_args.update(cmdopts)
682
674
 
683
 
        self._setup_outf()
684
 
 
685
 
        return self.run(**all_cmd_args)
 
675
        try:
 
676
            return self.run(**all_cmd_args)
 
677
        finally:
 
678
            # reset it, so that other commands run in the same process won't
 
679
            # inherit state. Before we reset it, log any activity, so that it
 
680
            # gets properly tracked.
 
681
            ui.ui_factory.log_transport_activity(
 
682
                display=('bytes' in debug.debug_flags))
 
683
            trace.set_verbosity_level(0)
686
684
 
687
685
    def _setup_run(self):
688
686
        """Wrap the defined run method on self with a cleanup.
702
700
                del self._operation
703
701
        self.run = run
704
702
 
705
 
    @deprecated_method(deprecated_in((2, 2, 0)))
706
 
    def run_direct(self, *args, **kwargs):
707
 
        """Deprecated thunk from bzrlib 2.1."""
708
 
        return self.run(*args, **kwargs)
709
 
 
710
703
    def run(self):
711
704
        """Actually run the command.
712
705
 
738
731
            return None
739
732
        return getdoc(self)
740
733
 
 
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
 
741
742
    def name(self):
 
743
        """Return the canonical name for this command.
 
744
 
 
745
        The name under which it was actually invoked is available in invoked_as.
 
746
        """
742
747
        return _unsquish_command_name(self.__class__.__name__)
743
748
 
744
749
    def plugin_name(self):
762
767
        These are all empty initially, because by default nothing should get
763
768
        notified.
764
769
        """
765
 
        Hooks.__init__(self)
766
 
        self.create_hook(HookPoint('extend_command',
 
770
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
 
771
        self.add_hook('extend_command',
767
772
            "Called after creating a command object to allow modifications "
768
773
            "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',
 
774
            "new bzrlib.commands.Command object.", (1, 13))
 
775
        self.add_hook('get_command',
771
776
            "Called when creating a single command. Called with "
772
777
            "(cmd_or_None, command_name). get_command should either return "
773
778
            "the cmd_or_None parameter, or a replacement Command object that "
774
779
            "should be used for the command. Note that the Command.hooks "
775
780
            "hooks are core infrastructure. Many users will prefer to use "
776
781
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
777
 
            (1, 17), None))
778
 
        self.create_hook(HookPoint('get_missing_command',
 
782
            (1, 17))
 
783
        self.add_hook('get_missing_command',
779
784
            "Called when creating a single command if no command could be "
780
785
            "found. Called with (command_name). get_missing_command should "
781
786
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
 
787
            "command.", (1, 17))
 
788
        self.add_hook('list_commands',
784
789
            "Called when enumerating commands. Called with a set of "
785
790
            "cmd_name strings for all the commands found so far. This set "
786
791
            " is safe to mutate - e.g. to remove a command. "
787
792
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
 
793
            (1, 17))
789
794
 
790
795
Command.hooks = CommandHooks()
791
796
 
805
810
    else:
806
811
        args = argv
807
812
 
808
 
    options, args = parser.parse_args(args)
 
813
    # for python 2.5 and later, optparse raises this exception if a non-ascii
 
814
    # option name is given.  See http://bugs.python.org/issue2931
 
815
    try:
 
816
        options, args = parser.parse_args(args)
 
817
    except UnicodeEncodeError,e:
 
818
        raise errors.BzrCommandError('Only ASCII permitted in option names')
 
819
 
809
820
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
821
                 v is not option.OptionParser.DEFAULT_VALUE])
811
822
    return args, opts
939
950
 
940
951
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
952
    from bzrlib.lsprof import profile
942
 
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
 
953
    ret, stats = profile(exception_to_return_code, the_callable,
 
954
                         *args, **kwargs)
943
955
    stats.sort()
944
956
    if filename is None:
945
957
        stats.pprint()
949
961
    return ret
950
962
 
951
963
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
 
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
955
 
 
956
 
 
957
964
def get_alias(cmd, config=None):
958
965
    """Return an expanded alias, or None if no alias exists.
959
966
 
1015
1022
        Specify the number of processes that can be run concurrently (selftest).
1016
1023
    """
1017
1024
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
 
    argv = list(argv)
 
1025
    argv = _specified_or_unicode_argv(argv)
1019
1026
    trace.mutter("bzr arguments: %r", argv)
1020
1027
 
1021
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1022
 
                opt_no_aliases = False
 
1028
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1029
            opt_no_l10n = opt_no_aliases = False
1023
1030
    opt_lsprof_file = opt_coverage_dir = None
1024
1031
 
1025
1032
    # --no-plugins is handled specially at a very early stage. We need
1042
1049
            opt_no_plugins = True
1043
1050
        elif a == '--no-aliases':
1044
1051
            opt_no_aliases = True
 
1052
        elif a == '--no-l10n':
 
1053
            opt_no_l10n = True
1045
1054
        elif a == '--builtin':
1046
1055
            opt_builtin = True
1047
1056
        elif a == '--concurrency':
1050
1059
        elif a == '--coverage':
1051
1060
            opt_coverage_dir = argv[i + 1]
1052
1061
            i += 1
 
1062
        elif a == '--profile-imports':
 
1063
            pass # already handled in startup script Bug #588277
1053
1064
        elif a.startswith('-D'):
1054
1065
            debug.debug_flags.add(a[2:])
1055
1066
        else:
1077
1088
    if not opt_no_aliases:
1078
1089
        alias_argv = get_alias(argv[0])
1079
1090
        if alias_argv:
1080
 
            user_encoding = osutils.get_user_encoding()
1081
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1091
            argv[0] = alias_argv.pop(0)
1083
1092
 
1084
1093
    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
1094
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1095
    if opt_no_l10n:
 
1096
        cmd.l10n = False
1090
1097
    run = cmd_obj.run_argv_aliases
1091
1098
    run_argv = [argv, alias_argv]
1092
1099
 
1165
1172
        new_argv = []
1166
1173
        try:
1167
1174
            # ensure all arguments are unicode strings
1168
 
            for a in argv[1:]:
 
1175
            for a in argv:
1169
1176
                if isinstance(a, unicode):
1170
1177
                    new_argv.append(a)
1171
1178
                else:
1187
1194
 
1188
1195
    :return: exit code of bzr command.
1189
1196
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
 
1197
    if argv is not None:
 
1198
        argv = argv[1:]
1191
1199
    _register_builtin_commands()
1192
1200
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
1201
    trace.mutter("return code %d", ret)
1196
1202
    return ret
1197
1203
 
1250
1256
 
1251
1257
 
1252
1258
class Provider(object):
1253
 
    '''Generic class to be overriden by plugins'''
 
1259
    """Generic class to be overriden by plugins"""
1254
1260
 
1255
1261
    def plugin_for_command(self, cmd_name):
1256
 
        '''Takes a command and returns the information for that plugin
 
1262
        """Takes a command and returns the information for that plugin
1257
1263
 
1258
1264
        :return: A dictionary with all the available information
1259
 
        for the requested plugin
1260
 
        '''
 
1265
            for the requested plugin
 
1266
        """
1261
1267
        raise NotImplementedError
1262
1268
 
1263
1269
 
1264
1270
class ProvidersRegistry(registry.Registry):
1265
 
    '''This registry exists to allow other providers to exist'''
 
1271
    """This registry exists to allow other providers to exist"""
1266
1272
 
1267
1273
    def __iter__(self):
1268
1274
        for key, provider in self.iteritems():