← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-10 16:25:28 UTC
  • mfrom: (5020.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100210162528-00g29u0ex6vzv914
(gerard) Update performs two merges in a more logical order but stop
        on conflicts

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
 
    _register_builtin_commands()
226
 
    return builtin_command_registry.keys()
 
181
    return _builtin_commands().keys()
227
182
 
228
183
 
229
184
def plugin_command_names():
243
198
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
244
199
 
245
200
 
246
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
201
def _get_cmd_object(cmd_name, plugins_override=True):
247
202
    """Get a command object.
248
203
 
249
204
    :param cmd_name: The name of the command.
250
205
    :param plugins_override: Allow plugins to override builtins.
251
 
    :param check_missing: Look up commands not found in the regular index via
252
 
        the get_missing_command hook.
253
206
    :return: A Command object instance
254
207
    :raises KeyError: If no command is found.
255
208
    """
265
218
            # We've found a non-plugin command, don't permit it to be
266
219
            # overridden.
267
220
            break
268
 
    if cmd is None and check_missing:
 
221
    if cmd is None:
269
222
        for hook in Command.hooks['get_missing_command']:
270
223
            cmd = hook(cmd_name)
271
224
            if cmd is not None:
307
260
 
308
261
def _get_bzr_command(cmd_or_None, cmd_name):
309
262
    """Get a command from bzr's core."""
 
263
    cmds = _builtin_commands()
310
264
    try:
311
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
265
        return cmds[cmd_name]()
312
266
    except KeyError:
313
267
        pass
314
 
    else:
315
 
        return cmd_class()
 
268
    # look for any command which claims this as an alias
 
269
    for real_cmd_name, cmd_class in cmds.iteritems():
 
270
        if cmd_name in cmd_class.aliases:
 
271
            return cmd_class()
316
272
    return cmd_or_None
317
273
 
318
274
 
398
354
            will not mangled.
399
355
 
400
356
    :cvar hooks: An instance of CommandHooks.
401
 
    :ivar __doc__: The help shown by 'bzr help command' for this command.
402
 
        This is set by assigning explicitly to __doc__ so that -OO can
403
 
        be used::
404
 
 
405
 
        class Foo(Command):
406
 
            __doc__ = "My help goes here"
407
357
    """
408
358
    aliases = []
409
359
    takes_args = []
414
364
 
415
365
    def __init__(self):
416
366
        """Construct an instance of this command."""
 
367
        if self.__doc__ == Command.__doc__:
 
368
            warn("No help message set for %r" % self)
417
369
        # List of standard options directly supported
418
370
        self.supported_std_options = []
419
 
        self._setup_run()
420
 
 
 
371
        self._operation = cleanup.OperationWithCleanups(self.run)
 
372
    
421
373
    def add_cleanup(self, cleanup_func, *args, **kwargs):
422
374
        """Register a function to call after self.run returns or raises.
423
375
 
434
386
 
435
387
        This is useful for releasing expensive or contentious resources (such
436
388
        as write locks) before doing further work that does not require those
437
 
        resources (such as writing results to self.outf). Note though, that
438
 
        as it releases all resources, this may release locks that the command
439
 
        wants to hold, so use should be done with care.
 
389
        resources (such as writing results to self.outf).
440
390
        """
441
391
        self._operation.cleanup_now()
442
 
 
 
392
        
443
393
    @deprecated_method(deprecated_in((2, 1, 0)))
444
394
    def _maybe_expand_globs(self, file_list):
445
395
        """Glob expand file_list if the platform does not do that itself.
487
437
            message explaining how to obtain full help.
488
438
        """
489
439
        doc = self.help()
490
 
        if not doc:
491
 
            doc = "No help for this command."
 
440
        if doc is None:
 
441
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
442
 
493
443
        # Extract the summary (purpose) and sections out from the text
494
444
        purpose,sections,order = self._get_help_parts(doc)
687
637
 
688
638
        self._setup_outf()
689
639
 
690
 
        return self.run(**all_cmd_args)
691
 
 
692
 
    def _setup_run(self):
693
 
        """Wrap the defined run method on self with a cleanup.
694
 
 
695
 
        This is called by __init__ to make the Command be able to be run
696
 
        by just calling run(), as it could be before cleanups were added.
697
 
 
698
 
        If a different form of cleanups are in use by your Command subclass,
699
 
        you can override this method.
700
 
        """
701
 
        class_run = self.run
702
 
        def run(*args, **kwargs):
703
 
            self._operation = cleanup.OperationWithCleanups(class_run)
704
 
            try:
705
 
                return self._operation.run_simple(*args, **kwargs)
706
 
            finally:
707
 
                del self._operation
708
 
        self.run = run
709
 
 
710
 
    @deprecated_method(deprecated_in((2, 2, 0)))
 
640
        return self.run_direct(**all_cmd_args)
 
641
 
711
642
    def run_direct(self, *args, **kwargs):
712
 
        """Deprecated thunk from bzrlib 2.1."""
713
 
        return self.run(*args, **kwargs)
 
643
        """Call run directly with objects (without parsing an argv list)."""
 
644
        return self._operation.run_simple(*args, **kwargs)
714
645
 
715
646
    def run(self):
716
647
        """Actually run the command.
721
652
        Return 0 or None if the command was successful, or a non-zero
722
653
        shell error code if not.  It's OK for this method to allow
723
654
        an exception to raise up.
724
 
 
725
 
        This method is automatically wrapped by Command.__init__ with a 
726
 
        cleanup operation, stored as self._operation. This can be used
727
 
        via self.add_cleanup to perform automatic cleanups at the end of
728
 
        run().
729
 
 
730
 
        The argument for run are assembled by introspection. So for instance,
731
 
        if your command takes an argument files, you would declare::
732
 
 
733
 
            def run(self, files=None):
734
 
                pass
735
655
        """
736
656
        raise NotImplementedError('no implementation of command %r'
737
657
                                  % self.name())
954
874
    return ret
955
875
 
956
876
 
957
 
@deprecated_function(deprecated_in((2, 2, 0)))
958
877
def shlex_split_unicode(unsplit):
959
 
    return cmdline.split(unsplit)
 
878
    import shlex
 
879
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
960
880
 
961
881
 
962
882
def get_alias(cmd, config=None):
974
894
        config = bzrlib.config.GlobalConfig()
975
895
    alias = config.get_alias(cmd)
976
896
    if (alias):
977
 
        return cmdline.split(alias)
 
897
        return shlex_split_unicode(alias)
978
898
    return None
979
899
 
980
900
 
981
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
901
def run_bzr(argv):
982
902
    """Execute a command.
983
903
 
984
 
    :param argv: The command-line arguments, without the program name from
985
 
        argv[0] These should already be decoded. All library/test code calling
986
 
        run_bzr should be passing valid strings (don't need decoding).
987
 
    :param load_plugins: What function to call when triggering plugin loading.
988
 
        This function should take no arguments and cause all plugins to be
989
 
        loaded.
990
 
    :param disable_plugins: What function to call when disabling plugin
991
 
        loading. This function should take no arguments and cause all plugin
992
 
        loading to be prohibited (so that code paths in your application that
993
 
        know about some plugins possibly being present will fail to import
994
 
        those plugins even if they are installed.)
995
 
    :return: Returns a command exit code or raises an exception.
 
904
    argv
 
905
       The command-line arguments, without the program name from argv[0]
 
906
       These should already be decoded. All library/test code calling
 
907
       run_bzr should be passing valid strings (don't need decoding).
 
908
 
 
909
    Returns a command status or raises an exception.
996
910
 
997
911
    Special master options: these must come before the command because
998
912
    they control how the command is interpreted.
1055
969
        elif a == '--coverage':
1056
970
            opt_coverage_dir = argv[i + 1]
1057
971
            i += 1
1058
 
        elif a == '--profile-imports':
1059
 
            pass # already handled in startup script Bug #588277
1060
972
        elif a.startswith('-D'):
1061
973
            debug.debug_flags.add(a[2:])
1062
974
        else:
1065
977
 
1066
978
    debug.set_debug_flags_from_config()
1067
979
 
 
980
    argv = argv_copy
 
981
    if (not argv):
 
982
        from bzrlib.builtins import cmd_help
 
983
        cmd_help().run_argv_aliases([])
 
984
        return 0
 
985
 
 
986
    if argv[0] == '--version':
 
987
        from bzrlib.builtins import cmd_version
 
988
        cmd_version().run_argv_aliases([])
 
989
        return 0
 
990
 
1068
991
    if not opt_no_plugins:
 
992
        from bzrlib.plugin import load_plugins
1069
993
        load_plugins()
1070
994
    else:
 
995
        from bzrlib.plugin import disable_plugins
1071
996
        disable_plugins()
1072
997
 
1073
 
    argv = argv_copy
1074
 
    if (not argv):
1075
 
        get_cmd_object('help').run_argv_aliases([])
1076
 
        return 0
1077
 
 
1078
 
    if argv[0] == '--version':
1079
 
        get_cmd_object('version').run_argv_aliases([])
1080
 
        return 0
1081
 
 
1082
998
    alias_argv = None
1083
999
 
1084
1000
    if not opt_no_aliases:
1085
1001
        alias_argv = get_alias(argv[0])
1086
1002
        if alias_argv:
 
1003
            user_encoding = osutils.get_user_encoding()
 
1004
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1087
1005
            argv[0] = alias_argv.pop(0)
1088
1006
 
1089
1007
    cmd = argv.pop(0)
 
1008
    # We want only 'ascii' command names, but the user may have typed
 
1009
    # in a Unicode name. In that case, they should just get a
 
1010
    # 'command not found' error later.
 
1011
 
1090
1012
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
1013
    run = cmd_obj.run_argv_aliases
1092
1014
    run_argv = [argv, alias_argv]
1156
1078
        "bzr plugin-provider-db check")
1157
1079
 
1158
1080
 
1159
 
 
1160
 
def _specified_or_unicode_argv(argv):
1161
 
    # For internal or testing use, argv can be passed.  Otherwise, get it from
1162
 
    # the process arguments in a unicode-safe way.
 
1081
def main(argv=None):
 
1082
    """Main entry point of command-line interface.
 
1083
 
 
1084
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1085
        argv[0] is script name usually, it will be ignored.
 
1086
        Don't pass here sys.argv because this list contains plain strings
 
1087
        and not unicode; pass None instead.
 
1088
 
 
1089
    :return: exit code of bzr command.
 
1090
    """
 
1091
    import bzrlib.ui
 
1092
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
1093
        sys.stdin, sys.stdout, sys.stderr)
 
1094
 
 
1095
    # Is this a final release version? If so, we should suppress warnings
 
1096
    if bzrlib.version_info[3] == 'final':
 
1097
        suppress_deprecation_warnings(override=True)
1163
1098
    if argv is None:
1164
 
        return osutils.get_unicode_argv()
 
1099
        argv = osutils.get_unicode_argv()
1165
1100
    else:
1166
1101
        new_argv = []
1167
1102
        try:
1173
1108
                    new_argv.append(a.decode('ascii'))
1174
1109
        except UnicodeDecodeError:
1175
1110
            raise errors.BzrError("argv should be list of unicode strings.")
1176
 
        return new_argv
1177
 
 
1178
 
 
1179
 
def main(argv=None):
1180
 
    """Main entry point of command-line interface.
1181
 
 
1182
 
    Typically `bzrlib.initialize` should be called first.
1183
 
 
1184
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1185
 
        argv[0] is script name usually, it will be ignored.
1186
 
        Don't pass here sys.argv because this list contains plain strings
1187
 
        and not unicode; pass None instead.
1188
 
 
1189
 
    :return: exit code of bzr command.
1190
 
    """
1191
 
    argv = _specified_or_unicode_argv(argv)
1192
 
    _register_builtin_commands()
 
1111
        argv = new_argv
1193
1112
    ret = run_bzr_catch_errors(argv)
1194
1113
    bzrlib.ui.ui_factory.log_transport_activity(
1195
1114
        display=('bytes' in debug.debug_flags))
1196
1115
    trace.mutter("return code %d", ret)
 
1116
    osutils.report_extension_load_failures()
1197
1117
    return ret
1198
1118
 
1199
1119
 
1203
1123
    This function assumed that that UI layer is setup, that symbol deprecations
1204
1124
    are already applied, and that unicode decoding has already been performed on argv.
1205
1125
    """
1206
 
    # done here so that they're covered for every test run
1207
1126
    install_bzr_command_hooks()
1208
1127
    return exception_to_return_code(run_bzr, argv)
1209
1128
 
1214
1133
    This is used for the test suite, and might be useful for other programs
1215
1134
    that want to wrap the commandline interface.
1216
1135
    """
1217
 
    # done here so that they're covered for every test run
1218
1136
    install_bzr_command_hooks()
1219
1137
    try:
1220
1138
        return run_bzr(argv)
1243
1161
        if topic and topic.startswith(self.prefix):
1244
1162
            topic = topic[len(self.prefix):]
1245
1163
        try:
1246
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1164
            cmd = _get_cmd_object(topic)
1247
1165
        except KeyError:
1248
1166
            return []
1249
1167
        else:
1270
1188
            yield provider
1271
1189
 
1272
1190
command_providers_registry = ProvidersRegistry()
 
1191
 
 
1192
 
 
1193
if __name__ == '__main__':
 
1194
    sys.exit(main(sys.argv))