/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

merge trunk

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