/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: Martin
  • Date: 2010-05-03 20:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5204.
  • Revision ID: gzlist@googlemail.com-20100503205739-n326zdvevv0rmruh
Retain original stack and error message when translating to ValueError in bencode

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():
198
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
199
243
 
200
244
 
201
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
202
246
    """Get a command object.
203
247
 
204
248
    :param cmd_name: The name of the command.
205
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.
206
252
    :return: A Command object instance
207
253
    :raises KeyError: If no command is found.
208
254
    """
218
264
            # We've found a non-plugin command, don't permit it to be
219
265
            # overridden.
220
266
            break
221
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
222
268
        for hook in Command.hooks['get_missing_command']:
223
269
            cmd = hook(cmd_name)
224
270
            if cmd is not None:
260
306
 
261
307
def _get_bzr_command(cmd_or_None, cmd_name):
262
308
    """Get a command from bzr's core."""
263
 
    cmds = _builtin_commands()
264
309
    try:
265
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
266
311
    except KeyError:
267
312
        pass
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()
 
313
    else:
 
314
        return cmd_class()
272
315
    return cmd_or_None
273
316
 
274
317
 
368
411
            warn("No help message set for %r" % self)
369
412
        # List of standard options directly supported
370
413
        self.supported_std_options = []
371
 
        self._operation = cleanup.OperationWithCleanups(self.run)
372
 
    
 
414
        self._setup_run()
 
415
 
373
416
    def add_cleanup(self, cleanup_func, *args, **kwargs):
374
417
        """Register a function to call after self.run returns or raises.
375
418
 
386
429
 
387
430
        This is useful for releasing expensive or contentious resources (such
388
431
        as write locks) before doing further work that does not require those
389
 
        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.
390
435
        """
391
436
        self._operation.cleanup_now()
392
 
        
 
437
 
393
438
    @deprecated_method(deprecated_in((2, 1, 0)))
394
439
    def _maybe_expand_globs(self, file_list):
395
440
        """Glob expand file_list if the platform does not do that itself.
637
682
 
638
683
        self._setup_outf()
639
684
 
640
 
        return self.run_direct(**all_cmd_args)
641
 
 
 
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)))
642
706
    def run_direct(self, *args, **kwargs):
643
 
        """Call run directly with objects (without parsing an argv list)."""
644
 
        return self._operation.run_simple(*args, **kwargs)
 
707
        """Deprecated thunk from bzrlib 2.1."""
 
708
        return self.run(*args, **kwargs)
645
709
 
646
710
    def run(self):
647
711
        """Actually run the command.
652
716
        Return 0 or None if the command was successful, or a non-zero
653
717
        shell error code if not.  It's OK for this method to allow
654
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
655
730
        """
656
731
        raise NotImplementedError('no implementation of command %r'
657
732
                                  % self.name())
874
949
    return ret
875
950
 
876
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
877
953
def shlex_split_unicode(unsplit):
878
 
    import shlex
879
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
954
    return cmdline.split(unsplit)
880
955
 
881
956
 
882
957
def get_alias(cmd, config=None):
894
969
        config = bzrlib.config.GlobalConfig()
895
970
    alias = config.get_alias(cmd)
896
971
    if (alias):
897
 
        return shlex_split_unicode(alias)
 
972
        return cmdline.split(alias)
898
973
    return None
899
974
 
900
975
 
901
 
def run_bzr(argv):
 
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
902
977
    """Execute a command.
903
978
 
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.
 
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.
910
991
 
911
992
    Special master options: these must come before the command because
912
993
    they control how the command is interpreted.
977
1058
 
978
1059
    debug.set_debug_flags_from_config()
979
1060
 
 
1061
    if not opt_no_plugins:
 
1062
        load_plugins()
 
1063
    else:
 
1064
        disable_plugins()
 
1065
 
980
1066
    argv = argv_copy
981
1067
    if (not argv):
982
 
        from bzrlib.builtins import cmd_help
983
 
        cmd_help().run_argv_aliases([])
 
1068
        get_cmd_object('help').run_argv_aliases([])
984
1069
        return 0
985
1070
 
986
1071
    if argv[0] == '--version':
987
 
        from bzrlib.builtins import cmd_version
988
 
        cmd_version().run_argv_aliases([])
 
1072
        get_cmd_object('version').run_argv_aliases([])
989
1073
        return 0
990
1074
 
991
 
    if not opt_no_plugins:
992
 
        from bzrlib.plugin import load_plugins
993
 
        load_plugins()
994
 
    else:
995
 
        from bzrlib.plugin import disable_plugins
996
 
        disable_plugins()
997
 
 
998
1075
    alias_argv = None
999
1076
 
1000
1077
    if not opt_no_aliases:
1078
1155
        "bzr plugin-provider-db check")
1079
1156
 
1080
1157
 
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)
 
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
1162
    if argv is None:
1099
 
        argv = osutils.get_unicode_argv()
 
1163
        return osutils.get_unicode_argv()
1100
1164
    else:
1101
1165
        new_argv = []
1102
1166
        try:
1108
1172
                    new_argv.append(a.decode('ascii'))
1109
1173
        except UnicodeDecodeError:
1110
1174
            raise errors.BzrError("argv should be list of unicode strings.")
1111
 
        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()
1112
1192
    ret = run_bzr_catch_errors(argv)
1113
1193
    bzrlib.ui.ui_factory.log_transport_activity(
1114
1194
        display=('bytes' in debug.debug_flags))
1115
1195
    trace.mutter("return code %d", ret)
1116
 
    osutils.report_extension_load_failures()
1117
1196
    return ret
1118
1197
 
1119
1198
 
1123
1202
    This function assumed that that UI layer is setup, that symbol deprecations
1124
1203
    are already applied, and that unicode decoding has already been performed on argv.
1125
1204
    """
 
1205
    # done here so that they're covered for every test run
1126
1206
    install_bzr_command_hooks()
1127
1207
    return exception_to_return_code(run_bzr, argv)
1128
1208
 
1133
1213
    This is used for the test suite, and might be useful for other programs
1134
1214
    that want to wrap the commandline interface.
1135
1215
    """
 
1216
    # done here so that they're covered for every test run
1136
1217
    install_bzr_command_hooks()
1137
1218
    try:
1138
1219
        return run_bzr(argv)
1161
1242
        if topic and topic.startswith(self.prefix):
1162
1243
            topic = topic[len(self.prefix):]
1163
1244
        try:
1164
 
            cmd = _get_cmd_object(topic)
 
1245
            cmd = _get_cmd_object(topic, check_missing=False)
1165
1246
        except KeyError:
1166
1247
            return []
1167
1248
        else:
1188
1269
            yield provider
1189
1270
 
1190
1271
command_providers_registry = ProvidersRegistry()
1191
 
 
1192
 
 
1193
 
if __name__ == '__main__':
1194
 
    sys.exit(main(sys.argv))