← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin von Gagern
  • Date: 2010-04-22 06:25:26 UTC
  • mfrom: (0.27.39 trunk)
  • mto: This revision was merged to the branch mainline in revision 5240.
  • Revision ID: martin.vgagern@gmx.net-20100422062526-4lyy2yoor932u80w
Join bzr-bash-completion plugin into core bzr tree.

Show diffs side-by-side

added added

removed removed

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