← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-10 16:41:09 UTC
  • mto: (5029.2.1 integration2)
  • mto: This revision was merged to the branch mainline in revision 5031.
  • Revision ID: v.ladeuil+lp@free.fr-20100210164109-q5wluu91am3vsf6d
Use a set() for conflicts_related to stay O(1).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
 
35
41
import bzrlib
36
42
from bzrlib import (
37
43
    cleanup,
38
 
    cmdline,
39
44
    debug,
40
45
    errors,
41
46
    option,
49
54
from bzrlib.hooks import HookPoint, Hooks
50
55
# Compatibility - Option used to be in commands.
51
56
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
57
from bzrlib import registry
54
58
from bzrlib.symbol_versioning import (
55
59
    deprecated_function,
56
60
    deprecated_in,
57
61
    deprecated_method,
 
62
    suppress_deprecation_warnings,
58
63
    )
59
64
 
60
65
 
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():
230
186
    return plugin_cmds.keys()
231
187
 
232
188
 
 
189
@deprecated_function(deprecated_in((1, 17, 0)))
 
190
def get_all_cmds(plugins_override=False):
 
191
    """Return canonical name and class for most commands.
 
192
    
 
193
    NB: This does not return all commands since the introduction of
 
194
    command hooks, and returning the class is not sufficient to 
 
195
    get correctly setup commands, which is why it is deprecated.
 
196
 
 
197
    Use 'all_command_names' + 'get_cmd_object' instead.
 
198
    """
 
199
    d = _builtin_commands()
 
200
    if plugins_override:
 
201
        d.update(plugin_cmds.iteritems())
 
202
    for k, v in d.iteritems():
 
203
        yield k,v
 
204
 
 
205
 
233
206
def get_cmd_object(cmd_name, plugins_override=True):
234
207
    """Return the command object for a command.
235
208
 
242
215
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
216
 
244
217
 
245
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
218
def _get_cmd_object(cmd_name, plugins_override=True):
246
219
    """Get a command object.
247
220
 
248
221
    :param cmd_name: The name of the command.
249
222
    :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
223
    :return: A Command object instance
253
224
    :raises KeyError: If no command is found.
254
225
    """
264
235
            # We've found a non-plugin command, don't permit it to be
265
236
            # overridden.
266
237
            break
267
 
    if cmd is None and check_missing:
 
238
    if cmd is None:
268
239
        for hook in Command.hooks['get_missing_command']:
269
240
            cmd = hook(cmd_name)
270
241
            if cmd is not None:
306
277
 
307
278
def _get_bzr_command(cmd_or_None, cmd_name):
308
279
    """Get a command from bzr's core."""
 
280
    cmds = _builtin_commands()
309
281
    try:
310
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
282
        return cmds[cmd_name]()
311
283
    except KeyError:
312
284
        pass
313
 
    else:
314
 
        return cmd_class()
 
285
    # look for any command which claims this as an alias
 
286
    for real_cmd_name, cmd_class in cmds.iteritems():
 
287
        if cmd_name in cmd_class.aliases:
 
288
            return cmd_class()
315
289
    return cmd_or_None
316
290
 
317
291
 
411
385
            warn("No help message set for %r" % self)
412
386
        # List of standard options directly supported
413
387
        self.supported_std_options = []
414
 
        self._setup_run()
415
 
 
 
388
        self._operation = cleanup.OperationWithCleanups(self.run)
 
389
    
416
390
    def add_cleanup(self, cleanup_func, *args, **kwargs):
417
391
        """Register a function to call after self.run returns or raises.
418
392
 
429
403
 
430
404
        This is useful for releasing expensive or contentious resources (such
431
405
        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.
 
406
        resources (such as writing results to self.outf).
435
407
        """
436
408
        self._operation.cleanup_now()
437
 
 
 
409
        
438
410
    @deprecated_method(deprecated_in((2, 1, 0)))
439
411
    def _maybe_expand_globs(self, file_list):
440
412
        """Glob expand file_list if the platform does not do that itself.
652
624
 
653
625
    def run_argv_aliases(self, argv, alias_argv=None):
654
626
        """Parse the command line and run with extra aliases in alias_argv."""
 
627
        if argv is None:
 
628
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
629
                 DeprecationWarning, stacklevel=2)
 
630
            argv = []
655
631
        args, opts = parse_args(self, argv, alias_argv)
656
632
 
657
633
        # Process the standard options
682
658
 
683
659
        self._setup_outf()
684
660
 
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)))
 
661
        return self.run_direct(**all_cmd_args)
 
662
 
706
663
    def run_direct(self, *args, **kwargs):
707
 
        """Deprecated thunk from bzrlib 2.1."""
708
 
        return self.run(*args, **kwargs)
 
664
        """Call run directly with objects (without parsing an argv list)."""
 
665
        return self._operation.run_simple(*args, **kwargs)
709
666
 
710
667
    def run(self):
711
668
        """Actually run the command.
716
673
        Return 0 or None if the command was successful, or a non-zero
717
674
        shell error code if not.  It's OK for this method to allow
718
675
        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
676
        """
731
677
        raise NotImplementedError('no implementation of command %r'
732
678
                                  % self.name())
949
895
    return ret
950
896
 
951
897
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
898
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
 
899
    import shlex
 
900
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
955
901
 
956
902
 
957
903
def get_alias(cmd, config=None):
969
915
        config = bzrlib.config.GlobalConfig()
970
916
    alias = config.get_alias(cmd)
971
917
    if (alias):
972
 
        return cmdline.split(alias)
 
918
        return shlex_split_unicode(alias)
973
919
    return None
974
920
 
975
921
 
976
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
922
def run_bzr(argv):
977
923
    """Execute a command.
978
924
 
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.
 
925
    argv
 
926
       The command-line arguments, without the program name from argv[0]
 
927
       These should already be decoded. All library/test code calling
 
928
       run_bzr should be passing valid strings (don't need decoding).
 
929
 
 
930
    Returns a command status or raises an exception.
991
931
 
992
932
    Special master options: these must come before the command because
993
933
    they control how the command is interpreted.
1058
998
 
1059
999
    debug.set_debug_flags_from_config()
1060
1000
 
 
1001
    argv = argv_copy
 
1002
    if (not argv):
 
1003
        from bzrlib.builtins import cmd_help
 
1004
        cmd_help().run_argv_aliases([])
 
1005
        return 0
 
1006
 
 
1007
    if argv[0] == '--version':
 
1008
        from bzrlib.builtins import cmd_version
 
1009
        cmd_version().run_argv_aliases([])
 
1010
        return 0
 
1011
 
1061
1012
    if not opt_no_plugins:
 
1013
        from bzrlib.plugin import load_plugins
1062
1014
        load_plugins()
1063
1015
    else:
 
1016
        from bzrlib.plugin import disable_plugins
1064
1017
        disable_plugins()
1065
1018
 
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
1019
    alias_argv = None
1076
1020
 
1077
1021
    if not opt_no_aliases:
1155
1099
        "bzr plugin-provider-db check")
1156
1100
 
1157
1101
 
1158
 
 
1159
 
def _specified_or_unicode_argv(argv):
1160
 
    # For internal or testing use, argv can be passed.  Otherwise, get it from
1161
 
    # the process arguments in a unicode-safe way.
 
1102
def main(argv=None):
 
1103
    """Main entry point of command-line interface.
 
1104
 
 
1105
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1106
        argv[0] is script name usually, it will be ignored.
 
1107
        Don't pass here sys.argv because this list contains plain strings
 
1108
        and not unicode; pass None instead.
 
1109
 
 
1110
    :return: exit code of bzr command.
 
1111
    """
 
1112
    import bzrlib.ui
 
1113
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
1114
        sys.stdin, sys.stdout, sys.stderr)
 
1115
 
 
1116
    # Is this a final release version? If so, we should suppress warnings
 
1117
    if bzrlib.version_info[3] == 'final':
 
1118
        suppress_deprecation_warnings(override=True)
1162
1119
    if argv is None:
1163
 
        return osutils.get_unicode_argv()
 
1120
        argv = osutils.get_unicode_argv()
1164
1121
    else:
1165
1122
        new_argv = []
1166
1123
        try:
1172
1129
                    new_argv.append(a.decode('ascii'))
1173
1130
        except UnicodeDecodeError:
1174
1131
            raise errors.BzrError("argv should be list of unicode strings.")
1175
 
        return new_argv
1176
 
 
1177
 
 
1178
 
def main(argv=None):
1179
 
    """Main entry point of command-line interface.
1180
 
 
1181
 
    Typically `bzrlib.initialize` should be called first.
1182
 
 
1183
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1184
 
        argv[0] is script name usually, it will be ignored.
1185
 
        Don't pass here sys.argv because this list contains plain strings
1186
 
        and not unicode; pass None instead.
1187
 
 
1188
 
    :return: exit code of bzr command.
1189
 
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
1191
 
    _register_builtin_commands()
 
1132
        argv = new_argv
1192
1133
    ret = run_bzr_catch_errors(argv)
1193
1134
    bzrlib.ui.ui_factory.log_transport_activity(
1194
1135
        display=('bytes' in debug.debug_flags))
1195
1136
    trace.mutter("return code %d", ret)
 
1137
    osutils.report_extension_load_failures()
1196
1138
    return ret
1197
1139
 
1198
1140
 
1202
1144
    This function assumed that that UI layer is setup, that symbol deprecations
1203
1145
    are already applied, and that unicode decoding has already been performed on argv.
1204
1146
    """
1205
 
    # done here so that they're covered for every test run
1206
1147
    install_bzr_command_hooks()
1207
1148
    return exception_to_return_code(run_bzr, argv)
1208
1149
 
1213
1154
    This is used for the test suite, and might be useful for other programs
1214
1155
    that want to wrap the commandline interface.
1215
1156
    """
1216
 
    # done here so that they're covered for every test run
1217
1157
    install_bzr_command_hooks()
1218
1158
    try:
1219
1159
        return run_bzr(argv)
1242
1182
        if topic and topic.startswith(self.prefix):
1243
1183
            topic = topic[len(self.prefix):]
1244
1184
        try:
1245
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1185
            cmd = _get_cmd_object(topic)
1246
1186
        except KeyError:
1247
1187
            return []
1248
1188
        else:
1269
1209
            yield provider
1270
1210
 
1271
1211
command_providers_registry = ProvidersRegistry()
 
1212
 
 
1213
 
 
1214
if __name__ == '__main__':
 
1215
    sys.exit(main(sys.argv))