/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: Vincent Ladeuil
  • Date: 2010-01-25 17:48:22 UTC
  • mto: (4987.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4988.
  • Revision ID: v.ladeuil+lp@free.fr-20100125174822-nce4l19sbwx83jvq
Deploying the new overrideAttr facility further reduces the complexity
and make the code clearer.

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():
231
186
    return plugin_cmds.keys()
232
187
 
233
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
 
234
206
def get_cmd_object(cmd_name, plugins_override=True):
235
207
    """Return the command object for a command.
236
208
 
243
215
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
244
216
 
245
217
 
246
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
218
def _get_cmd_object(cmd_name, plugins_override=True):
247
219
    """Get a command object.
248
220
 
249
221
    :param cmd_name: The name of the command.
250
222
    :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
223
    :return: A Command object instance
254
224
    :raises KeyError: If no command is found.
255
225
    """
265
235
            # We've found a non-plugin command, don't permit it to be
266
236
            # overridden.
267
237
            break
268
 
    if cmd is None and check_missing:
 
238
    if cmd is None:
269
239
        for hook in Command.hooks['get_missing_command']:
270
240
            cmd = hook(cmd_name)
271
241
            if cmd is not None:
307
277
 
308
278
def _get_bzr_command(cmd_or_None, cmd_name):
309
279
    """Get a command from bzr's core."""
 
280
    cmds = _builtin_commands()
310
281
    try:
311
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
282
        return cmds[cmd_name]()
312
283
    except KeyError:
313
284
        pass
314
 
    else:
315
 
        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()
316
289
    return cmd_or_None
317
290
 
318
291
 
398
371
            will not mangled.
399
372
 
400
373
    :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
374
    """
408
375
    aliases = []
409
376
    takes_args = []
414
381
 
415
382
    def __init__(self):
416
383
        """Construct an instance of this command."""
 
384
        if self.__doc__ == Command.__doc__:
 
385
            warn("No help message set for %r" % self)
417
386
        # List of standard options directly supported
418
387
        self.supported_std_options = []
419
 
        self._setup_run()
420
 
 
 
388
        self._operation = cleanup.OperationWithCleanups(self.run)
 
389
    
421
390
    def add_cleanup(self, cleanup_func, *args, **kwargs):
422
391
        """Register a function to call after self.run returns or raises.
423
392
 
434
403
 
435
404
        This is useful for releasing expensive or contentious resources (such
436
405
        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.
 
406
        resources (such as writing results to self.outf).
440
407
        """
441
408
        self._operation.cleanup_now()
442
 
 
 
409
        
443
410
    @deprecated_method(deprecated_in((2, 1, 0)))
444
411
    def _maybe_expand_globs(self, file_list):
445
412
        """Glob expand file_list if the platform does not do that itself.
487
454
            message explaining how to obtain full help.
488
455
        """
489
456
        doc = self.help()
490
 
        if not doc:
491
 
            doc = "No help for this command."
 
457
        if doc is None:
 
458
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
459
 
493
460
        # Extract the summary (purpose) and sections out from the text
494
461
        purpose,sections,order = self._get_help_parts(doc)
657
624
 
658
625
    def run_argv_aliases(self, argv, alias_argv=None):
659
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 = []
660
631
        args, opts = parse_args(self, argv, alias_argv)
661
632
 
662
633
        # Process the standard options
687
658
 
688
659
        self._setup_outf()
689
660
 
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)))
 
661
        return self.run_direct(**all_cmd_args)
 
662
 
711
663
    def run_direct(self, *args, **kwargs):
712
 
        """Deprecated thunk from bzrlib 2.1."""
713
 
        return self.run(*args, **kwargs)
 
664
        """Call run directly with objects (without parsing an argv list)."""
 
665
        return self._operation.run_simple(*args, **kwargs)
714
666
 
715
667
    def run(self):
716
668
        """Actually run the command.
721
673
        Return 0 or None if the command was successful, or a non-zero
722
674
        shell error code if not.  It's OK for this method to allow
723
675
        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
676
        """
736
677
        raise NotImplementedError('no implementation of command %r'
737
678
                                  % self.name())
954
895
    return ret
955
896
 
956
897
 
957
 
@deprecated_function(deprecated_in((2, 2, 0)))
958
898
def shlex_split_unicode(unsplit):
959
 
    return cmdline.split(unsplit)
 
899
    import shlex
 
900
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
960
901
 
961
902
 
962
903
def get_alias(cmd, config=None):
974
915
        config = bzrlib.config.GlobalConfig()
975
916
    alias = config.get_alias(cmd)
976
917
    if (alias):
977
 
        return cmdline.split(alias)
 
918
        return shlex_split_unicode(alias)
978
919
    return None
979
920
 
980
921
 
981
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
922
def run_bzr(argv):
982
923
    """Execute a command.
983
924
 
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.
 
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.
996
931
 
997
932
    Special master options: these must come before the command because
998
933
    they control how the command is interpreted.
1055
990
        elif a == '--coverage':
1056
991
            opt_coverage_dir = argv[i + 1]
1057
992
            i += 1
1058
 
        elif a == '--profile-imports':
1059
 
            pass # already handled in startup script Bug #588277
1060
993
        elif a.startswith('-D'):
1061
994
            debug.debug_flags.add(a[2:])
1062
995
        else:
1065
998
 
1066
999
    debug.set_debug_flags_from_config()
1067
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
 
1068
1012
    if not opt_no_plugins:
 
1013
        from bzrlib.plugin import load_plugins
1069
1014
        load_plugins()
1070
1015
    else:
 
1016
        from bzrlib.plugin import disable_plugins
1071
1017
        disable_plugins()
1072
1018
 
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
1019
    alias_argv = None
1083
1020
 
1084
1021
    if not opt_no_aliases:
1085
1022
        alias_argv = get_alias(argv[0])
1086
1023
        if alias_argv:
 
1024
            user_encoding = osutils.get_user_encoding()
 
1025
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1087
1026
            argv[0] = alias_argv.pop(0)
1088
1027
 
1089
1028
    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
 
1090
1033
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
1034
    run = cmd_obj.run_argv_aliases
1092
1035
    run_argv = [argv, alias_argv]
1156
1099
        "bzr plugin-provider-db check")
1157
1100
 
1158
1101
 
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.
 
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)
1163
1119
    if argv is None:
1164
 
        return osutils.get_unicode_argv()
 
1120
        argv = osutils.get_unicode_argv()
1165
1121
    else:
1166
1122
        new_argv = []
1167
1123
        try:
1173
1129
                    new_argv.append(a.decode('ascii'))
1174
1130
        except UnicodeDecodeError:
1175
1131
            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()
 
1132
        argv = new_argv
1193
1133
    ret = run_bzr_catch_errors(argv)
1194
1134
    bzrlib.ui.ui_factory.log_transport_activity(
1195
1135
        display=('bytes' in debug.debug_flags))
1196
1136
    trace.mutter("return code %d", ret)
 
1137
    osutils.report_extension_load_failures()
1197
1138
    return ret
1198
1139
 
1199
1140
 
1203
1144
    This function assumed that that UI layer is setup, that symbol deprecations
1204
1145
    are already applied, and that unicode decoding has already been performed on argv.
1205
1146
    """
1206
 
    # done here so that they're covered for every test run
1207
1147
    install_bzr_command_hooks()
1208
1148
    return exception_to_return_code(run_bzr, argv)
1209
1149
 
1214
1154
    This is used for the test suite, and might be useful for other programs
1215
1155
    that want to wrap the commandline interface.
1216
1156
    """
1217
 
    # done here so that they're covered for every test run
1218
1157
    install_bzr_command_hooks()
1219
1158
    try:
1220
1159
        return run_bzr(argv)
1243
1182
        if topic and topic.startswith(self.prefix):
1244
1183
            topic = topic[len(self.prefix):]
1245
1184
        try:
1246
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1185
            cmd = _get_cmd_object(topic)
1247
1186
        except KeyError:
1248
1187
            return []
1249
1188
        else:
1270
1209
            yield provider
1271
1210
 
1272
1211
command_providers_registry = ProvidersRegistry()
 
1212
 
 
1213
 
 
1214
if __name__ == '__main__':
 
1215
    sys.exit(main(sys.argv))