← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

Merge bzr.dev into cleanup

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
 
78
72
 
79
73
 
80
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)
81
91
 
82
92
    @staticmethod
83
93
    def _get_name(command_name):
99
109
        try:
100
110
            previous = self.get(k_unsquished)
101
111
        except KeyError:
102
 
            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
103
118
        info = CommandInfo.from_command(cmd)
104
119
        try:
105
120
            registry.Registry.register(self, k_unsquished, cmd,
110
125
                sys.modules[cmd.__module__])
111
126
            trace.warning('Previously this command was registered from %r' %
112
127
                sys.modules[previous.__module__])
 
128
        for a in cmd.aliases:
 
129
            self._alias_dict[a] = k_unsquished
113
130
        return previous
114
131
 
115
132
    def register_lazy(self, command_name, aliases, module_name):
122
139
        key = self._get_name(command_name)
123
140
        registry.Registry.register_lazy(self, key, module_name, command_name,
124
141
                                        info=CommandInfo(aliases))
 
142
        for a in aliases:
 
143
            self._alias_dict[a] = key
125
144
 
126
145
 
127
146
plugin_cmds = CommandRegistry()
 
147
builtin_command_registry = CommandRegistry()
 
148
plugin_cmds.overridden_registry = builtin_command_registry
128
149
 
129
150
 
130
151
def register_command(cmd, decorate=False):
 
152
    """Register a plugin command.
 
153
 
 
154
    Should generally be avoided in favor of lazy registration. 
 
155
    """
131
156
    global plugin_cmds
132
157
    return plugin_cmds.register(cmd, decorate)
133
158
 
140
165
    return cmd[4:].replace('_','-')
141
166
 
142
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
143
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
144
182
    import bzrlib.builtins
145
 
    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')
146
189
 
147
190
 
148
191
def _scan_module_for_commands(module):
155
198
 
156
199
 
157
200
def _list_bzr_commands(names):
158
 
    """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
    """
159
205
    # to eliminate duplicates
160
206
    names.update(builtin_command_names())
161
207
    names.update(plugin_command_names())
179
225
    Use of all_command_names() is encouraged rather than builtin_command_names
180
226
    and/or plugin_command_names.
181
227
    """
182
 
    return _builtin_commands().keys()
 
228
    return builtin_command_registry.keys()
183
229
 
184
230
 
185
231
def plugin_command_names():
263
309
 
264
310
def _get_bzr_command(cmd_or_None, cmd_name):
265
311
    """Get a command from bzr's core."""
266
 
    cmds = _builtin_commands()
267
312
    try:
268
 
        return cmds[cmd_name]()
 
313
        cmd_class = builtin_command_registry.get(cmd_name)
269
314
    except KeyError:
270
315
        pass
271
 
    # look for any command which claims this as an alias
272
 
    for real_cmd_name, cmd_class in cmds.iteritems():
273
 
        if cmd_name in cmd_class.aliases:
274
 
            return cmd_class()
 
316
    else:
 
317
        return cmd_class()
275
318
    return cmd_or_None
276
319
 
277
320
 
1116
1159
    :return: exit code of bzr command.
1117
1160
    """
1118
1161
    argv = _specified_or_unicode_argv(argv)
 
1162
    _register_builtin_commands()
1119
1163
    ret = run_bzr_catch_errors(argv)
1120
1164
    bzrlib.ui.ui_factory.log_transport_activity(
1121
1165
        display=('bytes' in debug.debug_flags))