~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2010-04-01 04:41:18 UTC
  • mto: This revision was merged to the branch mainline in revision 5128.
  • Revision ID: mbp@sourcefrog.net-20100401044118-shyctqc02ob08ngz
ignore .testrepository

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2008 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,
46
42
    osutils,
47
43
    trace,
 
44
    ui,
48
45
    win32utils,
49
46
    )
50
47
""")
52
49
from bzrlib.hooks import HookPoint, Hooks
53
50
# Compatibility - Option used to be in commands.
54
51
from bzrlib.option import Option
 
52
from bzrlib.plugin import disable_plugins, load_plugins
55
53
from bzrlib import registry
56
54
from bzrlib.symbol_versioning import (
57
55
    deprecated_function,
58
56
    deprecated_in,
59
 
    suppress_deprecation_warnings,
 
57
    deprecated_method,
60
58
    )
61
59
 
62
60
 
74
72
 
75
73
 
76
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)
77
91
 
78
92
    @staticmethod
79
93
    def _get_name(command_name):
95
109
        try:
96
110
            previous = self.get(k_unsquished)
97
111
        except KeyError:
98
 
            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
99
118
        info = CommandInfo.from_command(cmd)
100
119
        try:
101
120
            registry.Registry.register(self, k_unsquished, cmd,
102
121
                                       override_existing=decorate, info=info)
103
122
        except KeyError:
104
 
            trace.log_error('Two plugins defined the same command: %r' % k)
105
 
            trace.log_error('Not loading the one in %r' %
106
 
                            sys.modules[cmd.__module__])
107
 
            trace.log_error('Previously this command was registered from %r' %
108
 
                            sys.modules[previous.__module__])
 
123
            trace.warning('Two plugins defined the same command: %r' % k)
 
124
            trace.warning('Not loading the one in %r' %
 
125
                sys.modules[cmd.__module__])
 
126
            trace.warning('Previously this command was registered from %r' %
 
127
                sys.modules[previous.__module__])
 
128
        for a in cmd.aliases:
 
129
            self._alias_dict[a] = k_unsquished
109
130
        return previous
110
131
 
111
132
    def register_lazy(self, command_name, aliases, module_name):
118
139
        key = self._get_name(command_name)
119
140
        registry.Registry.register_lazy(self, key, module_name, command_name,
120
141
                                        info=CommandInfo(aliases))
 
142
        for a in aliases:
 
143
            self._alias_dict[a] = key
121
144
 
122
145
 
123
146
plugin_cmds = CommandRegistry()
 
147
builtin_command_registry = CommandRegistry()
 
148
plugin_cmds.overridden_registry = builtin_command_registry
124
149
 
125
150
 
126
151
def register_command(cmd, decorate=False):
 
152
    """Register a plugin command.
 
153
 
 
154
    Should generally be avoided in favor of lazy registration. 
 
155
    """
127
156
    global plugin_cmds
128
157
    return plugin_cmds.register(cmd, decorate)
129
158
 
136
165
    return cmd[4:].replace('_','-')
137
166
 
138
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
139
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
140
182
    import bzrlib.builtins
141
 
    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()
142
186
 
143
187
 
144
188
def _scan_module_for_commands(module):
151
195
 
152
196
 
153
197
def _list_bzr_commands(names):
154
 
    """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
    """
155
202
    # to eliminate duplicates
156
203
    names.update(builtin_command_names())
157
204
    names.update(plugin_command_names())
175
222
    Use of all_command_names() is encouraged rather than builtin_command_names
176
223
    and/or plugin_command_names.
177
224
    """
178
 
    return _builtin_commands().keys()
 
225
    return builtin_command_registry.keys()
179
226
 
180
227
 
181
228
def plugin_command_names():
183
230
    return plugin_cmds.keys()
184
231
 
185
232
 
186
 
@deprecated_function(deprecated_in((1, 17, 0)))
187
 
def get_all_cmds(plugins_override=False):
188
 
    """Return canonical name and class for most commands.
189
 
    
190
 
    NB: This does not return all commands since the introduction of
191
 
    command hooks, and returning the class is not sufficient to 
192
 
    get correctly setup commands, which is why it is deprecated.
193
 
 
194
 
    Use 'all_command_names' + 'get_cmd_object' instead.
195
 
    """
196
 
    d = _builtin_commands()
197
 
    if plugins_override:
198
 
        d.update(plugin_cmds.iteritems())
199
 
    for k, v in d.iteritems():
200
 
        yield k,v
201
 
 
202
 
 
203
233
def get_cmd_object(cmd_name, plugins_override=True):
204
234
    """Return the command object for a command.
205
235
 
212
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
213
243
 
214
244
 
215
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
216
246
    """Get a command object.
217
247
 
218
248
    :param cmd_name: The name of the command.
219
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.
220
252
    :return: A Command object instance
221
253
    :raises KeyError: If no command is found.
222
254
    """
232
264
            # We've found a non-plugin command, don't permit it to be
233
265
            # overridden.
234
266
            break
235
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
236
268
        for hook in Command.hooks['get_missing_command']:
237
269
            cmd = hook(cmd_name)
238
270
            if cmd is not None:
274
306
 
275
307
def _get_bzr_command(cmd_or_None, cmd_name):
276
308
    """Get a command from bzr's core."""
277
 
    cmds = _builtin_commands()
278
309
    try:
279
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
280
311
    except KeyError:
281
312
        pass
282
 
    # look for any command which claims this as an alias
283
 
    for real_cmd_name, cmd_class in cmds.iteritems():
284
 
        if cmd_name in cmd_class.aliases:
285
 
            return cmd_class()
 
313
    else:
 
314
        return cmd_class()
286
315
    return cmd_or_None
287
316
 
288
317
 
382
411
            warn("No help message set for %r" % self)
383
412
        # List of standard options directly supported
384
413
        self.supported_std_options = []
385
 
 
 
414
        self._operation = cleanup.OperationWithCleanups(self.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).
 
433
        """
 
434
        self._operation.cleanup_now()
 
435
 
 
436
    @deprecated_method(deprecated_in((2, 1, 0)))
386
437
    def _maybe_expand_globs(self, file_list):
387
438
        """Glob expand file_list if the platform does not do that itself.
388
439
 
 
440
        Not used anymore, now that the bzr command-line parser globs on
 
441
        Windows.
 
442
 
389
443
        :return: A possibly empty list of unicode paths.
390
444
 
391
445
        Introduced in bzrlib 0.18.
392
446
        """
393
 
        if not file_list:
394
 
            file_list = []
395
 
        if sys.platform == 'win32':
396
 
            file_list = win32utils.glob_expand(file_list)
397
 
        return list(file_list)
 
447
        return file_list
398
448
 
399
449
    def _usage(self):
400
450
        """Return single-line grammar for this command.
457
507
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
458
508
        # 20090319
459
509
        options = option.get_optparser(self.options()).format_option_help()
 
510
        # XXX: According to the spec, ReST option lists actually don't support 
 
511
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
512
        # As that pattern always appears in the commands that break, we trap
 
513
        # on that and then format that block of 'format' options as a literal
 
514
        # block.
 
515
        if not plain and options.find('  --1.9  ') != -1:
 
516
            options = options.replace(' format:\n', ' format::\n\n', 1)
460
517
        if options.startswith('Options:'):
461
518
            result += ':' + options
462
519
        elif options.startswith('options:'):
502
559
                        # so don't create a real link
503
560
                        see_also_links.append(item)
504
561
                    else:
505
 
                        # Use a reST link for this entry
506
 
                        see_also_links.append("`%s`_" % (item,))
 
562
                        # Use a Sphinx link for this entry
 
563
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
564
                        see_also_links.append(link_text)
507
565
                see_also = see_also_links
508
566
            result += ':See also: '
509
567
            result += ', '.join(see_also) + '\n'
587
645
 
588
646
    def _setup_outf(self):
589
647
        """Return a file linked to stdout, which has proper encoding."""
590
 
        # Originally I was using self.stdout, but that looks
591
 
        # *way* too much like sys.stdout
592
 
        if self.encoding_type == 'exact':
593
 
            # force sys.stdout to be binary stream on win32
594
 
            if sys.platform == 'win32':
595
 
                fileno = getattr(sys.stdout, 'fileno', None)
596
 
                if fileno:
597
 
                    import msvcrt
598
 
                    msvcrt.setmode(fileno(), os.O_BINARY)
599
 
            self.outf = sys.stdout
600
 
            return
601
 
 
602
 
        output_encoding = osutils.get_terminal_encoding()
603
 
 
604
 
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
605
 
                        errors=self.encoding_type)
606
 
        # For whatever reason codecs.getwriter() does not advertise its encoding
607
 
        # it just returns the encoding of the wrapped file, which is completely
608
 
        # bogus. So set the attribute, so we can find the correct encoding later.
609
 
        self.outf.encoding = output_encoding
 
648
        self.outf = ui.ui_factory.make_output_stream(
 
649
            encoding_type=self.encoding_type)
610
650
 
611
651
    def run_argv_aliases(self, argv, alias_argv=None):
612
652
        """Parse the command line and run with extra aliases in alias_argv."""
613
 
        if argv is None:
614
 
            warn("Passing None for [] is deprecated from bzrlib 0.10",
615
 
                 DeprecationWarning, stacklevel=2)
616
 
            argv = []
617
653
        args, opts = parse_args(self, argv, alias_argv)
618
654
 
619
655
        # Process the standard options
644
680
 
645
681
        self._setup_outf()
646
682
 
647
 
        return self.run(**all_cmd_args)
 
683
        return self.run_direct(**all_cmd_args)
 
684
 
 
685
    def run_direct(self, *args, **kwargs):
 
686
        """Call run directly with objects (without parsing an argv list)."""
 
687
        return self._operation.run_simple(*args, **kwargs)
648
688
 
649
689
    def run(self):
650
690
        """Actually run the command.
877
917
    return ret
878
918
 
879
919
 
 
920
@deprecated_function(deprecated_in((2, 2, 0)))
880
921
def shlex_split_unicode(unsplit):
881
 
    import shlex
882
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
922
    return cmdline.split(unsplit)
883
923
 
884
924
 
885
925
def get_alias(cmd, config=None):
897
937
        config = bzrlib.config.GlobalConfig()
898
938
    alias = config.get_alias(cmd)
899
939
    if (alias):
900
 
        return shlex_split_unicode(alias)
 
940
        return cmdline.split(alias)
901
941
    return None
902
942
 
903
943
 
904
 
def run_bzr(argv):
 
944
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
905
945
    """Execute a command.
906
946
 
907
 
    argv
908
 
       The command-line arguments, without the program name from argv[0]
909
 
       These should already be decoded. All library/test code calling
910
 
       run_bzr should be passing valid strings (don't need decoding).
911
 
 
912
 
    Returns a command status or raises an exception.
 
947
    :param argv: The command-line arguments, without the program name from
 
948
        argv[0] These should already be decoded. All library/test code calling
 
949
        run_bzr should be passing valid strings (don't need decoding).
 
950
    :param load_plugins: What function to call when triggering plugin loading.
 
951
        This function should take no arguments and cause all plugins to be
 
952
        loaded.
 
953
    :param disable_plugins: What function to call when disabling plugin
 
954
        loading. This function should take no arguments and cause all plugin
 
955
        loading to be prohibited (so that code paths in your application that
 
956
        know about some plugins possibly being present will fail to import
 
957
        those plugins even if they are installed.)
 
958
    :return: Returns a command exit code or raises an exception.
913
959
 
914
960
    Special master options: these must come before the command because
915
961
    they control how the command is interpreted.
932
978
 
933
979
    --coverage
934
980
        Generate line coverage report in the specified directory.
 
981
 
 
982
    --concurrency
 
983
        Specify the number of processes that can be run concurrently (selftest).
935
984
    """
 
985
    trace.mutter("bazaar version: " + bzrlib.__version__)
936
986
    argv = list(argv)
937
987
    trace.mutter("bzr arguments: %r", argv)
938
988
 
962
1012
            opt_no_aliases = True
963
1013
        elif a == '--builtin':
964
1014
            opt_builtin = True
 
1015
        elif a == '--concurrency':
 
1016
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
 
1017
            i += 1
965
1018
        elif a == '--coverage':
966
1019
            opt_coverage_dir = argv[i + 1]
967
1020
            i += 1
973
1026
 
974
1027
    debug.set_debug_flags_from_config()
975
1028
 
 
1029
    if not opt_no_plugins:
 
1030
        load_plugins()
 
1031
    else:
 
1032
        disable_plugins()
 
1033
 
976
1034
    argv = argv_copy
977
1035
    if (not argv):
978
 
        from bzrlib.builtins import cmd_help
979
 
        cmd_help().run_argv_aliases([])
 
1036
        get_cmd_object('help').run_argv_aliases([])
980
1037
        return 0
981
1038
 
982
1039
    if argv[0] == '--version':
983
 
        from bzrlib.builtins import cmd_version
984
 
        cmd_version().run_argv_aliases([])
 
1040
        get_cmd_object('version').run_argv_aliases([])
985
1041
        return 0
986
1042
 
987
 
    if not opt_no_plugins:
988
 
        from bzrlib.plugin import load_plugins
989
 
        load_plugins()
990
 
    else:
991
 
        from bzrlib.plugin import disable_plugins
992
 
        disable_plugins()
993
 
 
994
1043
    alias_argv = None
995
1044
 
996
1045
    if not opt_no_aliases:
1028
1077
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1029
1078
        else:
1030
1079
            ret = run(*run_argv)
1031
 
        if 'memory' in debug.debug_flags:
1032
 
            trace.debug_memory('Process status after command:', short=False)
1033
1080
        return ret or 0
1034
1081
    finally:
1035
1082
        # reset, in case we may do other commands later within the same
1036
1083
        # process. Commands that want to execute sub-commands must propagate
1037
1084
        # --verbose in their own way.
 
1085
        if 'memory' in debug.debug_flags:
 
1086
            trace.debug_memory('Process status after command:', short=False)
1038
1087
        option._verbosity_level = saved_verbosity_level
1039
1088
 
1040
1089
 
1074
1123
        "bzr plugin-provider-db check")
1075
1124
 
1076
1125
 
1077
 
def main(argv=None):
1078
 
    """Main entry point of command-line interface.
1079
 
 
1080
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1081
 
        argv[0] is script name usually, it will be ignored.
1082
 
        Don't pass here sys.argv because this list contains plain strings
1083
 
        and not unicode; pass None instead.
1084
 
 
1085
 
    :return: exit code of bzr command.
1086
 
    """
1087
 
    import bzrlib.ui
1088
 
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1089
 
        sys.stdin, sys.stdout, sys.stderr)
1090
 
 
1091
 
    # Is this a final release version? If so, we should suppress warnings
1092
 
    if bzrlib.version_info[3] == 'final':
1093
 
        suppress_deprecation_warnings(override=False)
 
1126
 
 
1127
def _specified_or_unicode_argv(argv):
 
1128
    # For internal or testing use, argv can be passed.  Otherwise, get it from
 
1129
    # the process arguments in a unicode-safe way.
1094
1130
    if argv is None:
1095
 
        argv = osutils.get_unicode_argv()
 
1131
        return osutils.get_unicode_argv()
1096
1132
    else:
1097
1133
        new_argv = []
1098
1134
        try:
1104
1140
                    new_argv.append(a.decode('ascii'))
1105
1141
        except UnicodeDecodeError:
1106
1142
            raise errors.BzrError("argv should be list of unicode strings.")
1107
 
        argv = new_argv
 
1143
        return new_argv
 
1144
 
 
1145
 
 
1146
def main(argv=None):
 
1147
    """Main entry point of command-line interface.
 
1148
 
 
1149
    Typically `bzrlib.initialize` should be called first.
 
1150
 
 
1151
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1152
        argv[0] is script name usually, it will be ignored.
 
1153
        Don't pass here sys.argv because this list contains plain strings
 
1154
        and not unicode; pass None instead.
 
1155
 
 
1156
    :return: exit code of bzr command.
 
1157
    """
 
1158
    argv = _specified_or_unicode_argv(argv)
 
1159
    _register_builtin_commands()
1108
1160
    ret = run_bzr_catch_errors(argv)
 
1161
    bzrlib.ui.ui_factory.log_transport_activity(
 
1162
        display=('bytes' in debug.debug_flags))
1109
1163
    trace.mutter("return code %d", ret)
1110
1164
    return ret
1111
1165
 
1116
1170
    This function assumed that that UI layer is setup, that symbol deprecations
1117
1171
    are already applied, and that unicode decoding has already been performed on argv.
1118
1172
    """
 
1173
    # done here so that they're covered for every test run
1119
1174
    install_bzr_command_hooks()
1120
1175
    return exception_to_return_code(run_bzr, argv)
1121
1176
 
1126
1181
    This is used for the test suite, and might be useful for other programs
1127
1182
    that want to wrap the commandline interface.
1128
1183
    """
 
1184
    # done here so that they're covered for every test run
1129
1185
    install_bzr_command_hooks()
1130
1186
    try:
1131
1187
        return run_bzr(argv)
1154
1210
        if topic and topic.startswith(self.prefix):
1155
1211
            topic = topic[len(self.prefix):]
1156
1212
        try:
1157
 
            cmd = _get_cmd_object(topic)
 
1213
            cmd = _get_cmd_object(topic, check_missing=False)
1158
1214
        except KeyError:
1159
1215
            return []
1160
1216
        else:
1181
1237
            yield provider
1182
1238
 
1183
1239
command_providers_registry = ProvidersRegistry()
1184
 
 
1185
 
 
1186
 
if __name__ == '__main__':
1187
 
    sys.exit(main(sys.argv))