← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

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,
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():
197
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
198
243
 
199
244
 
200
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
201
246
    """Get a command object.
202
247
 
203
248
    :param cmd_name: The name of the command.
204
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.
205
252
    :return: A Command object instance
206
253
    :raises KeyError: If no command is found.
207
254
    """
217
264
            # We've found a non-plugin command, don't permit it to be
218
265
            # overridden.
219
266
            break
220
 
    if cmd is None:
 
267
    if cmd is None and check_missing:
221
268
        for hook in Command.hooks['get_missing_command']:
222
269
            cmd = hook(cmd_name)
223
270
            if cmd is not None:
259
306
 
260
307
def _get_bzr_command(cmd_or_None, cmd_name):
261
308
    """Get a command from bzr's core."""
262
 
    cmds = _builtin_commands()
263
309
    try:
264
 
        return cmds[cmd_name]()
 
310
        cmd_class = builtin_command_registry.get(cmd_name)
265
311
    except KeyError:
266
312
        pass
267
 
    # look for any command which claims this as an alias
268
 
    for real_cmd_name, cmd_class in cmds.iteritems():
269
 
        if cmd_name in cmd_class.aliases:
270
 
            return cmd_class()
 
313
    else:
 
314
        return cmd_class()
271
315
    return cmd_or_None
272
316
 
273
317
 
353
397
            will not mangled.
354
398
 
355
399
    :cvar hooks: An instance of CommandHooks.
 
400
    :ivar __doc__: The help shown by 'bzr help command' for this command.
 
401
        This is set by assigning explicitly to __doc__ so that -OO can
 
402
        be used::
 
403
 
 
404
        class Foo(Command):
 
405
            __doc__ = "My help goes here"
356
406
    """
357
407
    aliases = []
358
408
    takes_args = []
363
413
 
364
414
    def __init__(self):
365
415
        """Construct an instance of this command."""
366
 
        if self.__doc__ == Command.__doc__:
367
 
            warn("No help message set for %r" % self)
368
416
        # List of standard options directly supported
369
417
        self.supported_std_options = []
370
 
        self._operation = cleanup.OperationWithCleanups(self.run)
371
 
    
 
418
        self._setup_run()
 
419
 
372
420
    def add_cleanup(self, cleanup_func, *args, **kwargs):
373
421
        """Register a function to call after self.run returns or raises.
374
422
 
385
433
 
386
434
        This is useful for releasing expensive or contentious resources (such
387
435
        as write locks) before doing further work that does not require those
388
 
        resources (such as writing results to self.outf).
 
436
        resources (such as writing results to self.outf). Note though, that
 
437
        as it releases all resources, this may release locks that the command
 
438
        wants to hold, so use should be done with care.
389
439
        """
390
440
        self._operation.cleanup_now()
391
 
        
 
441
 
392
442
    @deprecated_method(deprecated_in((2, 1, 0)))
393
443
    def _maybe_expand_globs(self, file_list):
394
444
        """Glob expand file_list if the platform does not do that itself.
436
486
            message explaining how to obtain full help.
437
487
        """
438
488
        doc = self.help()
439
 
        if doc is None:
440
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
489
        if not doc:
 
490
            doc = "No help for this command."
441
491
 
442
492
        # Extract the summary (purpose) and sections out from the text
443
493
        purpose,sections,order = self._get_help_parts(doc)
636
686
 
637
687
        self._setup_outf()
638
688
 
639
 
        return self.run_direct(**all_cmd_args)
640
 
 
 
689
        return self.run(**all_cmd_args)
 
690
 
 
691
    def _setup_run(self):
 
692
        """Wrap the defined run method on self with a cleanup.
 
693
 
 
694
        This is called by __init__ to make the Command be able to be run
 
695
        by just calling run(), as it could be before cleanups were added.
 
696
 
 
697
        If a different form of cleanups are in use by your Command subclass,
 
698
        you can override this method.
 
699
        """
 
700
        class_run = self.run
 
701
        def run(*args, **kwargs):
 
702
            self._operation = cleanup.OperationWithCleanups(class_run)
 
703
            try:
 
704
                return self._operation.run_simple(*args, **kwargs)
 
705
            finally:
 
706
                del self._operation
 
707
        self.run = run
 
708
 
 
709
    @deprecated_method(deprecated_in((2, 2, 0)))
641
710
    def run_direct(self, *args, **kwargs):
642
 
        """Call run directly with objects (without parsing an argv list)."""
643
 
        return self._operation.run_simple(*args, **kwargs)
 
711
        """Deprecated thunk from bzrlib 2.1."""
 
712
        return self.run(*args, **kwargs)
644
713
 
645
714
    def run(self):
646
715
        """Actually run the command.
651
720
        Return 0 or None if the command was successful, or a non-zero
652
721
        shell error code if not.  It's OK for this method to allow
653
722
        an exception to raise up.
 
723
 
 
724
        This method is automatically wrapped by Command.__init__ with a 
 
725
        cleanup operation, stored as self._operation. This can be used
 
726
        via self.add_cleanup to perform automatic cleanups at the end of
 
727
        run().
 
728
 
 
729
        The argument for run are assembled by introspection. So for instance,
 
730
        if your command takes an argument files, you would declare::
 
731
 
 
732
            def run(self, files=None):
 
733
                pass
654
734
        """
655
735
        raise NotImplementedError('no implementation of command %r'
656
736
                                  % self.name())
873
953
    return ret
874
954
 
875
955
 
 
956
@deprecated_function(deprecated_in((2, 2, 0)))
876
957
def shlex_split_unicode(unsplit):
877
 
    import shlex
878
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
958
    return cmdline.split(unsplit)
879
959
 
880
960
 
881
961
def get_alias(cmd, config=None):
893
973
        config = bzrlib.config.GlobalConfig()
894
974
    alias = config.get_alias(cmd)
895
975
    if (alias):
896
 
        return shlex_split_unicode(alias)
 
976
        return cmdline.split(alias)
897
977
    return None
898
978
 
899
979
 
900
 
def run_bzr(argv):
 
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
901
981
    """Execute a command.
902
982
 
903
 
    argv
904
 
       The command-line arguments, without the program name from argv[0]
905
 
       These should already be decoded. All library/test code calling
906
 
       run_bzr should be passing valid strings (don't need decoding).
907
 
 
908
 
    Returns a command status or raises an exception.
 
983
    :param argv: The command-line arguments, without the program name from
 
984
        argv[0] These should already be decoded. All library/test code calling
 
985
        run_bzr should be passing valid strings (don't need decoding).
 
986
    :param load_plugins: What function to call when triggering plugin loading.
 
987
        This function should take no arguments and cause all plugins to be
 
988
        loaded.
 
989
    :param disable_plugins: What function to call when disabling plugin
 
990
        loading. This function should take no arguments and cause all plugin
 
991
        loading to be prohibited (so that code paths in your application that
 
992
        know about some plugins possibly being present will fail to import
 
993
        those plugins even if they are installed.)
 
994
    :return: Returns a command exit code or raises an exception.
909
995
 
910
996
    Special master options: these must come before the command because
911
997
    they control how the command is interpreted.
968
1054
        elif a == '--coverage':
969
1055
            opt_coverage_dir = argv[i + 1]
970
1056
            i += 1
 
1057
        elif a == '--profile-imports':
 
1058
            pass # already handled in startup script Bug #588277
971
1059
        elif a.startswith('-D'):
972
1060
            debug.debug_flags.add(a[2:])
973
1061
        else:
976
1064
 
977
1065
    debug.set_debug_flags_from_config()
978
1066
 
 
1067
    if not opt_no_plugins:
 
1068
        load_plugins()
 
1069
    else:
 
1070
        disable_plugins()
 
1071
 
979
1072
    argv = argv_copy
980
1073
    if (not argv):
981
 
        from bzrlib.builtins import cmd_help
982
 
        cmd_help().run_argv_aliases([])
 
1074
        get_cmd_object('help').run_argv_aliases([])
983
1075
        return 0
984
1076
 
985
1077
    if argv[0] == '--version':
986
 
        from bzrlib.builtins import cmd_version
987
 
        cmd_version().run_argv_aliases([])
 
1078
        get_cmd_object('version').run_argv_aliases([])
988
1079
        return 0
989
1080
 
990
 
    if not opt_no_plugins:
991
 
        from bzrlib.plugin import load_plugins
992
 
        load_plugins()
993
 
    else:
994
 
        from bzrlib.plugin import disable_plugins
995
 
        disable_plugins()
996
 
 
997
1081
    alias_argv = None
998
1082
 
999
1083
    if not opt_no_aliases:
1000
1084
        alias_argv = get_alias(argv[0])
1001
1085
        if alias_argv:
1002
 
            user_encoding = osutils.get_user_encoding()
1003
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1004
1086
            argv[0] = alias_argv.pop(0)
1005
1087
 
1006
1088
    cmd = argv.pop(0)
1007
 
    # We want only 'ascii' command names, but the user may have typed
1008
 
    # in a Unicode name. In that case, they should just get a
1009
 
    # 'command not found' error later.
1010
 
 
1011
1089
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1012
1090
    run = cmd_obj.run_argv_aliases
1013
1091
    run_argv = [argv, alias_argv]
1110
1188
    :return: exit code of bzr command.
1111
1189
    """
1112
1190
    argv = _specified_or_unicode_argv(argv)
 
1191
    _register_builtin_commands()
1113
1192
    ret = run_bzr_catch_errors(argv)
1114
1193
    bzrlib.ui.ui_factory.log_transport_activity(
1115
1194
        display=('bytes' in debug.debug_flags))
1163
1242
        if topic and topic.startswith(self.prefix):
1164
1243
            topic = topic[len(self.prefix):]
1165
1244
        try:
1166
 
            cmd = _get_cmd_object(topic)
 
1245
            cmd = _get_cmd_object(topic, check_missing=False)
1167
1246
        except KeyError:
1168
1247
            return []
1169
1248
        else: