/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: Canonical.com Patch Queue Manager
  • Date: 2009-12-18 10:09:49 UTC
  • mfrom: (4871.5.4 admin-guide-submit)
  • Revision ID: pqm@pqm.ubuntu.com-20091218100949-2c1ityvnbqjtdf3g
(nmb) Add backup section to admin-guide

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
 
34
40
 
35
41
import bzrlib
36
42
from bzrlib import (
37
 
    cleanup,
38
 
    cmdline,
39
43
    debug,
40
44
    errors,
41
45
    option,
49
53
from bzrlib.hooks import HookPoint, Hooks
50
54
# Compatibility - Option used to be in commands.
51
55
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
56
from bzrlib import registry
54
57
from bzrlib.symbol_versioning import (
55
58
    deprecated_function,
56
59
    deprecated_in,
57
60
    deprecated_method,
 
61
    suppress_deprecation_warnings,
58
62
    )
59
63
 
60
64
 
72
76
 
73
77
 
74
78
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
79
 
92
80
    @staticmethod
93
81
    def _get_name(command_name):
109
97
        try:
110
98
            previous = self.get(k_unsquished)
111
99
        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
 
100
            previous = _builtin_commands().get(k_unsquished)
118
101
        info = CommandInfo.from_command(cmd)
119
102
        try:
120
103
            registry.Registry.register(self, k_unsquished, cmd,
125
108
                sys.modules[cmd.__module__])
126
109
            trace.warning('Previously this command was registered from %r' %
127
110
                sys.modules[previous.__module__])
128
 
        for a in cmd.aliases:
129
 
            self._alias_dict[a] = k_unsquished
130
111
        return previous
131
112
 
132
113
    def register_lazy(self, command_name, aliases, module_name):
139
120
        key = self._get_name(command_name)
140
121
        registry.Registry.register_lazy(self, key, module_name, command_name,
141
122
                                        info=CommandInfo(aliases))
142
 
        for a in aliases:
143
 
            self._alias_dict[a] = key
144
123
 
145
124
 
146
125
plugin_cmds = CommandRegistry()
147
 
builtin_command_registry = CommandRegistry()
148
 
plugin_cmds.overridden_registry = builtin_command_registry
149
126
 
150
127
 
151
128
def register_command(cmd, decorate=False):
152
 
    """Register a plugin command.
153
 
 
154
 
    Should generally be avoided in favor of lazy registration. 
155
 
    """
156
129
    global plugin_cmds
157
130
    return plugin_cmds.register(cmd, decorate)
158
131
 
165
138
    return cmd[4:].replace('_','-')
166
139
 
167
140
 
168
 
@deprecated_function(deprecated_in((2, 2, 0)))
169
141
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
142
    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()
 
143
    return _scan_module_for_commands(bzrlib.builtins)
186
144
 
187
145
 
188
146
def _scan_module_for_commands(module):
195
153
 
196
154
 
197
155
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
 
    """
 
156
    """Find commands from bzr's core and plugins."""
202
157
    # to eliminate duplicates
203
158
    names.update(builtin_command_names())
204
159
    names.update(plugin_command_names())
222
177
    Use of all_command_names() is encouraged rather than builtin_command_names
223
178
    and/or plugin_command_names.
224
179
    """
225
 
    _register_builtin_commands()
226
 
    return builtin_command_registry.keys()
 
180
    return _builtin_commands().keys()
227
181
 
228
182
 
229
183
def plugin_command_names():
231
185
    return plugin_cmds.keys()
232
186
 
233
187
 
 
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
 
234
205
def get_cmd_object(cmd_name, plugins_override=True):
235
206
    """Return the command object for a command.
236
207
 
243
214
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
244
215
 
245
216
 
246
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
217
def _get_cmd_object(cmd_name, plugins_override=True):
247
218
    """Get a command object.
248
219
 
249
220
    :param cmd_name: The name of the command.
250
221
    :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
222
    :return: A Command object instance
254
223
    :raises KeyError: If no command is found.
255
224
    """
265
234
            # We've found a non-plugin command, don't permit it to be
266
235
            # overridden.
267
236
            break
268
 
    if cmd is None and check_missing:
 
237
    if cmd is None:
269
238
        for hook in Command.hooks['get_missing_command']:
270
239
            cmd = hook(cmd_name)
271
240
            if cmd is not None:
307
276
 
308
277
def _get_bzr_command(cmd_or_None, cmd_name):
309
278
    """Get a command from bzr's core."""
 
279
    cmds = _builtin_commands()
310
280
    try:
311
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
281
        return cmds[cmd_name]()
312
282
    except KeyError:
313
283
        pass
314
 
    else:
315
 
        return cmd_class()
 
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()
316
288
    return cmd_or_None
317
289
 
318
290
 
398
370
            will not mangled.
399
371
 
400
372
    :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
373
    """
408
374
    aliases = []
409
375
    takes_args = []
414
380
 
415
381
    def __init__(self):
416
382
        """Construct an instance of this command."""
 
383
        if self.__doc__ == Command.__doc__:
 
384
            warn("No help message set for %r" % self)
417
385
        # List of standard options directly supported
418
386
        self.supported_std_options = []
419
 
        self._setup_run()
420
 
 
421
 
    def add_cleanup(self, cleanup_func, *args, **kwargs):
422
 
        """Register a function to call after self.run returns or raises.
423
 
 
424
 
        Functions will be called in LIFO order.
425
 
        """
426
 
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
 
 
428
 
    def cleanup_now(self):
429
 
        """Execute and empty pending cleanup functions immediately.
430
 
 
431
 
        After cleanup_now all registered cleanups are forgotten.  add_cleanup
432
 
        may be called again after cleanup_now; these cleanups will be called
433
 
        after self.run returns or raises (or when cleanup_now is next called).
434
 
 
435
 
        This is useful for releasing expensive or contentious resources (such
436
 
        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.
440
 
        """
441
 
        self._operation.cleanup_now()
442
387
 
443
388
    @deprecated_method(deprecated_in((2, 1, 0)))
444
389
    def _maybe_expand_globs(self, file_list):
487
432
            message explaining how to obtain full help.
488
433
        """
489
434
        doc = self.help()
490
 
        if not doc:
491
 
            doc = "No help for this command."
 
435
        if doc is None:
 
436
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
437
 
493
438
        # Extract the summary (purpose) and sections out from the text
494
439
        purpose,sections,order = self._get_help_parts(doc)
566
511
                        # so don't create a real link
567
512
                        see_also_links.append(item)
568
513
                    else:
569
 
                        # Use a Sphinx link for this entry
570
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
571
 
                        see_also_links.append(link_text)
 
514
                        # Use a reST link for this entry
 
515
                        see_also_links.append("`%s`_" % (item,))
572
516
                see_also = see_also_links
573
517
            result += ':See also: '
574
518
            result += ', '.join(see_also) + '\n'
657
601
 
658
602
    def run_argv_aliases(self, argv, alias_argv=None):
659
603
        """Parse the command line and run with extra aliases in alias_argv."""
 
604
        if argv is None:
 
605
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
606
                 DeprecationWarning, stacklevel=2)
 
607
            argv = []
660
608
        args, opts = parse_args(self, argv, alias_argv)
661
609
 
662
610
        # Process the standard options
689
637
 
690
638
        return self.run(**all_cmd_args)
691
639
 
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)))
711
 
    def run_direct(self, *args, **kwargs):
712
 
        """Deprecated thunk from bzrlib 2.1."""
713
 
        return self.run(*args, **kwargs)
714
 
 
715
640
    def run(self):
716
641
        """Actually run the command.
717
642
 
721
646
        Return 0 or None if the command was successful, or a non-zero
722
647
        shell error code if not.  It's OK for this method to allow
723
648
        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
649
        """
736
650
        raise NotImplementedError('no implementation of command %r'
737
651
                                  % self.name())
954
868
    return ret
955
869
 
956
870
 
957
 
@deprecated_function(deprecated_in((2, 2, 0)))
958
871
def shlex_split_unicode(unsplit):
959
 
    return cmdline.split(unsplit)
 
872
    import shlex
 
873
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
960
874
 
961
875
 
962
876
def get_alias(cmd, config=None):
974
888
        config = bzrlib.config.GlobalConfig()
975
889
    alias = config.get_alias(cmd)
976
890
    if (alias):
977
 
        return cmdline.split(alias)
 
891
        return shlex_split_unicode(alias)
978
892
    return None
979
893
 
980
894
 
981
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
895
def run_bzr(argv):
982
896
    """Execute a command.
983
897
 
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.
 
898
    argv
 
899
       The command-line arguments, without the program name from argv[0]
 
900
       These should already be decoded. All library/test code calling
 
901
       run_bzr should be passing valid strings (don't need decoding).
 
902
 
 
903
    Returns a command status or raises an exception.
996
904
 
997
905
    Special master options: these must come before the command because
998
906
    they control how the command is interpreted.
1019
927
    --concurrency
1020
928
        Specify the number of processes that can be run concurrently (selftest).
1021
929
    """
1022
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
1023
930
    argv = list(argv)
1024
931
    trace.mutter("bzr arguments: %r", argv)
1025
932
 
1055
962
        elif a == '--coverage':
1056
963
            opt_coverage_dir = argv[i + 1]
1057
964
            i += 1
1058
 
        elif a == '--profile-imports':
1059
 
            pass # already handled in startup script Bug #588277
1060
965
        elif a.startswith('-D'):
1061
966
            debug.debug_flags.add(a[2:])
1062
967
        else:
1065
970
 
1066
971
    debug.set_debug_flags_from_config()
1067
972
 
 
973
    argv = argv_copy
 
974
    if (not argv):
 
975
        from bzrlib.builtins import cmd_help
 
976
        cmd_help().run_argv_aliases([])
 
977
        return 0
 
978
 
 
979
    if argv[0] == '--version':
 
980
        from bzrlib.builtins import cmd_version
 
981
        cmd_version().run_argv_aliases([])
 
982
        return 0
 
983
 
1068
984
    if not opt_no_plugins:
 
985
        from bzrlib.plugin import load_plugins
1069
986
        load_plugins()
1070
987
    else:
 
988
        from bzrlib.plugin import disable_plugins
1071
989
        disable_plugins()
1072
990
 
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
991
    alias_argv = None
1083
992
 
1084
993
    if not opt_no_aliases:
1085
994
        alias_argv = get_alias(argv[0])
1086
995
        if alias_argv:
 
996
            user_encoding = osutils.get_user_encoding()
 
997
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1087
998
            argv[0] = alias_argv.pop(0)
1088
999
 
1089
1000
    cmd = argv.pop(0)
 
1001
    # We want only 'ascii' command names, but the user may have typed
 
1002
    # in a Unicode name. In that case, they should just get a
 
1003
    # 'command not found' error later.
 
1004
 
1090
1005
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
1006
    run = cmd_obj.run_argv_aliases
1092
1007
    run_argv = [argv, alias_argv]
1156
1071
        "bzr plugin-provider-db check")
1157
1072
 
1158
1073
 
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.
 
1074
def main(argv=None):
 
1075
    """Main entry point of command-line interface.
 
1076
 
 
1077
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1078
        argv[0] is script name usually, it will be ignored.
 
1079
        Don't pass here sys.argv because this list contains plain strings
 
1080
        and not unicode; pass None instead.
 
1081
 
 
1082
    :return: exit code of bzr command.
 
1083
    """
 
1084
    import bzrlib.ui
 
1085
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
1086
        sys.stdin, sys.stdout, sys.stderr)
 
1087
 
 
1088
    # Is this a final release version? If so, we should suppress warnings
 
1089
    if bzrlib.version_info[3] == 'final':
 
1090
        suppress_deprecation_warnings(override=True)
1163
1091
    if argv is None:
1164
 
        return osutils.get_unicode_argv()
 
1092
        argv = osutils.get_unicode_argv()
1165
1093
    else:
1166
1094
        new_argv = []
1167
1095
        try:
1173
1101
                    new_argv.append(a.decode('ascii'))
1174
1102
        except UnicodeDecodeError:
1175
1103
            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()
 
1104
        argv = new_argv
1193
1105
    ret = run_bzr_catch_errors(argv)
1194
 
    bzrlib.ui.ui_factory.log_transport_activity(
1195
 
        display=('bytes' in debug.debug_flags))
1196
1106
    trace.mutter("return code %d", ret)
 
1107
    osutils.report_extension_load_failures()
1197
1108
    return ret
1198
1109
 
1199
1110
 
1203
1114
    This function assumed that that UI layer is setup, that symbol deprecations
1204
1115
    are already applied, and that unicode decoding has already been performed on argv.
1205
1116
    """
1206
 
    # done here so that they're covered for every test run
1207
1117
    install_bzr_command_hooks()
1208
1118
    return exception_to_return_code(run_bzr, argv)
1209
1119
 
1214
1124
    This is used for the test suite, and might be useful for other programs
1215
1125
    that want to wrap the commandline interface.
1216
1126
    """
1217
 
    # done here so that they're covered for every test run
1218
1127
    install_bzr_command_hooks()
1219
1128
    try:
1220
1129
        return run_bzr(argv)
1243
1152
        if topic and topic.startswith(self.prefix):
1244
1153
            topic = topic[len(self.prefix):]
1245
1154
        try:
1246
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1155
            cmd = _get_cmd_object(topic)
1247
1156
        except KeyError:
1248
1157
            return []
1249
1158
        else:
1270
1179
            yield provider
1271
1180
 
1272
1181
command_providers_registry = ProvidersRegistry()
 
1182
 
 
1183
 
 
1184
if __name__ == '__main__':
 
1185
    sys.exit(main(sys.argv))