← 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-01-12 21:27:00 UTC
  • mto: This revision was merged to the branch mainline in revision 5605.
  • Revision ID: john@arbash-meinel.com-20110112212700-esqmtrmevddxrsq2
Clean up the test slightly, hoping to avoid race conditions, update NEWS

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
275
276
    # Allow plugins to extend commands
276
277
    for hook in Command.hooks['extend_command']:
277
278
        hook(cmd)
278
 
    if getattr(cmd, 'invoked_as', None) is None:
279
 
        cmd.invoked_as = cmd_name
280
279
    return cmd
281
280
 
282
281
 
359
358
    summary, then a complete description of the command.  A grammar
360
359
    description will be inserted.
361
360
 
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
 
361
    aliases
 
362
        Other accepted names for this command.
 
363
 
 
364
    takes_args
 
365
        List of argument forms, marked with whether they are optional,
 
366
        repeated, etc.
 
367
 
 
368
                Examples:
 
369
 
 
370
                ['to_location', 'from_branch?', 'file*']
 
371
 
 
372
                'to_location' is required
 
373
                'from_branch' is optional
 
374
                'file' can be specified 0 or more times
 
375
 
 
376
    takes_options
 
377
        List of options that may be given for this command.  These can
 
378
        be either strings, referring to globally-defined options,
 
379
        or option objects.  Retrieve through options().
 
380
 
 
381
    hidden
 
382
        If true, this command isn't advertised.  This is typically
378
383
        for commands intended for expert users.
379
384
 
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.)
 
385
    encoding_type
 
386
        Command objects will get a 'outf' attribute, which has been
 
387
        setup to properly handle encoding of unicode strings.
 
388
        encoding_type determines what will happen when characters cannot
 
389
        be encoded
 
390
            strict - abort if we cannot decode
 
391
            replace - put in a bogus character (typically '?')
 
392
            exact - do not encode sys.stdout
 
393
 
 
394
            NOTE: by default on Windows, sys.stdout is opened as a text
 
395
            stream, therefore LF line-endings are converted to CRLF.
 
396
            When a command uses encoding_type = 'exact', then
 
397
            sys.stdout is forced to be a binary stream, and line-endings
 
398
            will not mangled.
398
399
 
399
400
    :cvar hooks: An instance of CommandHooks.
400
 
 
401
 
    :cvar __doc__: The help shown by 'bzr help command' for this command.
 
401
    :ivar __doc__: The help shown by 'bzr help command' for this command.
402
402
        This is set by assigning explicitly to __doc__ so that -OO can
403
403
        be used::
404
404
 
405
 
            class Foo(Command):
406
 
                __doc__ = "My help goes here"
 
405
        class Foo(Command):
 
406
            __doc__ = "My help goes here"
407
407
    """
408
408
    aliases = []
409
409
    takes_args = []
410
410
    takes_options = []
411
411
    encoding_type = 'strict'
412
 
    invoked_as = None
413
 
    l10n = True
414
412
 
415
413
    hidden = False
416
414
 
488
486
            usage help (e.g. Purpose, Usage, Options) with a
489
487
            message explaining how to obtain full help.
490
488
        """
491
 
        if self.l10n and not i18n.installed():
492
 
            i18n.install()  # Install i18n only for get_help_text for now.
493
489
        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.")
 
490
        if not doc:
 
491
            doc = "No help for this command."
503
492
 
504
493
        # Extract the summary (purpose) and sections out from the text
505
494
        purpose,sections,order = self._get_help_parts(doc)
512
501
 
513
502
        # The header is the purpose and usage
514
503
        result = ""
515
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
504
        result += ':Purpose: %s\n' % purpose
516
505
        if usage.find('\n') >= 0:
517
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
506
            result += ':Usage:\n%s\n' % usage
518
507
        else:
519
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
508
            result += ':Usage:   %s\n' % usage
520
509
        result += '\n'
521
510
 
522
511
        # Add the options
524
513
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
525
514
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
526
515
        # 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:
 
516
        options = option.get_optparser(self.options()).format_option_help()
 
517
        # XXX: According to the spec, ReST option lists actually don't support 
 
518
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
519
        # As that pattern always appears in the commands that break, we trap
 
520
        # on that and then format that block of 'format' options as a literal
 
521
        # block.
 
522
        if not plain and options.find('  --1.9  ') != -1:
536
523
            options = options.replace(' format:\n', ' format::\n\n', 1)
537
524
        if options.startswith('Options:'):
538
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
525
            result += ':' + options
 
526
        elif options.startswith('options:'):
 
527
            # Python 2.4 version of optparse
 
528
            result += ':Options:' + options[len('options:'):]
539
529
        else:
540
530
            result += options
541
531
        result += '\n'
546
536
            if sections.has_key(None):
547
537
                text = sections.pop(None)
548
538
                text = '\n  '.join(text.splitlines())
549
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
539
                result += ':%s:\n  %s\n\n' % ('Description',text)
550
540
 
551
541
            # Add the custom sections (e.g. Examples). Note that there's no need
552
542
            # to indent these as they must be indented already in the source.
553
543
            if sections:
554
544
                for label in order:
555
 
                    if label in sections:
556
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
545
                    if sections.has_key(label):
 
546
                        result += ':%s:\n%s\n' % (label,sections[label])
557
547
                result += '\n'
558
548
        else:
559
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
549
            result += ("See bzr help %s for more details and examples.\n\n"
560
550
                % self.name())
561
551
 
562
552
        # Add the aliases, source (plug-in) and see also links, if any
563
553
        if self.aliases:
564
 
            result += gettext(':Aliases:  ')
 
554
            result += ':Aliases:  '
565
555
            result += ', '.join(self.aliases) + '\n'
566
556
        plugin_name = self.plugin_name()
567
557
        if plugin_name is not None:
568
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
558
            result += ':From:     plugin "%s"\n' % plugin_name
569
559
        see_also = self.get_see_also(additional_see_also)
570
560
        if see_also:
571
561
            if not plain and see_also_as_links:
577
567
                        see_also_links.append(item)
578
568
                    else:
579
569
                        # Use a Sphinx link for this entry
580
 
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
 
570
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
581
571
                        see_also_links.append(link_text)
582
572
                see_also = see_also_links
583
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
573
            result += ':See also: '
 
574
            result += ', '.join(see_also) + '\n'
584
575
 
585
576
        # If this will be rendered as plain text, convert it
586
577
        if plain:
667
658
    def run_argv_aliases(self, argv, alias_argv=None):
668
659
        """Parse the command line and run with extra aliases in alias_argv."""
669
660
        args, opts = parse_args(self, argv, alias_argv)
670
 
        self._setup_outf()
671
661
 
672
662
        # Process the standard options
673
663
        if 'help' in opts:  # e.g. bzr add --help
674
 
            self.outf.write(self.get_help_text())
 
664
            sys.stdout.write(self.get_help_text())
675
665
            return 0
676
666
        if 'usage' in opts:  # e.g. bzr add --usage
677
 
            self.outf.write(self.get_help_text(verbose=False))
 
667
            sys.stdout.write(self.get_help_text(verbose=False))
678
668
            return 0
679
669
        trace.set_verbosity_level(option._verbosity_level)
680
670
        if 'verbose' in self.supported_std_options:
695
685
        all_cmd_args = cmdargs.copy()
696
686
        all_cmd_args.update(cmdopts)
697
687
 
 
688
        self._setup_outf()
 
689
 
698
690
        try:
699
691
            return self.run(**all_cmd_args)
700
692
        finally:
701
693
            # 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))
 
694
            # inherit state
706
695
            trace.set_verbosity_level(0)
707
696
 
708
697
    def _setup_run(self):
759
748
            return None
760
749
        return getdoc(self)
761
750
 
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
751
    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
752
        return _unsquish_command_name(self.__class__.__name__)
776
753
 
777
754
    def plugin_name(self):
795
772
        These are all empty initially, because by default nothing should get
796
773
        notified.
797
774
        """
798
 
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
799
 
        self.add_hook('extend_command',
 
775
        Hooks.__init__(self)
 
776
        self.create_hook(HookPoint('extend_command',
800
777
            "Called after creating a command object to allow modifications "
801
778
            "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',
 
779
            "new bzrlib.commands.Command object.", (1, 13), None))
 
780
        self.create_hook(HookPoint('get_command',
804
781
            "Called when creating a single command. Called with "
805
782
            "(cmd_or_None, command_name). get_command should either return "
806
783
            "the cmd_or_None parameter, or a replacement Command object that "
807
784
            "should be used for the command. Note that the Command.hooks "
808
785
            "hooks are core infrastructure. Many users will prefer to use "
809
786
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
810
 
            (1, 17))
811
 
        self.add_hook('get_missing_command',
 
787
            (1, 17), None))
 
788
        self.create_hook(HookPoint('get_missing_command',
812
789
            "Called when creating a single command if no command could be "
813
790
            "found. Called with (command_name). get_missing_command should "
814
791
            "either return None, or a Command object to be used for the "
815
 
            "command.", (1, 17))
816
 
        self.add_hook('list_commands',
 
792
            "command.", (1, 17), None))
 
793
        self.create_hook(HookPoint('list_commands',
817
794
            "Called when enumerating commands. Called with a set of "
818
795
            "cmd_name strings for all the commands found so far. This set "
819
796
            " is safe to mutate - e.g. to remove a command. "
820
797
            "list_commands should return the updated set of command names.",
821
 
            (1, 17))
 
798
            (1, 17), None))
822
799
 
823
800
Command.hooks = CommandHooks()
824
801
 
1054
1031
        Specify the number of processes that can be run concurrently (selftest).
1055
1032
    """
1056
1033
    trace.mutter("bazaar version: " + bzrlib.__version__)
1057
 
    argv = _specified_or_unicode_argv(argv)
 
1034
    argv = list(argv)
1058
1035
    trace.mutter("bzr arguments: %r", argv)
1059
1036
 
1060
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1061
 
            opt_no_l10n = opt_no_aliases = False
 
1037
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1038
                opt_no_aliases = False
1062
1039
    opt_lsprof_file = opt_coverage_dir = None
1063
1040
 
1064
1041
    # --no-plugins is handled specially at a very early stage. We need
1081
1058
            opt_no_plugins = True
1082
1059
        elif a == '--no-aliases':
1083
1060
            opt_no_aliases = True
1084
 
        elif a == '--no-l10n':
1085
 
            opt_no_l10n = True
1086
1061
        elif a == '--builtin':
1087
1062
            opt_builtin = True
1088
1063
        elif a == '--concurrency':
1124
1099
 
1125
1100
    cmd = argv.pop(0)
1126
1101
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1127
 
    if opt_no_l10n:
1128
 
        cmd.l10n = False
1129
1102
    run = cmd_obj.run_argv_aliases
1130
1103
    run_argv = [argv, alias_argv]
1131
1104
 
1204
1177
        new_argv = []
1205
1178
        try:
1206
1179
            # ensure all arguments are unicode strings
1207
 
            for a in argv:
 
1180
            for a in argv[1:]:
1208
1181
                if isinstance(a, unicode):
1209
1182
                    new_argv.append(a)
1210
1183
                else:
1226
1199
 
1227
1200
    :return: exit code of bzr command.
1228
1201
    """
1229
 
    if argv is not None:
1230
 
        argv = argv[1:]
 
1202
    argv = _specified_or_unicode_argv(argv)
1231
1203
    _register_builtin_commands()
1232
1204
    ret = run_bzr_catch_errors(argv)
 
1205
    bzrlib.ui.ui_factory.log_transport_activity(
 
1206
        display=('bytes' in debug.debug_flags))
1233
1207
    trace.mutter("return code %d", ret)
1234
1208
    return ret
1235
1209
 
1288
1262
 
1289
1263
 
1290
1264
class Provider(object):
1291
 
    """Generic class to be overriden by plugins"""
 
1265
    '''Generic class to be overriden by plugins'''
1292
1266
 
1293
1267
    def plugin_for_command(self, cmd_name):
1294
 
        """Takes a command and returns the information for that plugin
 
1268
        '''Takes a command and returns the information for that plugin
1295
1269
 
1296
1270
        :return: A dictionary with all the available information
1297
 
            for the requested plugin
1298
 
        """
 
1271
        for the requested plugin
 
1272
        '''
1299
1273
        raise NotImplementedError
1300
1274
 
1301
1275
 
1302
1276
class ProvidersRegistry(registry.Registry):
1303
 
    """This registry exists to allow other providers to exist"""
 
1277
    '''This registry exists to allow other providers to exist'''
1304
1278
 
1305
1279
    def __iter__(self):
1306
1280
        for key, provider in self.iteritems():