← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Ian Clatworthy
  • Date: 2010-03-30 20:13:52 UTC
  • mto: This revision was merged to the branch mainline in revision 5125.
  • Revision ID: ian.clatworthy@canonical.com-20100330201352-vw2gtujybyg3rvwc
whitespace fix in win32 installer

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
 
 
21
18
# TODO: Define arguments by objects, rather than just using names.
22
19
# Those objects can specify the expected type of the argument, which
23
20
# would help with validation and shell completion.  They could also provide
25
22
 
26
23
# TODO: Specific "examples" property on commands for consistent formatting.
27
24
 
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
 
 
31
25
import os
32
26
import sys
33
27
 
41
35
import bzrlib
42
36
from bzrlib import (
43
37
    cleanup,
 
38
    cmdline,
44
39
    debug,
45
40
    errors,
46
41
    option,
54
49
from bzrlib.hooks import HookPoint, Hooks
55
50
# Compatibility - Option used to be in commands.
56
51
from bzrlib.option import Option
 
52
from bzrlib.plugin import disable_plugins, load_plugins
57
53
from bzrlib import registry
58
54
from bzrlib.symbol_versioning import (
59
55
    deprecated_function,
76
72
 
77
73
 
78
74
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)
79
91
 
80
92
    @staticmethod
81
93
    def _get_name(command_name):
97
109
        try:
98
110
            previous = self.get(k_unsquished)
99
111
        except KeyError:
100
 
            previous = _builtin_commands().get(k_unsquished)
 
112
            previous = None
 
113
            if self.overridden_registry:
 
114
                try:
 
115
                    previous = self.overridden_registry.get(k_unsquished)
 
116
                except KeyError:
 
117
                    pass
101
118
        info = CommandInfo.from_command(cmd)
102
119
        try:
103
120
            registry.Registry.register(self, k_unsquished, cmd,
108
125
                sys.modules[cmd.__module__])
109
126
            trace.warning('Previously this command was registered from %r' %
110
127
                sys.modules[previous.__module__])
 
128
        for a in cmd.aliases:
 
129
            self._alias_dict[a] = k_unsquished
111
130
        return previous
112
131
 
113
132
    def register_lazy(self, command_name, aliases, module_name):
120
139
        key = self._get_name(command_name)
121
140
        registry.Registry.register_lazy(self, key, module_name, command_name,
122
141
                                        info=CommandInfo(aliases))
 
142
        for a in aliases:
 
143
            self._alias_dict[a] = key
123
144
 
124
145
 
125
146
plugin_cmds = CommandRegistry()
 
147
builtin_command_registry = CommandRegistry()
 
148
plugin_cmds.overridden_registry = builtin_command_registry
126
149
 
127
150
 
128
151
def register_command(cmd, decorate=False):
 
152
    """Register a plugin command.
 
153
 
 
154
    Should generally be avoided in favor of lazy registration. 
 
155
    """
129
156
    global plugin_cmds
130
157
    return plugin_cmds.register(cmd, decorate)
131
158
 
138
165
    return cmd[4:].replace('_','-')
139
166
 
140
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
141
169
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
142
182
    import bzrlib.builtins
143
 
    return _scan_module_for_commands(bzrlib.builtins)
 
183
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
 
184
        builtin_command_registry.register(cmd_class)
 
185
    # lazy builtins
 
186
    builtin_command_registry.register_lazy('cmd_bundle_info',
 
187
        [],
 
188
        'bzrlib.bundle.commands')
144
189
 
145
190
 
146
191
def _scan_module_for_commands(module):
153
198
 
154
199
 
155
200
def _list_bzr_commands(names):
156
 
    """Find commands from bzr's core and plugins."""
 
201
    """Find commands from bzr's core and plugins.
 
202
    
 
203
    This is not the public interface, just the default hook called by all_command_names.
 
204
    """
157
205
    # to eliminate duplicates
158
206
    names.update(builtin_command_names())
159
207
    names.update(plugin_command_names())
177
225
    Use of all_command_names() is encouraged rather than builtin_command_names
178
226
    and/or plugin_command_names.
179
227
    """
180
 
    return _builtin_commands().keys()
 
228
    return builtin_command_registry.keys()
181
229
 
182
230
 
183
231
def plugin_command_names():
197
245
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
198
246
 
199
247
 
200
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
248
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
201
249
    """Get a command object.
202
250
 
203
251
    :param cmd_name: The name of the command.
204
252
    :param plugins_override: Allow plugins to override builtins.
 
253
    :param check_missing: Look up commands not found in the regular index via
 
254
        the get_missing_command hook.
205
255
    :return: A Command object instance
206
256
    :raises KeyError: If no command is found.
207
257
    """
217
267
            # We've found a non-plugin command, don't permit it to be
218
268
            # overridden.
219
269
            break
220
 
    if cmd is None:
 
270
    if cmd is None and check_missing:
221
271
        for hook in Command.hooks['get_missing_command']:
222
272
            cmd = hook(cmd_name)
223
273
            if cmd is not None:
259
309
 
260
310
def _get_bzr_command(cmd_or_None, cmd_name):
261
311
    """Get a command from bzr's core."""
262
 
    cmds = _builtin_commands()
263
312
    try:
264
 
        return cmds[cmd_name]()
 
313
        cmd_class = builtin_command_registry.get(cmd_name)
265
314
    except KeyError:
266
315
        pass
267
 
    # look for any command which claims this as an alias
268
 
    for real_cmd_name, cmd_class in cmds.iteritems():
269
 
        if cmd_name in cmd_class.aliases:
270
 
            return cmd_class()
 
316
    else:
 
317
        return cmd_class()
271
318
    return cmd_or_None
272
319
 
273
320
 
368
415
        # List of standard options directly supported
369
416
        self.supported_std_options = []
370
417
        self._operation = cleanup.OperationWithCleanups(self.run)
371
 
    
 
418
 
372
419
    def add_cleanup(self, cleanup_func, *args, **kwargs):
373
420
        """Register a function to call after self.run returns or raises.
374
421
 
388
435
        resources (such as writing results to self.outf).
389
436
        """
390
437
        self._operation.cleanup_now()
391
 
        
 
438
 
392
439
    @deprecated_method(deprecated_in((2, 1, 0)))
393
440
    def _maybe_expand_globs(self, file_list):
394
441
        """Glob expand file_list if the platform does not do that itself.
873
920
    return ret
874
921
 
875
922
 
 
923
@deprecated_function(deprecated_in((2, 2, 0)))
876
924
def shlex_split_unicode(unsplit):
877
 
    import shlex
878
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
925
    return cmdline.split(unsplit)
879
926
 
880
927
 
881
928
def get_alias(cmd, config=None):
893
940
        config = bzrlib.config.GlobalConfig()
894
941
    alias = config.get_alias(cmd)
895
942
    if (alias):
896
 
        return shlex_split_unicode(alias)
 
943
        return cmdline.split(alias)
897
944
    return None
898
945
 
899
946
 
900
 
def run_bzr(argv):
 
947
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
901
948
    """Execute a command.
902
949
 
903
 
    argv
904
 
       The command-line arguments, without the program name from argv[0]
905
 
       These should already be decoded. All library/test code calling
906
 
       run_bzr should be passing valid strings (don't need decoding).
907
 
 
908
 
    Returns a command status or raises an exception.
 
950
    :param argv: The command-line arguments, without the program name from
 
951
        argv[0] These should already be decoded. All library/test code calling
 
952
        run_bzr should be passing valid strings (don't need decoding).
 
953
    :param load_plugins: What function to call when triggering plugin loading.
 
954
        This function should take no arguments and cause all plugins to be
 
955
        loaded.
 
956
    :param disable_plugins: What function to call when disabling plugin
 
957
        loading. This function should take no arguments and cause all plugin
 
958
        loading to be prohibited (so that code paths in your application that
 
959
        know about some plugins possibly being present will fail to import
 
960
        those plugins even if they are installed.)
 
961
    :return: Returns a command exit code or raises an exception.
909
962
 
910
963
    Special master options: these must come before the command because
911
964
    they control how the command is interpreted.
976
1029
 
977
1030
    debug.set_debug_flags_from_config()
978
1031
 
 
1032
    if not opt_no_plugins:
 
1033
        load_plugins()
 
1034
    else:
 
1035
        disable_plugins()
 
1036
 
979
1037
    argv = argv_copy
980
1038
    if (not argv):
981
 
        from bzrlib.builtins import cmd_help
982
 
        cmd_help().run_argv_aliases([])
 
1039
        get_cmd_object('help').run_argv_aliases([])
983
1040
        return 0
984
1041
 
985
1042
    if argv[0] == '--version':
986
 
        from bzrlib.builtins import cmd_version
987
 
        cmd_version().run_argv_aliases([])
 
1043
        get_cmd_object('version').run_argv_aliases([])
988
1044
        return 0
989
1045
 
990
 
    if not opt_no_plugins:
991
 
        from bzrlib.plugin import load_plugins
992
 
        load_plugins()
993
 
    else:
994
 
        from bzrlib.plugin import disable_plugins
995
 
        disable_plugins()
996
 
 
997
1046
    alias_argv = None
998
1047
 
999
1048
    if not opt_no_aliases:
1110
1159
    :return: exit code of bzr command.
1111
1160
    """
1112
1161
    argv = _specified_or_unicode_argv(argv)
 
1162
    _register_builtin_commands()
1113
1163
    ret = run_bzr_catch_errors(argv)
1114
1164
    bzrlib.ui.ui_factory.log_transport_activity(
1115
1165
        display=('bytes' in debug.debug_flags))
1163
1213
        if topic and topic.startswith(self.prefix):
1164
1214
            topic = topic[len(self.prefix):]
1165
1215
        try:
1166
 
            cmd = _get_cmd_object(topic)
 
1216
            cmd = _get_cmd_object(topic, check_missing=False)
1167
1217
        except KeyError:
1168
1218
            return []
1169
1219
        else: