/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
 
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
    bzrlib.builtins._register_lazy_builtins()
144
186
 
145
187
 
146
188
def _scan_module_for_commands(module):
153
195
 
154
196
 
155
197
def _list_bzr_commands(names):
156
 
    """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
    """
157
202
    # to eliminate duplicates
158
203
    names.update(builtin_command_names())
159
204
    names.update(plugin_command_names())
177
222
    Use of all_command_names() is encouraged rather than builtin_command_names
178
223
    and/or plugin_command_names.
179
224
    """
180
 
    return _builtin_commands().keys()
 
225
    return builtin_command_registry.keys()
181
226
 
182
227
 
183
228
def plugin_command_names():
197
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
198
243
 
199
244
 
200
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
201
246
    """Get a command object.
202
247
 
203
248
    :param cmd_name: The name of the command.
204
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.
205
252
    :return: A Command object instance
206
253
    :raises KeyError: If no command is found.
207
254
    """
217
264
            # We've found a non-plugin command, don't permit it to be
218
265
            # overridden.
219
266
            break
220
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
221
268
        for hook in Command.hooks['get_missing_command']:
222
269
            cmd = hook(cmd_name)
223
270
            if cmd is not None:
259
306
 
260
307
def _get_bzr_command(cmd_or_None, cmd_name):
261
308
    """Get a command from bzr's core."""
262
 
    cmds = _builtin_commands()
263
309
    try:
264
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
265
311
    except KeyError:
266
312
        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()
 
313
    else:
 
314
        return cmd_class()
271
315
    return cmd_or_None
272
316
 
273
317
 
367
411
            warn("No help message set for %r" % self)
368
412
        # List of standard options directly supported
369
413
        self.supported_std_options = []
370
 
        self._operation = cleanup.OperationWithCleanups(self.run)
371
 
    
 
414
        self._setup_run()
 
415
 
372
416
    def add_cleanup(self, cleanup_func, *args, **kwargs):
373
417
        """Register a function to call after self.run returns or raises.
374
418
 
385
429
 
386
430
        This is useful for releasing expensive or contentious resources (such
387
431
        as write locks) before doing further work that does not require those
388
 
        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.
389
435
        """
390
436
        self._operation.cleanup_now()
391
 
        
 
437
 
392
438
    @deprecated_method(deprecated_in((2, 1, 0)))
393
439
    def _maybe_expand_globs(self, file_list):
394
440
        """Glob expand file_list if the platform does not do that itself.
636
682
 
637
683
        self._setup_outf()
638
684
 
639
 
        return self.run_direct(**all_cmd_args)
640
 
 
 
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)))
641
706
    def run_direct(self, *args, **kwargs):
642
 
        """Call run directly with objects (without parsing an argv list)."""
643
 
        return self._operation.run_simple(*args, **kwargs)
 
707
        """Deprecated thunk from bzrlib 2.1."""
 
708
        return self.run(*args, **kwargs)
644
709
 
645
710
    def run(self):
646
711
        """Actually run the command.
651
716
        Return 0 or None if the command was successful, or a non-zero
652
717
        shell error code if not.  It's OK for this method to allow
653
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
654
730
        """
655
731
        raise NotImplementedError('no implementation of command %r'
656
732
                                  % self.name())
873
949
    return ret
874
950
 
875
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
876
953
def shlex_split_unicode(unsplit):
877
 
    import shlex
878
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
954
    return cmdline.split(unsplit)
879
955
 
880
956
 
881
957
def get_alias(cmd, config=None):
893
969
        config = bzrlib.config.GlobalConfig()
894
970
    alias = config.get_alias(cmd)
895
971
    if (alias):
896
 
        return shlex_split_unicode(alias)
 
972
        return cmdline.split(alias)
897
973
    return None
898
974
 
899
975
 
900
 
def run_bzr(argv):
 
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
901
977
    """Execute a command.
902
978
 
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.
 
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.
909
991
 
910
992
    Special master options: these must come before the command because
911
993
    they control how the command is interpreted.
976
1058
 
977
1059
    debug.set_debug_flags_from_config()
978
1060
 
 
1061
    if not opt_no_plugins:
 
1062
        load_plugins()
 
1063
    else:
 
1064
        disable_plugins()
 
1065
 
979
1066
    argv = argv_copy
980
1067
    if (not argv):
981
 
        from bzrlib.builtins import cmd_help
982
 
        cmd_help().run_argv_aliases([])
 
1068
        get_cmd_object('help').run_argv_aliases([])
983
1069
        return 0
984
1070
 
985
1071
    if argv[0] == '--version':
986
 
        from bzrlib.builtins import cmd_version
987
 
        cmd_version().run_argv_aliases([])
 
1072
        get_cmd_object('version').run_argv_aliases([])
988
1073
        return 0
989
1074
 
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
1075
    alias_argv = None
998
1076
 
999
1077
    if not opt_no_aliases:
1110
1188
    :return: exit code of bzr command.
1111
1189
    """
1112
1190
    argv = _specified_or_unicode_argv(argv)
 
1191
    _register_builtin_commands()
1113
1192
    ret = run_bzr_catch_errors(argv)
1114
1193
    bzrlib.ui.ui_factory.log_transport_activity(
1115
1194
        display=('bytes' in debug.debug_flags))
1163
1242
        if topic and topic.startswith(self.prefix):
1164
1243
            topic = topic[len(self.prefix):]
1165
1244
        try:
1166
 
            cmd = _get_cmd_object(topic)
 
1245
            cmd = _get_cmd_object(topic, check_missing=False)
1167
1246
        except KeyError:
1168
1247
            return []
1169
1248
        else: