← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-29 22:03:03 UTC
  • mfrom: (5416.2.6 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100929220303-cr95h8iwtggco721
(mbp) Add 'break-lock --force'

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
 
78
72
 
79
73
 
80
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)
81
91
 
82
92
    @staticmethod
83
93
    def _get_name(command_name):
99
109
        try:
100
110
            previous = self.get(k_unsquished)
101
111
        except KeyError:
102
 
            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
103
118
        info = CommandInfo.from_command(cmd)
104
119
        try:
105
120
            registry.Registry.register(self, k_unsquished, cmd,
110
125
                sys.modules[cmd.__module__])
111
126
            trace.warning('Previously this command was registered from %r' %
112
127
                sys.modules[previous.__module__])
 
128
        for a in cmd.aliases:
 
129
            self._alias_dict[a] = k_unsquished
113
130
        return previous
114
131
 
115
132
    def register_lazy(self, command_name, aliases, module_name):
122
139
        key = self._get_name(command_name)
123
140
        registry.Registry.register_lazy(self, key, module_name, command_name,
124
141
                                        info=CommandInfo(aliases))
 
142
        for a in aliases:
 
143
            self._alias_dict[a] = key
125
144
 
126
145
 
127
146
plugin_cmds = CommandRegistry()
 
147
builtin_command_registry = CommandRegistry()
 
148
plugin_cmds.overridden_registry = builtin_command_registry
128
149
 
129
150
 
130
151
def register_command(cmd, decorate=False):
 
152
    """Register a plugin command.
 
153
 
 
154
    Should generally be avoided in favor of lazy registration. 
 
155
    """
131
156
    global plugin_cmds
132
157
    return plugin_cmds.register(cmd, decorate)
133
158
 
140
165
    return cmd[4:].replace('_','-')
141
166
 
142
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
143
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
144
182
    import bzrlib.builtins
145
 
    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()
146
186
 
147
187
 
148
188
def _scan_module_for_commands(module):
155
195
 
156
196
 
157
197
def _list_bzr_commands(names):
158
 
    """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
    """
159
202
    # to eliminate duplicates
160
203
    names.update(builtin_command_names())
161
204
    names.update(plugin_command_names())
179
222
    Use of all_command_names() is encouraged rather than builtin_command_names
180
223
    and/or plugin_command_names.
181
224
    """
182
 
    return _builtin_commands().keys()
 
225
    _register_builtin_commands()
 
226
    return builtin_command_registry.keys()
183
227
 
184
228
 
185
229
def plugin_command_names():
199
243
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
200
244
 
201
245
 
202
 
def _get_cmd_object(cmd_name, plugins_override=True):
 
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
203
247
    """Get a command object.
204
248
 
205
249
    :param cmd_name: The name of the command.
206
250
    :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.
207
253
    :return: A Command object instance
208
254
    :raises KeyError: If no command is found.
209
255
    """
219
265
            # We've found a non-plugin command, don't permit it to be
220
266
            # overridden.
221
267
            break
222
 
    if cmd is None:
 
268
    if cmd is None and check_missing:
223
269
        for hook in Command.hooks['get_missing_command']:
224
270
            cmd = hook(cmd_name)
225
271
            if cmd is not None:
261
307
 
262
308
def _get_bzr_command(cmd_or_None, cmd_name):
263
309
    """Get a command from bzr's core."""
264
 
    cmds = _builtin_commands()
265
310
    try:
266
 
        return cmds[cmd_name]()
 
311
        cmd_class = builtin_command_registry.get(cmd_name)
267
312
    except KeyError:
268
313
        pass
269
 
    # look for any command which claims this as an alias
270
 
    for real_cmd_name, cmd_class in cmds.iteritems():
271
 
        if cmd_name in cmd_class.aliases:
272
 
            return cmd_class()
 
314
    else:
 
315
        return cmd_class()
273
316
    return cmd_or_None
274
317
 
275
318
 
355
398
            will not mangled.
356
399
 
357
400
    :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"
358
407
    """
359
408
    aliases = []
360
409
    takes_args = []
365
414
 
366
415
    def __init__(self):
367
416
        """Construct an instance of this command."""
368
 
        if self.__doc__ == Command.__doc__:
369
 
            warn("No help message set for %r" % self)
370
417
        # List of standard options directly supported
371
418
        self.supported_std_options = []
372
 
        self._operation = cleanup.OperationWithCleanups(self.run)
373
 
    
 
419
        self._setup_run()
 
420
 
374
421
    def add_cleanup(self, cleanup_func, *args, **kwargs):
375
422
        """Register a function to call after self.run returns or raises.
376
423
 
387
434
 
388
435
        This is useful for releasing expensive or contentious resources (such
389
436
        as write locks) before doing further work that does not require those
390
 
        resources (such as writing results to self.outf).
 
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.
391
440
        """
392
441
        self._operation.cleanup_now()
393
 
        
 
442
 
394
443
    @deprecated_method(deprecated_in((2, 1, 0)))
395
444
    def _maybe_expand_globs(self, file_list):
396
445
        """Glob expand file_list if the platform does not do that itself.
438
487
            message explaining how to obtain full help.
439
488
        """
440
489
        doc = self.help()
441
 
        if doc is None:
442
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
490
        if not doc:
 
491
            doc = "No help for this command."
443
492
 
444
493
        # Extract the summary (purpose) and sections out from the text
445
494
        purpose,sections,order = self._get_help_parts(doc)
638
687
 
639
688
        self._setup_outf()
640
689
 
641
 
        return self.run_direct(**all_cmd_args)
642
 
 
 
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)))
643
711
    def run_direct(self, *args, **kwargs):
644
 
        """Call run directly with objects (without parsing an argv list)."""
645
 
        return self._operation.run_simple(*args, **kwargs)
 
712
        """Deprecated thunk from bzrlib 2.1."""
 
713
        return self.run(*args, **kwargs)
646
714
 
647
715
    def run(self):
648
716
        """Actually run the command.
653
721
        Return 0 or None if the command was successful, or a non-zero
654
722
        shell error code if not.  It's OK for this method to allow
655
723
        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
656
735
        """
657
736
        raise NotImplementedError('no implementation of command %r'
658
737
                                  % self.name())
875
954
    return ret
876
955
 
877
956
 
 
957
@deprecated_function(deprecated_in((2, 2, 0)))
 
958
def shlex_split_unicode(unsplit):
 
959
    return cmdline.split(unsplit)
 
960
 
 
961
 
878
962
def get_alias(cmd, config=None):
879
963
    """Return an expanded alias, or None if no alias exists.
880
964
 
971
1055
        elif a == '--coverage':
972
1056
            opt_coverage_dir = argv[i + 1]
973
1057
            i += 1
 
1058
        elif a == '--profile-imports':
 
1059
            pass # already handled in startup script Bug #588277
974
1060
        elif a.startswith('-D'):
975
1061
            debug.debug_flags.add(a[2:])
976
1062
        else:
998
1084
    if not opt_no_aliases:
999
1085
        alias_argv = get_alias(argv[0])
1000
1086
        if alias_argv:
1001
 
            user_encoding = osutils.get_user_encoding()
1002
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1003
1087
            argv[0] = alias_argv.pop(0)
1004
1088
 
1005
1089
    cmd = argv.pop(0)
1006
 
    # We want only 'ascii' command names, but the user may have typed
1007
 
    # in a Unicode name. In that case, they should just get a
1008
 
    # 'command not found' error later.
1009
 
 
1010
1090
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1011
1091
    run = cmd_obj.run_argv_aliases
1012
1092
    run_argv = [argv, alias_argv]
1109
1189
    :return: exit code of bzr command.
1110
1190
    """
1111
1191
    argv = _specified_or_unicode_argv(argv)
 
1192
    _register_builtin_commands()
1112
1193
    ret = run_bzr_catch_errors(argv)
1113
1194
    bzrlib.ui.ui_factory.log_transport_activity(
1114
1195
        display=('bytes' in debug.debug_flags))
1162
1243
        if topic and topic.startswith(self.prefix):
1163
1244
            topic = topic[len(self.prefix):]
1164
1245
        try:
1165
 
            cmd = _get_cmd_object(topic)
 
1246
            cmd = _get_cmd_object(topic, check_missing=False)
1166
1247
        except KeyError:
1167
1248
            return []
1168
1249
        else: