← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Gordon Tyler
  • Date: 2010-02-02 06:30:43 UTC
  • mto: (5037.3.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5046.
  • Revision ID: gordon@doxxx.net-20100202063043-3ygr1114d25m3f7m
Added cmdline.split function, which replaces commands.shlex_split_unicode.

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
 
49
55
from bzrlib.hooks import HookPoint, Hooks
50
56
# Compatibility - Option used to be in commands.
51
57
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
58
from bzrlib import registry
54
59
from bzrlib.symbol_versioning import (
55
60
    deprecated_function,
56
61
    deprecated_in,
57
62
    deprecated_method,
 
63
    suppress_deprecation_warnings,
58
64
    )
59
65
 
60
66
 
72
78
 
73
79
 
74
80
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
81
 
92
82
    @staticmethod
93
83
    def _get_name(command_name):
109
99
        try:
110
100
            previous = self.get(k_unsquished)
111
101
        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
 
102
            previous = _builtin_commands().get(k_unsquished)
118
103
        info = CommandInfo.from_command(cmd)
119
104
        try:
120
105
            registry.Registry.register(self, k_unsquished, cmd,
125
110
                sys.modules[cmd.__module__])
126
111
            trace.warning('Previously this command was registered from %r' %
127
112
                sys.modules[previous.__module__])
128
 
        for a in cmd.aliases:
129
 
            self._alias_dict[a] = k_unsquished
130
113
        return previous
131
114
 
132
115
    def register_lazy(self, command_name, aliases, module_name):
139
122
        key = self._get_name(command_name)
140
123
        registry.Registry.register_lazy(self, key, module_name, command_name,
141
124
                                        info=CommandInfo(aliases))
142
 
        for a in aliases:
143
 
            self._alias_dict[a] = key
144
125
 
145
126
 
146
127
plugin_cmds = CommandRegistry()
147
 
builtin_command_registry = CommandRegistry()
148
 
plugin_cmds.overridden_registry = builtin_command_registry
149
128
 
150
129
 
151
130
def register_command(cmd, decorate=False):
152
 
    """Register a plugin command.
153
 
 
154
 
    Should generally be avoided in favor of lazy registration. 
155
 
    """
156
131
    global plugin_cmds
157
132
    return plugin_cmds.register(cmd, decorate)
158
133
 
165
140
    return cmd[4:].replace('_','-')
166
141
 
167
142
 
168
 
@deprecated_function(deprecated_in((2, 2, 0)))
169
143
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
144
    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()
 
145
    return _scan_module_for_commands(bzrlib.builtins)
186
146
 
187
147
 
188
148
def _scan_module_for_commands(module):
195
155
 
196
156
 
197
157
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
 
    """
 
158
    """Find commands from bzr's core and plugins."""
202
159
    # to eliminate duplicates
203
160
    names.update(builtin_command_names())
204
161
    names.update(plugin_command_names())
222
179
    Use of all_command_names() is encouraged rather than builtin_command_names
223
180
    and/or plugin_command_names.
224
181
    """
225
 
    return builtin_command_registry.keys()
 
182
    return _builtin_commands().keys()
226
183
 
227
184
 
228
185
def plugin_command_names():
230
187
    return plugin_cmds.keys()
231
188
 
232
189
 
 
190
@deprecated_function(deprecated_in((1, 17, 0)))
 
191
def get_all_cmds(plugins_override=False):
 
192
    """Return canonical name and class for most commands.
 
193
    
 
194
    NB: This does not return all commands since the introduction of
 
195
    command hooks, and returning the class is not sufficient to 
 
196
    get correctly setup commands, which is why it is deprecated.
 
197
 
 
198
    Use 'all_command_names' + 'get_cmd_object' instead.
 
199
    """
 
200
    d = _builtin_commands()
 
201
    if plugins_override:
 
202
        d.update(plugin_cmds.iteritems())
 
203
    for k, v in d.iteritems():
 
204
        yield k,v
 
205
 
 
206
 
233
207
def get_cmd_object(cmd_name, plugins_override=True):
234
208
    """Return the command object for a command.
235
209
 
242
216
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
217
 
244
218
 
245
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
219
def _get_cmd_object(cmd_name, plugins_override=True):
246
220
    """Get a command object.
247
221
 
248
222
    :param cmd_name: The name of the command.
249
223
    :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
224
    :return: A Command object instance
253
225
    :raises KeyError: If no command is found.
254
226
    """
264
236
            # We've found a non-plugin command, don't permit it to be
265
237
            # overridden.
266
238
            break
267
 
    if cmd is None and check_missing:
 
239
    if cmd is None:
268
240
        for hook in Command.hooks['get_missing_command']:
269
241
            cmd = hook(cmd_name)
270
242
            if cmd is not None:
306
278
 
307
279
def _get_bzr_command(cmd_or_None, cmd_name):
308
280
    """Get a command from bzr's core."""
 
281
    cmds = _builtin_commands()
309
282
    try:
310
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
283
        return cmds[cmd_name]()
311
284
    except KeyError:
312
285
        pass
313
 
    else:
314
 
        return cmd_class()
 
286
    # look for any command which claims this as an alias
 
287
    for real_cmd_name, cmd_class in cmds.iteritems():
 
288
        if cmd_name in cmd_class.aliases:
 
289
            return cmd_class()
315
290
    return cmd_or_None
316
291
 
317
292
 
411
386
            warn("No help message set for %r" % self)
412
387
        # List of standard options directly supported
413
388
        self.supported_std_options = []
414
 
        self._setup_run()
415
 
 
 
389
        self._operation = cleanup.OperationWithCleanups(self.run)
 
390
    
416
391
    def add_cleanup(self, cleanup_func, *args, **kwargs):
417
392
        """Register a function to call after self.run returns or raises.
418
393
 
429
404
 
430
405
        This is useful for releasing expensive or contentious resources (such
431
406
        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.
 
407
        resources (such as writing results to self.outf).
435
408
        """
436
409
        self._operation.cleanup_now()
437
 
 
 
410
        
438
411
    @deprecated_method(deprecated_in((2, 1, 0)))
439
412
    def _maybe_expand_globs(self, file_list):
440
413
        """Glob expand file_list if the platform does not do that itself.
652
625
 
653
626
    def run_argv_aliases(self, argv, alias_argv=None):
654
627
        """Parse the command line and run with extra aliases in alias_argv."""
 
628
        if argv is None:
 
629
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
630
                 DeprecationWarning, stacklevel=2)
 
631
            argv = []
655
632
        args, opts = parse_args(self, argv, alias_argv)
656
633
 
657
634
        # Process the standard options
682
659
 
683
660
        self._setup_outf()
684
661
 
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)))
 
662
        return self.run_direct(**all_cmd_args)
 
663
 
706
664
    def run_direct(self, *args, **kwargs):
707
 
        """Deprecated thunk from bzrlib 2.1."""
708
 
        return self.run(*args, **kwargs)
 
665
        """Call run directly with objects (without parsing an argv list)."""
 
666
        return self._operation.run_simple(*args, **kwargs)
709
667
 
710
668
    def run(self):
711
669
        """Actually run the command.
716
674
        Return 0 or None if the command was successful, or a non-zero
717
675
        shell error code if not.  It's OK for this method to allow
718
676
        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
677
        """
731
678
        raise NotImplementedError('no implementation of command %r'
732
679
                                  % self.name())
949
896
    return ret
950
897
 
951
898
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
 
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
955
 
 
956
 
 
957
899
def get_alias(cmd, config=None):
958
900
    """Return an expanded alias, or None if no alias exists.
959
901
 
973
915
    return None
974
916
 
975
917
 
976
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
918
def run_bzr(argv):
977
919
    """Execute a command.
978
920
 
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.
 
921
    argv
 
922
       The command-line arguments, without the program name from argv[0]
 
923
       These should already be decoded. All library/test code calling
 
924
       run_bzr should be passing valid strings (don't need decoding).
 
925
 
 
926
    Returns a command status or raises an exception.
991
927
 
992
928
    Special master options: these must come before the command because
993
929
    they control how the command is interpreted.
1058
994
 
1059
995
    debug.set_debug_flags_from_config()
1060
996
 
 
997
    argv = argv_copy
 
998
    if (not argv):
 
999
        from bzrlib.builtins import cmd_help
 
1000
        cmd_help().run_argv_aliases([])
 
1001
        return 0
 
1002
 
 
1003
    if argv[0] == '--version':
 
1004
        from bzrlib.builtins import cmd_version
 
1005
        cmd_version().run_argv_aliases([])
 
1006
        return 0
 
1007
 
1061
1008
    if not opt_no_plugins:
 
1009
        from bzrlib.plugin import load_plugins
1062
1010
        load_plugins()
1063
1011
    else:
 
1012
        from bzrlib.plugin import disable_plugins
1064
1013
        disable_plugins()
1065
1014
 
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
1015
    alias_argv = None
1076
1016
 
1077
1017
    if not opt_no_aliases:
1155
1095
        "bzr plugin-provider-db check")
1156
1096
 
1157
1097
 
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.
 
1098
def main(argv=None):
 
1099
    """Main entry point of command-line interface.
 
1100
 
 
1101
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1102
        argv[0] is script name usually, it will be ignored.
 
1103
        Don't pass here sys.argv because this list contains plain strings
 
1104
        and not unicode; pass None instead.
 
1105
 
 
1106
    :return: exit code of bzr command.
 
1107
    """
 
1108
    import bzrlib.ui
 
1109
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
1110
        sys.stdin, sys.stdout, sys.stderr)
 
1111
 
 
1112
    # Is this a final release version? If so, we should suppress warnings
 
1113
    if bzrlib.version_info[3] == 'final':
 
1114
        suppress_deprecation_warnings(override=True)
1162
1115
    if argv is None:
1163
 
        return osutils.get_unicode_argv()
 
1116
        argv = osutils.get_unicode_argv()
1164
1117
    else:
1165
1118
        new_argv = []
1166
1119
        try:
1172
1125
                    new_argv.append(a.decode('ascii'))
1173
1126
        except UnicodeDecodeError:
1174
1127
            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()
 
1128
        argv = new_argv
1192
1129
    ret = run_bzr_catch_errors(argv)
1193
1130
    bzrlib.ui.ui_factory.log_transport_activity(
1194
1131
        display=('bytes' in debug.debug_flags))
1195
1132
    trace.mutter("return code %d", ret)
 
1133
    osutils.report_extension_load_failures()
1196
1134
    return ret
1197
1135
 
1198
1136
 
1202
1140
    This function assumed that that UI layer is setup, that symbol deprecations
1203
1141
    are already applied, and that unicode decoding has already been performed on argv.
1204
1142
    """
1205
 
    # done here so that they're covered for every test run
1206
1143
    install_bzr_command_hooks()
1207
1144
    return exception_to_return_code(run_bzr, argv)
1208
1145
 
1213
1150
    This is used for the test suite, and might be useful for other programs
1214
1151
    that want to wrap the commandline interface.
1215
1152
    """
1216
 
    # done here so that they're covered for every test run
1217
1153
    install_bzr_command_hooks()
1218
1154
    try:
1219
1155
        return run_bzr(argv)
1242
1178
        if topic and topic.startswith(self.prefix):
1243
1179
            topic = topic[len(self.prefix):]
1244
1180
        try:
1245
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1181
            cmd = _get_cmd_object(topic)
1246
1182
        except KeyError:
1247
1183
            return []
1248
1184
        else:
1269
1205
            yield provider
1270
1206
 
1271
1207
command_providers_registry = ProvidersRegistry()
 
1208
 
 
1209
 
 
1210
if __name__ == '__main__':
 
1211
    sys.exit(main(sys.argv))