← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Vincent Ladeuil
  • Date: 2011-05-15 16:07:11 UTC
  • mto: (5743.13.4 config-editor-option)
  • mto: This revision was merged to the branch mainline in revision 5944.
  • Revision ID: v.ladeuil+lp@free.fr-20110515160711-l0og3ady9wuahz1k
Stack.get() provides the registered option default value.

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
50
47
# Compatibility - Option used to be in commands.
51
48
from bzrlib.option import Option
52
49
from bzrlib.plugin import disable_plugins, load_plugins
276
273
    # Allow plugins to extend commands
277
274
    for hook in Command.hooks['extend_command']:
278
275
        hook(cmd)
 
276
    if getattr(cmd, 'invoked_as', None) is None:
 
277
        cmd.invoked_as = cmd_name
279
278
    return cmd
280
279
 
281
280
 
397
396
            sys.stdout is forced to be a binary stream, and line-endings
398
397
            will not mangled.
399
398
 
 
399
    :ivar invoked_as:
 
400
        A string indicating the real name under which this command was
 
401
        invoked, before expansion of aliases. 
 
402
        (This may be None if the command was constructed and run in-process.)
 
403
 
400
404
    :cvar hooks: An instance of CommandHooks.
 
405
 
401
406
    :ivar __doc__: The help shown by 'bzr help command' for this command.
402
407
        This is set by assigning explicitly to __doc__ so that -OO can
403
408
        be used::
409
414
    takes_args = []
410
415
    takes_options = []
411
416
    encoding_type = 'strict'
 
417
    invoked_as = None
412
418
 
413
419
    hidden = False
414
420
 
687
693
 
688
694
        self._setup_outf()
689
695
 
690
 
        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)
691
705
 
692
706
    def _setup_run(self):
693
707
        """Wrap the defined run method on self with a cleanup.
744
758
        return getdoc(self)
745
759
 
746
760
    def name(self):
 
761
        """Return the canonical name for this command.
 
762
 
 
763
        The name under which it was actually invoked is available in invoked_as.
 
764
        """
747
765
        return _unsquish_command_name(self.__class__.__name__)
748
766
 
749
767
    def plugin_name(self):
767
785
        These are all empty initially, because by default nothing should get
768
786
        notified.
769
787
        """
770
 
        Hooks.__init__(self)
771
 
        self.create_hook(HookPoint('extend_command',
 
788
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
 
789
        self.add_hook('extend_command',
772
790
            "Called after creating a command object to allow modifications "
773
791
            "such as adding or removing options, docs etc. Called with the "
774
 
            "new bzrlib.commands.Command object.", (1, 13), None))
775
 
        self.create_hook(HookPoint('get_command',
 
792
            "new bzrlib.commands.Command object.", (1, 13))
 
793
        self.add_hook('get_command',
776
794
            "Called when creating a single command. Called with "
777
795
            "(cmd_or_None, command_name). get_command should either return "
778
796
            "the cmd_or_None parameter, or a replacement Command object that "
779
797
            "should be used for the command. Note that the Command.hooks "
780
798
            "hooks are core infrastructure. Many users will prefer to use "
781
799
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
 
            (1, 17), None))
783
 
        self.create_hook(HookPoint('get_missing_command',
 
800
            (1, 17))
 
801
        self.add_hook('get_missing_command',
784
802
            "Called when creating a single command if no command could be "
785
803
            "found. Called with (command_name). get_missing_command should "
786
804
            "either return None, or a Command object to be used for the "
787
 
            "command.", (1, 17), None))
788
 
        self.create_hook(HookPoint('list_commands',
 
805
            "command.", (1, 17))
 
806
        self.add_hook('list_commands',
789
807
            "Called when enumerating commands. Called with a set of "
790
808
            "cmd_name strings for all the commands found so far. This set "
791
809
            " is safe to mutate - e.g. to remove a command. "
792
810
            "list_commands should return the updated set of command names.",
793
 
            (1, 17), None))
 
811
            (1, 17))
794
812
 
795
813
Command.hooks = CommandHooks()
796
814
 
810
828
    else:
811
829
        args = argv
812
830
 
813
 
    options, args = parser.parse_args(args)
 
831
    # for python 2.5 and later, optparse raises this exception if a non-ascii
 
832
    # option name is given.  See http://bugs.python.org/issue2931
 
833
    try:
 
834
        options, args = parser.parse_args(args)
 
835
    except UnicodeEncodeError,e:
 
836
        raise errors.BzrCommandError('Only ASCII permitted in option names')
 
837
 
814
838
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
815
839
                 v is not option.OptionParser.DEFAULT_VALUE])
816
840
    return args, opts
1020
1044
        Specify the number of processes that can be run concurrently (selftest).
1021
1045
    """
1022
1046
    trace.mutter("bazaar version: " + bzrlib.__version__)
1023
 
    argv = list(argv)
 
1047
    argv = _specified_or_unicode_argv(argv)
1024
1048
    trace.mutter("bzr arguments: %r", argv)
1025
1049
 
1026
1050
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1166
1190
        new_argv = []
1167
1191
        try:
1168
1192
            # ensure all arguments are unicode strings
1169
 
            for a in argv[1:]:
 
1193
            for a in argv:
1170
1194
                if isinstance(a, unicode):
1171
1195
                    new_argv.append(a)
1172
1196
                else:
1188
1212
 
1189
1213
    :return: exit code of bzr command.
1190
1214
    """
1191
 
    argv = _specified_or_unicode_argv(argv)
 
1215
    if argv is not None:
 
1216
        argv = argv[1:]
1192
1217
    _register_builtin_commands()
1193
1218
    ret = run_bzr_catch_errors(argv)
1194
 
    bzrlib.ui.ui_factory.log_transport_activity(
1195
 
        display=('bytes' in debug.debug_flags))
1196
1219
    trace.mutter("return code %d", ret)
1197
1220
    return ret
1198
1221