/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

  • Committer: Vincent Ladeuil
  • Date: 2010-03-01 09:02:18 UTC
  • mto: (5064.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5065.
  • Revision ID: v.ladeuil+lp@free.fr-20100301090218-pq3ib5y07dx3wbp6
Delete spurious spaces.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
 
18
# TODO: probably should say which arguments are candidates for glob
 
19
# expansion on windows and do that at the command level.
 
20
 
18
21
# TODO: Define arguments by objects, rather than just using names.
19
22
# Those objects can specify the expected type of the argument, which
20
23
# would help with validation and shell completion.  They could also provide
22
25
 
23
26
# TODO: Specific "examples" property on commands for consistent formatting.
24
27
 
 
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
 
29
# the profile output behind so it can be interactively examined?
 
30
 
25
31
import os
26
32
import sys
27
33
 
49
55
from bzrlib.hooks import HookPoint, Hooks
50
56
# Compatibility - Option used to be in commands.
51
57
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
58
from bzrlib import registry
54
59
from bzrlib.symbol_versioning import (
55
60
    deprecated_function,
72
77
 
73
78
 
74
79
class CommandRegistry(registry.Registry):
75
 
    """Special registry mapping command names to command classes.
76
 
    
77
 
    :ivar overridden_registry: Look in this registry for commands being
78
 
        overridden by this registry.  This can be used to tell plugin commands
79
 
        about the builtin they're decorating.
80
 
    """
81
 
 
82
 
    def __init__(self):
83
 
        registry.Registry.__init__(self)
84
 
        self.overridden_registry = None
85
 
        # map from aliases to the real command that implements the name
86
 
        self._alias_dict = {}
87
 
 
88
 
    def get(self, command_name):
89
 
        real_name = self._alias_dict.get(command_name, command_name)
90
 
        return registry.Registry.get(self, real_name)
91
80
 
92
81
    @staticmethod
93
82
    def _get_name(command_name):
109
98
        try:
110
99
            previous = self.get(k_unsquished)
111
100
        except KeyError:
112
 
            previous = None
113
 
            if self.overridden_registry:
114
 
                try:
115
 
                    previous = self.overridden_registry.get(k_unsquished)
116
 
                except KeyError:
117
 
                    pass
 
101
            previous = _builtin_commands().get(k_unsquished)
118
102
        info = CommandInfo.from_command(cmd)
119
103
        try:
120
104
            registry.Registry.register(self, k_unsquished, cmd,
125
109
                sys.modules[cmd.__module__])
126
110
            trace.warning('Previously this command was registered from %r' %
127
111
                sys.modules[previous.__module__])
128
 
        for a in cmd.aliases:
129
 
            self._alias_dict[a] = k_unsquished
130
112
        return previous
131
113
 
132
114
    def register_lazy(self, command_name, aliases, module_name):
139
121
        key = self._get_name(command_name)
140
122
        registry.Registry.register_lazy(self, key, module_name, command_name,
141
123
                                        info=CommandInfo(aliases))
142
 
        for a in aliases:
143
 
            self._alias_dict[a] = key
144
124
 
145
125
 
146
126
plugin_cmds = CommandRegistry()
147
 
builtin_command_registry = CommandRegistry()
148
 
plugin_cmds.overridden_registry = builtin_command_registry
149
127
 
150
128
 
151
129
def register_command(cmd, decorate=False):
152
 
    """Register a plugin command.
153
 
 
154
 
    Should generally be avoided in favor of lazy registration. 
155
 
    """
156
130
    global plugin_cmds
157
131
    return plugin_cmds.register(cmd, decorate)
158
132
 
165
139
    return cmd[4:].replace('_','-')
166
140
 
167
141
 
168
 
@deprecated_function(deprecated_in((2, 2, 0)))
169
142
def _builtin_commands():
170
 
    """Return a dict of {name: cmd_class} for builtin commands.
171
 
 
172
 
    :deprecated: Use the builtin_command_registry registry instead
173
 
    """
174
 
    # return dict(name: cmd_class)
175
 
    return dict(builtin_command_registry.items())
176
 
 
177
 
 
178
 
def _register_builtin_commands():
179
 
    if builtin_command_registry.keys():
180
 
        # only load once
181
 
        return
182
143
    import bzrlib.builtins
183
 
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
 
        builtin_command_registry.register(cmd_class)
185
 
    bzrlib.builtins._register_lazy_builtins()
 
144
    return _scan_module_for_commands(bzrlib.builtins)
186
145
 
187
146
 
188
147
def _scan_module_for_commands(module):
195
154
 
196
155
 
197
156
def _list_bzr_commands(names):
198
 
    """Find commands from bzr's core and plugins.
199
 
    
200
 
    This is not the public interface, just the default hook called by all_command_names.
201
 
    """
 
157
    """Find commands from bzr's core and plugins."""
202
158
    # to eliminate duplicates
203
159
    names.update(builtin_command_names())
204
160
    names.update(plugin_command_names())
222
178
    Use of all_command_names() is encouraged rather than builtin_command_names
223
179
    and/or plugin_command_names.
224
180
    """
225
 
    return builtin_command_registry.keys()
 
181
    return _builtin_commands().keys()
226
182
 
227
183
 
228
184
def plugin_command_names():
242
198
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
199
 
244
200
 
245
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
201
def _get_cmd_object(cmd_name, plugins_override=True):
246
202
    """Get a command object.
247
203
 
248
204
    :param cmd_name: The name of the command.
249
205
    :param plugins_override: Allow plugins to override builtins.
250
 
    :param check_missing: Look up commands not found in the regular index via
251
 
        the get_missing_command hook.
252
206
    :return: A Command object instance
253
207
    :raises KeyError: If no command is found.
254
208
    """
264
218
            # We've found a non-plugin command, don't permit it to be
265
219
            # overridden.
266
220
            break
267
 
    if cmd is None and check_missing:
 
221
    if cmd is None:
268
222
        for hook in Command.hooks['get_missing_command']:
269
223
            cmd = hook(cmd_name)
270
224
            if cmd is not None:
306
260
 
307
261
def _get_bzr_command(cmd_or_None, cmd_name):
308
262
    """Get a command from bzr's core."""
 
263
    cmds = _builtin_commands()
309
264
    try:
310
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
265
        return cmds[cmd_name]()
311
266
    except KeyError:
312
267
        pass
313
 
    else:
314
 
        return cmd_class()
 
268
    # look for any command which claims this as an alias
 
269
    for real_cmd_name, cmd_class in cmds.iteritems():
 
270
        if cmd_name in cmd_class.aliases:
 
271
            return cmd_class()
315
272
    return cmd_or_None
316
273
 
317
274
 
411
368
            warn("No help message set for %r" % self)
412
369
        # List of standard options directly supported
413
370
        self.supported_std_options = []
414
 
        self._setup_run()
 
371
        self._operation = cleanup.OperationWithCleanups(self.run)
415
372
 
416
373
    def add_cleanup(self, cleanup_func, *args, **kwargs):
417
374
        """Register a function to call after self.run returns or raises.
429
386
 
430
387
        This is useful for releasing expensive or contentious resources (such
431
388
        as write locks) before doing further work that does not require those
432
 
        resources (such as writing results to self.outf). Note though, that
433
 
        as it releases all resources, this may release locks that the command
434
 
        wants to hold, so use should be done with care.
 
389
        resources (such as writing results to self.outf).
435
390
        """
436
391
        self._operation.cleanup_now()
437
392
 
682
637
 
683
638
        self._setup_outf()
684
639
 
685
 
        return self.run(**all_cmd_args)
686
 
 
687
 
    def _setup_run(self):
688
 
        """Wrap the defined run method on self with a cleanup.
689
 
 
690
 
        This is called by __init__ to make the Command be able to be run
691
 
        by just calling run(), as it could be before cleanups were added.
692
 
 
693
 
        If a different form of cleanups are in use by your Command subclass,
694
 
        you can override this method.
695
 
        """
696
 
        class_run = self.run
697
 
        def run(*args, **kwargs):
698
 
            self._operation = cleanup.OperationWithCleanups(class_run)
699
 
            try:
700
 
                return self._operation.run_simple(*args, **kwargs)
701
 
            finally:
702
 
                del self._operation
703
 
        self.run = run
704
 
 
705
 
    @deprecated_method(deprecated_in((2, 2, 0)))
 
640
        return self.run_direct(**all_cmd_args)
 
641
 
706
642
    def run_direct(self, *args, **kwargs):
707
 
        """Deprecated thunk from bzrlib 2.1."""
708
 
        return self.run(*args, **kwargs)
 
643
        """Call run directly with objects (without parsing an argv list)."""
 
644
        return self._operation.run_simple(*args, **kwargs)
709
645
 
710
646
    def run(self):
711
647
        """Actually run the command.
716
652
        Return 0 or None if the command was successful, or a non-zero
717
653
        shell error code if not.  It's OK for this method to allow
718
654
        an exception to raise up.
719
 
 
720
 
        This method is automatically wrapped by Command.__init__ with a 
721
 
        cleanup operation, stored as self._operation. This can be used
722
 
        via self.add_cleanup to perform automatic cleanups at the end of
723
 
        run().
724
 
 
725
 
        The argument for run are assembled by introspection. So for instance,
726
 
        if your command takes an argument files, you would declare::
727
 
 
728
 
            def run(self, files=None):
729
 
                pass
730
655
        """
731
656
        raise NotImplementedError('no implementation of command %r'
732
657
                                  % self.name())
949
874
    return ret
950
875
 
951
876
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
 
877
@deprecated_method(deprecated_in((2, 2, 0)))
953
878
def shlex_split_unicode(unsplit):
954
879
    return cmdline.split(unsplit)
955
880
 
973
898
    return None
974
899
 
975
900
 
976
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
901
def run_bzr(argv):
977
902
    """Execute a command.
978
903
 
979
 
    :param argv: The command-line arguments, without the program name from
980
 
        argv[0] These should already be decoded. All library/test code calling
981
 
        run_bzr should be passing valid strings (don't need decoding).
982
 
    :param load_plugins: What function to call when triggering plugin loading.
983
 
        This function should take no arguments and cause all plugins to be
984
 
        loaded.
985
 
    :param disable_plugins: What function to call when disabling plugin
986
 
        loading. This function should take no arguments and cause all plugin
987
 
        loading to be prohibited (so that code paths in your application that
988
 
        know about some plugins possibly being present will fail to import
989
 
        those plugins even if they are installed.)
990
 
    :return: Returns a command exit code or raises an exception.
 
904
    argv
 
905
       The command-line arguments, without the program name from argv[0]
 
906
       These should already be decoded. All library/test code calling
 
907
       run_bzr should be passing valid strings (don't need decoding).
 
908
 
 
909
    Returns a command status or raises an exception.
991
910
 
992
911
    Special master options: these must come before the command because
993
912
    they control how the command is interpreted.
1058
977
 
1059
978
    debug.set_debug_flags_from_config()
1060
979
 
 
980
    argv = argv_copy
 
981
    if (not argv):
 
982
        from bzrlib.builtins import cmd_help
 
983
        cmd_help().run_argv_aliases([])
 
984
        return 0
 
985
 
 
986
    if argv[0] == '--version':
 
987
        from bzrlib.builtins import cmd_version
 
988
        cmd_version().run_argv_aliases([])
 
989
        return 0
 
990
 
1061
991
    if not opt_no_plugins:
 
992
        from bzrlib.plugin import load_plugins
1062
993
        load_plugins()
1063
994
    else:
 
995
        from bzrlib.plugin import disable_plugins
1064
996
        disable_plugins()
1065
997
 
1066
 
    argv = argv_copy
1067
 
    if (not argv):
1068
 
        get_cmd_object('help').run_argv_aliases([])
1069
 
        return 0
1070
 
 
1071
 
    if argv[0] == '--version':
1072
 
        get_cmd_object('version').run_argv_aliases([])
1073
 
        return 0
1074
 
 
1075
998
    alias_argv = None
1076
999
 
1077
1000
    if not opt_no_aliases:
1188
1111
    :return: exit code of bzr command.
1189
1112
    """
1190
1113
    argv = _specified_or_unicode_argv(argv)
1191
 
    _register_builtin_commands()
1192
1114
    ret = run_bzr_catch_errors(argv)
1193
1115
    bzrlib.ui.ui_factory.log_transport_activity(
1194
1116
        display=('bytes' in debug.debug_flags))
1242
1164
        if topic and topic.startswith(self.prefix):
1243
1165
            topic = topic[len(self.prefix):]
1244
1166
        try:
1245
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1167
            cmd = _get_cmd_object(topic)
1246
1168
        except KeyError:
1247
1169
            return []
1248
1170
        else: