/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: Robert Collins
  • Date: 2010-05-04 06:22:51 UTC
  • mto: This revision was merged to the branch mainline in revision 5206.
  • Revision ID: robertc@robertcollins.net-20100504062251-1ocjhrl53mum9ehw
Minor local_abspath docstring improvement.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2006, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
 
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
 
40
34
 
41
35
import bzrlib
42
36
from bzrlib import (
 
37
    cleanup,
 
38
    cmdline,
43
39
    debug,
44
40
    errors,
45
41
    option,
53
49
from bzrlib.hooks import HookPoint, Hooks
54
50
# Compatibility - Option used to be in commands.
55
51
from bzrlib.option import Option
 
52
from bzrlib.plugin import disable_plugins, load_plugins
56
53
from bzrlib import registry
57
54
from bzrlib.symbol_versioning import (
58
55
    deprecated_function,
59
56
    deprecated_in,
60
57
    deprecated_method,
61
 
    suppress_deprecation_warnings,
62
58
    )
63
59
 
64
60
 
76
72
 
77
73
 
78
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)
79
91
 
80
92
    @staticmethod
81
93
    def _get_name(command_name):
97
109
        try:
98
110
            previous = self.get(k_unsquished)
99
111
        except KeyError:
100
 
            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
101
118
        info = CommandInfo.from_command(cmd)
102
119
        try:
103
120
            registry.Registry.register(self, k_unsquished, cmd,
108
125
                sys.modules[cmd.__module__])
109
126
            trace.warning('Previously this command was registered from %r' %
110
127
                sys.modules[previous.__module__])
 
128
        for a in cmd.aliases:
 
129
            self._alias_dict[a] = k_unsquished
111
130
        return previous
112
131
 
113
132
    def register_lazy(self, command_name, aliases, module_name):
120
139
        key = self._get_name(command_name)
121
140
        registry.Registry.register_lazy(self, key, module_name, command_name,
122
141
                                        info=CommandInfo(aliases))
 
142
        for a in aliases:
 
143
            self._alias_dict[a] = key
123
144
 
124
145
 
125
146
plugin_cmds = CommandRegistry()
 
147
builtin_command_registry = CommandRegistry()
 
148
plugin_cmds.overridden_registry = builtin_command_registry
126
149
 
127
150
 
128
151
def register_command(cmd, decorate=False):
 
152
    """Register a plugin command.
 
153
 
 
154
    Should generally be avoided in favor of lazy registration. 
 
155
    """
129
156
    global plugin_cmds
130
157
    return plugin_cmds.register(cmd, decorate)
131
158
 
138
165
    return cmd[4:].replace('_','-')
139
166
 
140
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
141
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
142
182
    import bzrlib.builtins
143
 
    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()
144
186
 
145
187
 
146
188
def _scan_module_for_commands(module):
153
195
 
154
196
 
155
197
def _list_bzr_commands(names):
156
 
    """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
    """
157
202
    # to eliminate duplicates
158
203
    names.update(builtin_command_names())
159
204
    names.update(plugin_command_names())
177
222
    Use of all_command_names() is encouraged rather than builtin_command_names
178
223
    and/or plugin_command_names.
179
224
    """
180
 
    return _builtin_commands().keys()
 
225
    return builtin_command_registry.keys()
181
226
 
182
227
 
183
228
def plugin_command_names():
185
230
    return plugin_cmds.keys()
186
231
 
187
232
 
188
 
@deprecated_function(deprecated_in((1, 17, 0)))
189
 
def get_all_cmds(plugins_override=False):
190
 
    """Return canonical name and class for most commands.
191
 
    
192
 
    NB: This does not return all commands since the introduction of
193
 
    command hooks, and returning the class is not sufficient to 
194
 
    get correctly setup commands, which is why it is deprecated.
195
 
 
196
 
    Use 'all_command_names' + 'get_cmd_object' instead.
197
 
    """
198
 
    d = _builtin_commands()
199
 
    if plugins_override:
200
 
        d.update(plugin_cmds.iteritems())
201
 
    for k, v in d.iteritems():
202
 
        yield k,v
203
 
 
204
 
 
205
233
def get_cmd_object(cmd_name, plugins_override=True):
206
234
    """Return the command object for a command.
207
235
 
214
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
243
 
216
244
 
217
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
218
246
    """Get a command object.
219
247
 
220
248
    :param cmd_name: The name of the command.
221
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.
222
252
    :return: A Command object instance
223
253
    :raises KeyError: If no command is found.
224
254
    """
234
264
            # We've found a non-plugin command, don't permit it to be
235
265
            # overridden.
236
266
            break
237
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
238
268
        for hook in Command.hooks['get_missing_command']:
239
269
            cmd = hook(cmd_name)
240
270
            if cmd is not None:
276
306
 
277
307
def _get_bzr_command(cmd_or_None, cmd_name):
278
308
    """Get a command from bzr's core."""
279
 
    cmds = _builtin_commands()
280
309
    try:
281
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
282
311
    except KeyError:
283
312
        pass
284
 
    # look for any command which claims this as an alias
285
 
    for real_cmd_name, cmd_class in cmds.iteritems():
286
 
        if cmd_name in cmd_class.aliases:
287
 
            return cmd_class()
 
313
    else:
 
314
        return cmd_class()
288
315
    return cmd_or_None
289
316
 
290
317
 
384
411
            warn("No help message set for %r" % self)
385
412
        # List of standard options directly supported
386
413
        self.supported_std_options = []
 
414
        self._setup_run()
 
415
 
 
416
    def add_cleanup(self, cleanup_func, *args, **kwargs):
 
417
        """Register a function to call after self.run returns or raises.
 
418
 
 
419
        Functions will be called in LIFO order.
 
420
        """
 
421
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
 
422
 
 
423
    def cleanup_now(self):
 
424
        """Execute and empty pending cleanup functions immediately.
 
425
 
 
426
        After cleanup_now all registered cleanups are forgotten.  add_cleanup
 
427
        may be called again after cleanup_now; these cleanups will be called
 
428
        after self.run returns or raises (or when cleanup_now is next called).
 
429
 
 
430
        This is useful for releasing expensive or contentious resources (such
 
431
        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.
 
435
        """
 
436
        self._operation.cleanup_now()
387
437
 
388
438
    @deprecated_method(deprecated_in((2, 1, 0)))
389
439
    def _maybe_expand_globs(self, file_list):
602
652
 
603
653
    def run_argv_aliases(self, argv, alias_argv=None):
604
654
        """Parse the command line and run with extra aliases in alias_argv."""
605
 
        if argv is None:
606
 
            warn("Passing None for [] is deprecated from bzrlib 0.10",
607
 
                 DeprecationWarning, stacklevel=2)
608
 
            argv = []
609
655
        args, opts = parse_args(self, argv, alias_argv)
610
656
 
611
657
        # Process the standard options
638
684
 
639
685
        return self.run(**all_cmd_args)
640
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)))
 
706
    def run_direct(self, *args, **kwargs):
 
707
        """Deprecated thunk from bzrlib 2.1."""
 
708
        return self.run(*args, **kwargs)
 
709
 
641
710
    def run(self):
642
711
        """Actually run the command.
643
712
 
647
716
        Return 0 or None if the command was successful, or a non-zero
648
717
        shell error code if not.  It's OK for this method to allow
649
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
650
730
        """
651
731
        raise NotImplementedError('no implementation of command %r'
652
732
                                  % self.name())
869
949
    return ret
870
950
 
871
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
872
953
def shlex_split_unicode(unsplit):
873
 
    import shlex
874
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
954
    return cmdline.split(unsplit)
875
955
 
876
956
 
877
957
def get_alias(cmd, config=None):
889
969
        config = bzrlib.config.GlobalConfig()
890
970
    alias = config.get_alias(cmd)
891
971
    if (alias):
892
 
        return shlex_split_unicode(alias)
 
972
        return cmdline.split(alias)
893
973
    return None
894
974
 
895
975
 
896
 
def run_bzr(argv):
 
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
897
977
    """Execute a command.
898
978
 
899
 
    argv
900
 
       The command-line arguments, without the program name from argv[0]
901
 
       These should already be decoded. All library/test code calling
902
 
       run_bzr should be passing valid strings (don't need decoding).
903
 
 
904
 
    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.
905
991
 
906
992
    Special master options: these must come before the command because
907
993
    they control how the command is interpreted.
928
1014
    --concurrency
929
1015
        Specify the number of processes that can be run concurrently (selftest).
930
1016
    """
 
1017
    trace.mutter("bazaar version: " + bzrlib.__version__)
931
1018
    argv = list(argv)
932
1019
    trace.mutter("bzr arguments: %r", argv)
933
1020
 
971
1058
 
972
1059
    debug.set_debug_flags_from_config()
973
1060
 
 
1061
    if not opt_no_plugins:
 
1062
        load_plugins()
 
1063
    else:
 
1064
        disable_plugins()
 
1065
 
974
1066
    argv = argv_copy
975
1067
    if (not argv):
976
 
        from bzrlib.builtins import cmd_help
977
 
        cmd_help().run_argv_aliases([])
 
1068
        get_cmd_object('help').run_argv_aliases([])
978
1069
        return 0
979
1070
 
980
1071
    if argv[0] == '--version':
981
 
        from bzrlib.builtins import cmd_version
982
 
        cmd_version().run_argv_aliases([])
 
1072
        get_cmd_object('version').run_argv_aliases([])
983
1073
        return 0
984
1074
 
985
 
    if not opt_no_plugins:
986
 
        from bzrlib.plugin import load_plugins
987
 
        load_plugins()
988
 
    else:
989
 
        from bzrlib.plugin import disable_plugins
990
 
        disable_plugins()
991
 
 
992
1075
    alias_argv = None
993
1076
 
994
1077
    if not opt_no_aliases:
1072
1155
        "bzr plugin-provider-db check")
1073
1156
 
1074
1157
 
1075
 
def main(argv=None):
1076
 
    """Main entry point of command-line interface.
1077
 
 
1078
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1079
 
        argv[0] is script name usually, it will be ignored.
1080
 
        Don't pass here sys.argv because this list contains plain strings
1081
 
        and not unicode; pass None instead.
1082
 
 
1083
 
    :return: exit code of bzr command.
1084
 
    """
1085
 
    import bzrlib.ui
1086
 
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1087
 
        sys.stdin, sys.stdout, sys.stderr)
1088
 
 
1089
 
    # Is this a final release version? If so, we should suppress warnings
1090
 
    if bzrlib.version_info[3] == 'final':
1091
 
        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.
1092
1162
    if argv is None:
1093
 
        argv = osutils.get_unicode_argv()
 
1163
        return osutils.get_unicode_argv()
1094
1164
    else:
1095
1165
        new_argv = []
1096
1166
        try:
1102
1172
                    new_argv.append(a.decode('ascii'))
1103
1173
        except UnicodeDecodeError:
1104
1174
            raise errors.BzrError("argv should be list of unicode strings.")
1105
 
        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()
1106
1192
    ret = run_bzr_catch_errors(argv)
 
1193
    bzrlib.ui.ui_factory.log_transport_activity(
 
1194
        display=('bytes' in debug.debug_flags))
1107
1195
    trace.mutter("return code %d", ret)
1108
 
    osutils.report_extension_load_failures()
1109
1196
    return ret
1110
1197
 
1111
1198
 
1115
1202
    This function assumed that that UI layer is setup, that symbol deprecations
1116
1203
    are already applied, and that unicode decoding has already been performed on argv.
1117
1204
    """
 
1205
    # done here so that they're covered for every test run
1118
1206
    install_bzr_command_hooks()
1119
1207
    return exception_to_return_code(run_bzr, argv)
1120
1208
 
1125
1213
    This is used for the test suite, and might be useful for other programs
1126
1214
    that want to wrap the commandline interface.
1127
1215
    """
 
1216
    # done here so that they're covered for every test run
1128
1217
    install_bzr_command_hooks()
1129
1218
    try:
1130
1219
        return run_bzr(argv)
1153
1242
        if topic and topic.startswith(self.prefix):
1154
1243
            topic = topic[len(self.prefix):]
1155
1244
        try:
1156
 
            cmd = _get_cmd_object(topic)
 
1245
            cmd = _get_cmd_object(topic, check_missing=False)
1157
1246
        except KeyError:
1158
1247
            return []
1159
1248
        else:
1180
1269
            yield provider
1181
1270
 
1182
1271
command_providers_registry = ProvidersRegistry()
1183
 
 
1184
 
 
1185
 
if __name__ == '__main__':
1186
 
    sys.exit(main(sys.argv))