← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

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
 
        self._setup_run()
 
414
        self._operation = cleanup.OperationWithCleanups(self.run)
422
415
 
423
416
    def add_cleanup(self, cleanup_func, *args, **kwargs):
424
417
        """Register a function to call after self.run returns or raises.
436
429
 
437
430
        This is useful for releasing expensive or contentious resources (such
438
431
        as write locks) before doing further work that does not require those
439
 
        resources (such as writing results to self.outf). Note though, that
440
 
        as it releases all resources, this may release locks that the command
441
 
        wants to hold, so use should be done with care.
 
432
        resources (such as writing results to self.outf).
442
433
        """
443
434
        self._operation.cleanup_now()
444
435
 
488
479
            usage help (e.g. Purpose, Usage, Options) with a
489
480
            message explaining how to obtain full help.
490
481
        """
491
 
        if self.l10n and not i18n.installed():
492
 
            i18n.install()  # Install i18n only for get_help_text for now.
493
482
        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.")
 
483
        if doc is None:
 
484
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
503
485
 
504
486
        # Extract the summary (purpose) and sections out from the text
505
487
        purpose,sections,order = self._get_help_parts(doc)
512
494
 
513
495
        # The header is the purpose and usage
514
496
        result = ""
515
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
497
        result += ':Purpose: %s\n' % purpose
516
498
        if usage.find('\n') >= 0:
517
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
499
            result += ':Usage:\n%s\n' % usage
518
500
        else:
519
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
501
            result += ':Usage:   %s\n' % usage
520
502
        result += '\n'
521
503
 
522
504
        # Add the options
524
506
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
525
507
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
526
508
        # 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:
 
509
        options = option.get_optparser(self.options()).format_option_help()
 
510
        # XXX: According to the spec, ReST option lists actually don't support 
 
511
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
512
        # As that pattern always appears in the commands that break, we trap
 
513
        # on that and then format that block of 'format' options as a literal
 
514
        # block.
 
515
        if not plain and options.find('  --1.9  ') != -1:
536
516
            options = options.replace(' format:\n', ' format::\n\n', 1)
537
517
        if options.startswith('Options:'):
538
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
518
            result += ':' + options
 
519
        elif options.startswith('options:'):
 
520
            # Python 2.4 version of optparse
 
521
            result += ':Options:' + options[len('options:'):]
539
522
        else:
540
523
            result += options
541
524
        result += '\n'
546
529
            if sections.has_key(None):
547
530
                text = sections.pop(None)
548
531
                text = '\n  '.join(text.splitlines())
549
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
532
                result += ':%s:\n  %s\n\n' % ('Description',text)
550
533
 
551
534
            # Add the custom sections (e.g. Examples). Note that there's no need
552
535
            # to indent these as they must be indented already in the source.
553
536
            if sections:
554
537
                for label in order:
555
 
                    if label in sections:
556
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
538
                    if sections.has_key(label):
 
539
                        result += ':%s:\n%s\n' % (label,sections[label])
557
540
                result += '\n'
558
541
        else:
559
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
542
            result += ("See bzr help %s for more details and examples.\n\n"
560
543
                % self.name())
561
544
 
562
545
        # Add the aliases, source (plug-in) and see also links, if any
563
546
        if self.aliases:
564
 
            result += gettext(':Aliases:  ')
 
547
            result += ':Aliases:  '
565
548
            result += ', '.join(self.aliases) + '\n'
566
549
        plugin_name = self.plugin_name()
567
550
        if plugin_name is not None:
568
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
551
            result += ':From:     plugin "%s"\n' % plugin_name
569
552
        see_also = self.get_see_also(additional_see_also)
570
553
        if see_also:
571
554
            if not plain and see_also_as_links:
577
560
                        see_also_links.append(item)
578
561
                    else:
579
562
                        # Use a Sphinx link for this entry
580
 
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
 
563
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
581
564
                        see_also_links.append(link_text)
582
565
                see_also = see_also_links
583
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
566
            result += ':See also: '
 
567
            result += ', '.join(see_also) + '\n'
584
568
 
585
569
        # If this will be rendered as plain text, convert it
586
570
        if plain:
667
651
    def run_argv_aliases(self, argv, alias_argv=None):
668
652
        """Parse the command line and run with extra aliases in alias_argv."""
669
653
        args, opts = parse_args(self, argv, alias_argv)
670
 
        self._setup_outf()
671
654
 
672
655
        # Process the standard options
673
656
        if 'help' in opts:  # e.g. bzr add --help
674
 
            self.outf.write(self.get_help_text())
 
657
            sys.stdout.write(self.get_help_text())
675
658
            return 0
676
659
        if 'usage' in opts:  # e.g. bzr add --usage
677
 
            self.outf.write(self.get_help_text(verbose=False))
 
660
            sys.stdout.write(self.get_help_text(verbose=False))
678
661
            return 0
679
662
        trace.set_verbosity_level(option._verbosity_level)
680
663
        if 'verbose' in self.supported_std_options:
695
678
        all_cmd_args = cmdargs.copy()
696
679
        all_cmd_args.update(cmdopts)
697
680
 
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)
707
 
 
708
 
    def _setup_run(self):
709
 
        """Wrap the defined run method on self with a cleanup.
710
 
 
711
 
        This is called by __init__ to make the Command be able to be run
712
 
        by just calling run(), as it could be before cleanups were added.
713
 
 
714
 
        If a different form of cleanups are in use by your Command subclass,
715
 
        you can override this method.
716
 
        """
717
 
        class_run = self.run
718
 
        def run(*args, **kwargs):
719
 
            self._operation = cleanup.OperationWithCleanups(class_run)
720
 
            try:
721
 
                return self._operation.run_simple(*args, **kwargs)
722
 
            finally:
723
 
                del self._operation
724
 
        self.run = run
725
 
 
726
 
    @deprecated_method(deprecated_in((2, 2, 0)))
 
681
        self._setup_outf()
 
682
 
 
683
        return self.run_direct(**all_cmd_args)
 
684
 
727
685
    def run_direct(self, *args, **kwargs):
728
 
        """Deprecated thunk from bzrlib 2.1."""
729
 
        return self.run(*args, **kwargs)
 
686
        """Call run directly with objects (without parsing an argv list)."""
 
687
        return self._operation.run_simple(*args, **kwargs)
730
688
 
731
689
    def run(self):
732
690
        """Actually run the command.
737
695
        Return 0 or None if the command was successful, or a non-zero
738
696
        shell error code if not.  It's OK for this method to allow
739
697
        an exception to raise up.
740
 
 
741
 
        This method is automatically wrapped by Command.__init__ with a 
742
 
        cleanup operation, stored as self._operation. This can be used
743
 
        via self.add_cleanup to perform automatic cleanups at the end of
744
 
        run().
745
 
 
746
 
        The argument for run are assembled by introspection. So for instance,
747
 
        if your command takes an argument files, you would declare::
748
 
 
749
 
            def run(self, files=None):
750
 
                pass
751
698
        """
752
699
        raise NotImplementedError('no implementation of command %r'
753
700
                                  % self.name())
759
706
            return None
760
707
        return getdoc(self)
761
708
 
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
709
    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
710
        return _unsquish_command_name(self.__class__.__name__)
776
711
 
777
712
    def plugin_name(self):
795
730
        These are all empty initially, because by default nothing should get
796
731
        notified.
797
732
        """
798
 
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
799
 
        self.add_hook('extend_command',
 
733
        Hooks.__init__(self)
 
734
        self.create_hook(HookPoint('extend_command',
800
735
            "Called after creating a command object to allow modifications "
801
736
            "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',
 
737
            "new bzrlib.commands.Command object.", (1, 13), None))
 
738
        self.create_hook(HookPoint('get_command',
804
739
            "Called when creating a single command. Called with "
805
740
            "(cmd_or_None, command_name). get_command should either return "
806
741
            "the cmd_or_None parameter, or a replacement Command object that "
807
742
            "should be used for the command. Note that the Command.hooks "
808
743
            "hooks are core infrastructure. Many users will prefer to use "
809
744
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
810
 
            (1, 17))
811
 
        self.add_hook('get_missing_command',
 
745
            (1, 17), None))
 
746
        self.create_hook(HookPoint('get_missing_command',
812
747
            "Called when creating a single command if no command could be "
813
748
            "found. Called with (command_name). get_missing_command should "
814
749
            "either return None, or a Command object to be used for the "
815
 
            "command.", (1, 17))
816
 
        self.add_hook('list_commands',
 
750
            "command.", (1, 17), None))
 
751
        self.create_hook(HookPoint('list_commands',
817
752
            "Called when enumerating commands. Called with a set of "
818
753
            "cmd_name strings for all the commands found so far. This set "
819
754
            " is safe to mutate - e.g. to remove a command. "
820
755
            "list_commands should return the updated set of command names.",
821
 
            (1, 17))
 
756
            (1, 17), None))
822
757
 
823
758
Command.hooks = CommandHooks()
824
759
 
838
773
    else:
839
774
        args = argv
840
775
 
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
 
 
 
776
    options, args = parser.parse_args(args)
848
777
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
849
778
                 v is not option.OptionParser.DEFAULT_VALUE])
850
779
    return args, opts
1054
983
        Specify the number of processes that can be run concurrently (selftest).
1055
984
    """
1056
985
    trace.mutter("bazaar version: " + bzrlib.__version__)
1057
 
    argv = _specified_or_unicode_argv(argv)
 
986
    argv = list(argv)
1058
987
    trace.mutter("bzr arguments: %r", argv)
1059
988
 
1060
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1061
 
            opt_no_l10n = opt_no_aliases = False
 
989
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
990
                opt_no_aliases = False
1062
991
    opt_lsprof_file = opt_coverage_dir = None
1063
992
 
1064
993
    # --no-plugins is handled specially at a very early stage. We need
1081
1010
            opt_no_plugins = True
1082
1011
        elif a == '--no-aliases':
1083
1012
            opt_no_aliases = True
1084
 
        elif a == '--no-l10n':
1085
 
            opt_no_l10n = True
1086
1013
        elif a == '--builtin':
1087
1014
            opt_builtin = True
1088
1015
        elif a == '--concurrency':
1091
1018
        elif a == '--coverage':
1092
1019
            opt_coverage_dir = argv[i + 1]
1093
1020
            i += 1
1094
 
        elif a == '--profile-imports':
1095
 
            pass # already handled in startup script Bug #588277
1096
1021
        elif a.startswith('-D'):
1097
1022
            debug.debug_flags.add(a[2:])
1098
1023
        else:
1120
1045
    if not opt_no_aliases:
1121
1046
        alias_argv = get_alias(argv[0])
1122
1047
        if alias_argv:
 
1048
            user_encoding = osutils.get_user_encoding()
 
1049
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1123
1050
            argv[0] = alias_argv.pop(0)
1124
1051
 
1125
1052
    cmd = argv.pop(0)
 
1053
    # We want only 'ascii' command names, but the user may have typed
 
1054
    # in a Unicode name. In that case, they should just get a
 
1055
    # 'command not found' error later.
 
1056
 
1126
1057
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1127
 
    if opt_no_l10n:
1128
 
        cmd.l10n = False
1129
1058
    run = cmd_obj.run_argv_aliases
1130
1059
    run_argv = [argv, alias_argv]
1131
1060
 
1204
1133
        new_argv = []
1205
1134
        try:
1206
1135
            # ensure all arguments are unicode strings
1207
 
            for a in argv:
 
1136
            for a in argv[1:]:
1208
1137
                if isinstance(a, unicode):
1209
1138
                    new_argv.append(a)
1210
1139
                else:
1226
1155
 
1227
1156
    :return: exit code of bzr command.
1228
1157
    """
1229
 
    if argv is not None:
1230
 
        argv = argv[1:]
 
1158
    argv = _specified_or_unicode_argv(argv)
1231
1159
    _register_builtin_commands()
1232
1160
    ret = run_bzr_catch_errors(argv)
 
1161
    bzrlib.ui.ui_factory.log_transport_activity(
 
1162
        display=('bytes' in debug.debug_flags))
1233
1163
    trace.mutter("return code %d", ret)
1234
1164
    return ret
1235
1165
 
1288
1218
 
1289
1219
 
1290
1220
class Provider(object):
1291
 
    """Generic class to be overriden by plugins"""
 
1221
    '''Generic class to be overriden by plugins'''
1292
1222
 
1293
1223
    def plugin_for_command(self, cmd_name):
1294
 
        """Takes a command and returns the information for that plugin
 
1224
        '''Takes a command and returns the information for that plugin
1295
1225
 
1296
1226
        :return: A dictionary with all the available information
1297
 
            for the requested plugin
1298
 
        """
 
1227
        for the requested plugin
 
1228
        '''
1299
1229
        raise NotImplementedError
1300
1230
 
1301
1231
 
1302
1232
class ProvidersRegistry(registry.Registry):
1303
 
    """This registry exists to allow other providers to exist"""
 
1233
    '''This registry exists to allow other providers to exist'''
1304
1234
 
1305
1235
    def __iter__(self):
1306
1236
        for key, provider in self.iteritems():