← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2010-08-18 04:26:39 UTC
  • mfrom: (129.1.8 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100818042639-mjoxtngyjwiu05fo
* PPA rebuild for lucid.
* PPA rebuild for karmic.
* PPA rebuild onto jaunty.
* New upstream release.

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,
60
56
    deprecated_in,
61
57
    deprecated_method,
62
 
    suppress_deprecation_warnings,
63
58
    )
64
59
 
65
60
 
77
72
 
78
73
 
79
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)
80
91
 
81
92
    @staticmethod
82
93
    def _get_name(command_name):
98
109
        try:
99
110
            previous = self.get(k_unsquished)
100
111
        except KeyError:
101
 
            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
102
118
        info = CommandInfo.from_command(cmd)
103
119
        try:
104
120
            registry.Registry.register(self, k_unsquished, cmd,
109
125
                sys.modules[cmd.__module__])
110
126
            trace.warning('Previously this command was registered from %r' %
111
127
                sys.modules[previous.__module__])
 
128
        for a in cmd.aliases:
 
129
            self._alias_dict[a] = k_unsquished
112
130
        return previous
113
131
 
114
132
    def register_lazy(self, command_name, aliases, module_name):
121
139
        key = self._get_name(command_name)
122
140
        registry.Registry.register_lazy(self, key, module_name, command_name,
123
141
                                        info=CommandInfo(aliases))
 
142
        for a in aliases:
 
143
            self._alias_dict[a] = key
124
144
 
125
145
 
126
146
plugin_cmds = CommandRegistry()
 
147
builtin_command_registry = CommandRegistry()
 
148
plugin_cmds.overridden_registry = builtin_command_registry
127
149
 
128
150
 
129
151
def register_command(cmd, decorate=False):
 
152
    """Register a plugin command.
 
153
 
 
154
    Should generally be avoided in favor of lazy registration. 
 
155
    """
130
156
    global plugin_cmds
131
157
    return plugin_cmds.register(cmd, decorate)
132
158
 
139
165
    return cmd[4:].replace('_','-')
140
166
 
141
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
142
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
143
182
    import bzrlib.builtins
144
 
    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()
145
186
 
146
187
 
147
188
def _scan_module_for_commands(module):
154
195
 
155
196
 
156
197
def _list_bzr_commands(names):
157
 
    """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
    """
158
202
    # to eliminate duplicates
159
203
    names.update(builtin_command_names())
160
204
    names.update(plugin_command_names())
178
222
    Use of all_command_names() is encouraged rather than builtin_command_names
179
223
    and/or plugin_command_names.
180
224
    """
181
 
    return _builtin_commands().keys()
 
225
    return builtin_command_registry.keys()
182
226
 
183
227
 
184
228
def plugin_command_names():
186
230
    return plugin_cmds.keys()
187
231
 
188
232
 
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
 
 
206
233
def get_cmd_object(cmd_name, plugins_override=True):
207
234
    """Return the command object for a command.
208
235
 
215
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
216
243
 
217
244
 
218
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
219
246
    """Get a command object.
220
247
 
221
248
    :param cmd_name: The name of the command.
222
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.
223
252
    :return: A Command object instance
224
253
    :raises KeyError: If no command is found.
225
254
    """
235
264
            # We've found a non-plugin command, don't permit it to be
236
265
            # overridden.
237
266
            break
238
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
239
268
        for hook in Command.hooks['get_missing_command']:
240
269
            cmd = hook(cmd_name)
241
270
            if cmd is not None:
277
306
 
278
307
def _get_bzr_command(cmd_or_None, cmd_name):
279
308
    """Get a command from bzr's core."""
280
 
    cmds = _builtin_commands()
281
309
    try:
282
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
283
311
    except KeyError:
284
312
        pass
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()
 
313
    else:
 
314
        return cmd_class()
289
315
    return cmd_or_None
290
316
 
291
317
 
371
397
            will not mangled.
372
398
 
373
399
    :cvar hooks: An instance of CommandHooks.
 
400
    :ivar __doc__: The help shown by 'bzr help command' for this command.
 
401
        This is set by assigning explicitly to __doc__ so that -OO can
 
402
        be used::
 
403
 
 
404
        class Foo(Command):
 
405
            __doc__ = "My help goes here"
374
406
    """
375
407
    aliases = []
376
408
    takes_args = []
381
413
 
382
414
    def __init__(self):
383
415
        """Construct an instance of this command."""
384
 
        if self.__doc__ == Command.__doc__:
385
 
            warn("No help message set for %r" % self)
386
416
        # List of standard options directly supported
387
417
        self.supported_std_options = []
388
 
        self._operation = cleanup.OperationWithCleanups(self.run)
 
418
        self._setup_run()
389
419
 
390
420
    def add_cleanup(self, cleanup_func, *args, **kwargs):
391
421
        """Register a function to call after self.run returns or raises.
403
433
 
404
434
        This is useful for releasing expensive or contentious resources (such
405
435
        as write locks) before doing further work that does not require those
406
 
        resources (such as writing results to self.outf).
 
436
        resources (such as writing results to self.outf). Note though, that
 
437
        as it releases all resources, this may release locks that the command
 
438
        wants to hold, so use should be done with care.
407
439
        """
408
440
        self._operation.cleanup_now()
409
441
 
454
486
            message explaining how to obtain full help.
455
487
        """
456
488
        doc = self.help()
457
 
        if doc is None:
458
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
489
        if not doc:
 
490
            doc = "No help for this command."
459
491
 
460
492
        # Extract the summary (purpose) and sections out from the text
461
493
        purpose,sections,order = self._get_help_parts(doc)
624
656
 
625
657
    def run_argv_aliases(self, argv, alias_argv=None):
626
658
        """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 = []
631
659
        args, opts = parse_args(self, argv, alias_argv)
632
660
 
633
661
        # Process the standard options
658
686
 
659
687
        self._setup_outf()
660
688
 
661
 
        return self.run_direct(**all_cmd_args)
662
 
 
 
689
        return self.run(**all_cmd_args)
 
690
 
 
691
    def _setup_run(self):
 
692
        """Wrap the defined run method on self with a cleanup.
 
693
 
 
694
        This is called by __init__ to make the Command be able to be run
 
695
        by just calling run(), as it could be before cleanups were added.
 
696
 
 
697
        If a different form of cleanups are in use by your Command subclass,
 
698
        you can override this method.
 
699
        """
 
700
        class_run = self.run
 
701
        def run(*args, **kwargs):
 
702
            self._operation = cleanup.OperationWithCleanups(class_run)
 
703
            try:
 
704
                return self._operation.run_simple(*args, **kwargs)
 
705
            finally:
 
706
                del self._operation
 
707
        self.run = run
 
708
 
 
709
    @deprecated_method(deprecated_in((2, 2, 0)))
663
710
    def run_direct(self, *args, **kwargs):
664
 
        """Call run directly with objects (without parsing an argv list)."""
665
 
        return self._operation.run_simple(*args, **kwargs)
 
711
        """Deprecated thunk from bzrlib 2.1."""
 
712
        return self.run(*args, **kwargs)
666
713
 
667
714
    def run(self):
668
715
        """Actually run the command.
673
720
        Return 0 or None if the command was successful, or a non-zero
674
721
        shell error code if not.  It's OK for this method to allow
675
722
        an exception to raise up.
 
723
 
 
724
        This method is automatically wrapped by Command.__init__ with a 
 
725
        cleanup operation, stored as self._operation. This can be used
 
726
        via self.add_cleanup to perform automatic cleanups at the end of
 
727
        run().
 
728
 
 
729
        The argument for run are assembled by introspection. So for instance,
 
730
        if your command takes an argument files, you would declare::
 
731
 
 
732
            def run(self, files=None):
 
733
                pass
676
734
        """
677
735
        raise NotImplementedError('no implementation of command %r'
678
736
                                  % self.name())
895
953
    return ret
896
954
 
897
955
 
 
956
@deprecated_function(deprecated_in((2, 2, 0)))
898
957
def shlex_split_unicode(unsplit):
899
 
    import shlex
900
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
958
    return cmdline.split(unsplit)
901
959
 
902
960
 
903
961
def get_alias(cmd, config=None):
915
973
        config = bzrlib.config.GlobalConfig()
916
974
    alias = config.get_alias(cmd)
917
975
    if (alias):
918
 
        return shlex_split_unicode(alias)
 
976
        return cmdline.split(alias)
919
977
    return None
920
978
 
921
979
 
922
 
def run_bzr(argv):
 
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
923
981
    """Execute a command.
924
982
 
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.
 
983
    :param argv: The command-line arguments, without the program name from
 
984
        argv[0] These should already be decoded. All library/test code calling
 
985
        run_bzr should be passing valid strings (don't need decoding).
 
986
    :param load_plugins: What function to call when triggering plugin loading.
 
987
        This function should take no arguments and cause all plugins to be
 
988
        loaded.
 
989
    :param disable_plugins: What function to call when disabling plugin
 
990
        loading. This function should take no arguments and cause all plugin
 
991
        loading to be prohibited (so that code paths in your application that
 
992
        know about some plugins possibly being present will fail to import
 
993
        those plugins even if they are installed.)
 
994
    :return: Returns a command exit code or raises an exception.
931
995
 
932
996
    Special master options: these must come before the command because
933
997
    they control how the command is interpreted.
990
1054
        elif a == '--coverage':
991
1055
            opt_coverage_dir = argv[i + 1]
992
1056
            i += 1
 
1057
        elif a == '--profile-imports':
 
1058
            pass # already handled in startup script Bug #588277
993
1059
        elif a.startswith('-D'):
994
1060
            debug.debug_flags.add(a[2:])
995
1061
        else:
998
1064
 
999
1065
    debug.set_debug_flags_from_config()
1000
1066
 
 
1067
    if not opt_no_plugins:
 
1068
        load_plugins()
 
1069
    else:
 
1070
        disable_plugins()
 
1071
 
1001
1072
    argv = argv_copy
1002
1073
    if (not argv):
1003
 
        from bzrlib.builtins import cmd_help
1004
 
        cmd_help().run_argv_aliases([])
 
1074
        get_cmd_object('help').run_argv_aliases([])
1005
1075
        return 0
1006
1076
 
1007
1077
    if argv[0] == '--version':
1008
 
        from bzrlib.builtins import cmd_version
1009
 
        cmd_version().run_argv_aliases([])
 
1078
        get_cmd_object('version').run_argv_aliases([])
1010
1079
        return 0
1011
1080
 
1012
 
    if not opt_no_plugins:
1013
 
        from bzrlib.plugin import load_plugins
1014
 
        load_plugins()
1015
 
    else:
1016
 
        from bzrlib.plugin import disable_plugins
1017
 
        disable_plugins()
1018
 
 
1019
1081
    alias_argv = None
1020
1082
 
1021
1083
    if not opt_no_aliases:
1022
1084
        alias_argv = get_alias(argv[0])
1023
1085
        if alias_argv:
1024
 
            user_encoding = osutils.get_user_encoding()
1025
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1026
1086
            argv[0] = alias_argv.pop(0)
1027
1087
 
1028
1088
    cmd = argv.pop(0)
1029
 
    # We want only 'ascii' command names, but the user may have typed
1030
 
    # in a Unicode name. In that case, they should just get a
1031
 
    # 'command not found' error later.
1032
 
 
1033
1089
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1034
1090
    run = cmd_obj.run_argv_aliases
1035
1091
    run_argv = [argv, alias_argv]
1099
1155
        "bzr plugin-provider-db check")
1100
1156
 
1101
1157
 
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)
 
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.
1119
1162
    if argv is None:
1120
 
        argv = osutils.get_unicode_argv()
 
1163
        return osutils.get_unicode_argv()
1121
1164
    else:
1122
1165
        new_argv = []
1123
1166
        try:
1129
1172
                    new_argv.append(a.decode('ascii'))
1130
1173
        except UnicodeDecodeError:
1131
1174
            raise errors.BzrError("argv should be list of unicode strings.")
1132
 
        argv = new_argv
 
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()
1133
1192
    ret = run_bzr_catch_errors(argv)
1134
1193
    bzrlib.ui.ui_factory.log_transport_activity(
1135
1194
        display=('bytes' in debug.debug_flags))
1136
1195
    trace.mutter("return code %d", ret)
1137
 
    osutils.report_extension_load_failures()
1138
1196
    return ret
1139
1197
 
1140
1198
 
1144
1202
    This function assumed that that UI layer is setup, that symbol deprecations
1145
1203
    are already applied, and that unicode decoding has already been performed on argv.
1146
1204
    """
 
1205
    # done here so that they're covered for every test run
1147
1206
    install_bzr_command_hooks()
1148
1207
    return exception_to_return_code(run_bzr, argv)
1149
1208
 
1154
1213
    This is used for the test suite, and might be useful for other programs
1155
1214
    that want to wrap the commandline interface.
1156
1215
    """
 
1216
    # done here so that they're covered for every test run
1157
1217
    install_bzr_command_hooks()
1158
1218
    try:
1159
1219
        return run_bzr(argv)
1182
1242
        if topic and topic.startswith(self.prefix):
1183
1243
            topic = topic[len(self.prefix):]
1184
1244
        try:
1185
 
            cmd = _get_cmd_object(topic)
 
1245
            cmd = _get_cmd_object(topic, check_missing=False)
1186
1246
        except KeyError:
1187
1247
            return []
1188
1248
        else:
1209
1269
            yield provider
1210
1270
 
1211
1271
command_providers_registry = ProvidersRegistry()
1212
 
 
1213
 
 
1214
 
if __name__ == '__main__':
1215
 
    sys.exit(main(sys.argv))