/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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
    bzrlib.builtins._register_lazy_builtins()
146
186
 
147
187
 
148
188
def _scan_module_for_commands(module):
155
195
 
156
196
 
157
197
def _list_bzr_commands(names):
158
 
    """Find commands from bzr's core and plugins."""
 
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
    """
159
202
    # to eliminate duplicates
160
203
    names.update(builtin_command_names())
161
204
    names.update(plugin_command_names())
179
222
    Use of all_command_names() is encouraged rather than builtin_command_names
180
223
    and/or plugin_command_names.
181
224
    """
182
 
    return _builtin_commands().keys()
 
225
    return builtin_command_registry.keys()
183
226
 
184
227
 
185
228
def plugin_command_names():
199
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
200
243
 
201
244
 
202
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
203
246
    """Get a command object.
204
247
 
205
248
    :param cmd_name: The name of the command.
206
249
    :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.
207
252
    :return: A Command object instance
208
253
    :raises KeyError: If no command is found.
209
254
    """
219
264
            # We've found a non-plugin command, don't permit it to be
220
265
            # overridden.
221
266
            break
222
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
223
268
        for hook in Command.hooks['get_missing_command']:
224
269
            cmd = hook(cmd_name)
225
270
            if cmd is not None:
261
306
 
262
307
def _get_bzr_command(cmd_or_None, cmd_name):
263
308
    """Get a command from bzr's core."""
264
 
    cmds = _builtin_commands()
265
309
    try:
266
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
267
311
    except KeyError:
268
312
        pass
269
 
    # look for any command which claims this as an alias
270
 
    for real_cmd_name, cmd_class in cmds.iteritems():
271
 
        if cmd_name in cmd_class.aliases:
272
 
            return cmd_class()
 
313
    else:
 
314
        return cmd_class()
273
315
    return cmd_or_None
274
316
 
275
317
 
369
411
            warn("No help message set for %r" % self)
370
412
        # List of standard options directly supported
371
413
        self.supported_std_options = []
372
 
        self._operation = cleanup.OperationWithCleanups(self.run)
373
 
    
 
414
        self._setup_run()
 
415
 
374
416
    def add_cleanup(self, cleanup_func, *args, **kwargs):
375
417
        """Register a function to call after self.run returns or raises.
376
418
 
387
429
 
388
430
        This is useful for releasing expensive or contentious resources (such
389
431
        as write locks) before doing further work that does not require those
390
 
        resources (such as writing results to self.outf).
 
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.
391
435
        """
392
436
        self._operation.cleanup_now()
393
 
        
 
437
 
394
438
    @deprecated_method(deprecated_in((2, 1, 0)))
395
439
    def _maybe_expand_globs(self, file_list):
396
440
        """Glob expand file_list if the platform does not do that itself.
638
682
 
639
683
        self._setup_outf()
640
684
 
641
 
        return self.run_direct(**all_cmd_args)
642
 
 
 
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)))
643
706
    def run_direct(self, *args, **kwargs):
644
 
        """Call run directly with objects (without parsing an argv list)."""
645
 
        return self._operation.run_simple(*args, **kwargs)
 
707
        """Deprecated thunk from bzrlib 2.1."""
 
708
        return self.run(*args, **kwargs)
646
709
 
647
710
    def run(self):
648
711
        """Actually run the command.
653
716
        Return 0 or None if the command was successful, or a non-zero
654
717
        shell error code if not.  It's OK for this method to allow
655
718
        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
656
730
        """
657
731
        raise NotImplementedError('no implementation of command %r'
658
732
                                  % self.name())
875
949
    return ret
876
950
 
877
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
 
953
def shlex_split_unicode(unsplit):
 
954
    return cmdline.split(unsplit)
 
955
 
 
956
 
878
957
def get_alias(cmd, config=None):
879
958
    """Return an expanded alias, or None if no alias exists.
880
959
 
1109
1188
    :return: exit code of bzr command.
1110
1189
    """
1111
1190
    argv = _specified_or_unicode_argv(argv)
 
1191
    _register_builtin_commands()
1112
1192
    ret = run_bzr_catch_errors(argv)
1113
1193
    bzrlib.ui.ui_factory.log_transport_activity(
1114
1194
        display=('bytes' in debug.debug_flags))
1162
1242
        if topic and topic.startswith(self.prefix):
1163
1243
            topic = topic[len(self.prefix):]
1164
1244
        try:
1165
 
            cmd = _get_cmd_object(topic)
 
1245
            cmd = _get_cmd_object(topic, check_missing=False)
1166
1246
        except KeyError:
1167
1247
            return []
1168
1248
        else: