/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: Parth Malwankar
  • Date: 2010-02-15 10:46:49 UTC
  • mto: This revision was merged to the branch mainline in revision 5048.
  • Revision ID: parth.malwankar@gmail.com-20100215104649-bo4z8rhqvfibnxhj
updated existing upgrade tests to work.

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
 
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
 
35
41
import bzrlib
36
42
from bzrlib import (
37
43
    cleanup,
38
 
    cmdline,
39
44
    debug,
40
45
    errors,
41
46
    option,
49
54
from bzrlib.hooks import HookPoint, Hooks
50
55
# Compatibility - Option used to be in commands.
51
56
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
57
from bzrlib import registry
54
58
from bzrlib.symbol_versioning import (
55
59
    deprecated_function,
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():
243
197
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
244
198
 
245
199
 
246
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
200
def _get_cmd_object(cmd_name, plugins_override=True):
247
201
    """Get a command object.
248
202
 
249
203
    :param cmd_name: The name of the command.
250
204
    :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
205
    :return: A Command object instance
254
206
    :raises KeyError: If no command is found.
255
207
    """
265
217
            # We've found a non-plugin command, don't permit it to be
266
218
            # overridden.
267
219
            break
268
 
    if cmd is None and check_missing:
 
220
    if cmd is None:
269
221
        for hook in Command.hooks['get_missing_command']:
270
222
            cmd = hook(cmd_name)
271
223
            if cmd is not None:
307
259
 
308
260
def _get_bzr_command(cmd_or_None, cmd_name):
309
261
    """Get a command from bzr's core."""
 
262
    cmds = _builtin_commands()
310
263
    try:
311
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
264
        return cmds[cmd_name]()
312
265
    except KeyError:
313
266
        pass
314
 
    else:
315
 
        return cmd_class()
 
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()
316
271
    return cmd_or_None
317
272
 
318
273
 
398
353
            will not mangled.
399
354
 
400
355
    :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
356
    """
408
357
    aliases = []
409
358
    takes_args = []
414
363
 
415
364
    def __init__(self):
416
365
        """Construct an instance of this command."""
 
366
        if self.__doc__ == Command.__doc__:
 
367
            warn("No help message set for %r" % self)
417
368
        # List of standard options directly supported
418
369
        self.supported_std_options = []
419
 
        self._setup_run()
420
 
 
 
370
        self._operation = cleanup.OperationWithCleanups(self.run)
 
371
    
421
372
    def add_cleanup(self, cleanup_func, *args, **kwargs):
422
373
        """Register a function to call after self.run returns or raises.
423
374
 
434
385
 
435
386
        This is useful for releasing expensive or contentious resources (such
436
387
        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.
 
388
        resources (such as writing results to self.outf).
440
389
        """
441
390
        self._operation.cleanup_now()
442
 
 
 
391
        
443
392
    @deprecated_method(deprecated_in((2, 1, 0)))
444
393
    def _maybe_expand_globs(self, file_list):
445
394
        """Glob expand file_list if the platform does not do that itself.
487
436
            message explaining how to obtain full help.
488
437
        """
489
438
        doc = self.help()
490
 
        if not doc:
491
 
            doc = "No help for this command."
 
439
        if doc is None:
 
440
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
441
 
493
442
        # Extract the summary (purpose) and sections out from the text
494
443
        purpose,sections,order = self._get_help_parts(doc)
687
636
 
688
637
        self._setup_outf()
689
638
 
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)))
 
639
        return self.run_direct(**all_cmd_args)
 
640
 
711
641
    def run_direct(self, *args, **kwargs):
712
 
        """Deprecated thunk from bzrlib 2.1."""
713
 
        return self.run(*args, **kwargs)
 
642
        """Call run directly with objects (without parsing an argv list)."""
 
643
        return self._operation.run_simple(*args, **kwargs)
714
644
 
715
645
    def run(self):
716
646
        """Actually run the command.
721
651
        Return 0 or None if the command was successful, or a non-zero
722
652
        shell error code if not.  It's OK for this method to allow
723
653
        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
654
        """
736
655
        raise NotImplementedError('no implementation of command %r'
737
656
                                  % self.name())
954
873
    return ret
955
874
 
956
875
 
957
 
@deprecated_function(deprecated_in((2, 2, 0)))
958
876
def shlex_split_unicode(unsplit):
959
 
    return cmdline.split(unsplit)
 
877
    import shlex
 
878
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
960
879
 
961
880
 
962
881
def get_alias(cmd, config=None):
974
893
        config = bzrlib.config.GlobalConfig()
975
894
    alias = config.get_alias(cmd)
976
895
    if (alias):
977
 
        return cmdline.split(alias)
 
896
        return shlex_split_unicode(alias)
978
897
    return None
979
898
 
980
899
 
981
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
900
def run_bzr(argv):
982
901
    """Execute a command.
983
902
 
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.
 
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.
996
909
 
997
910
    Special master options: these must come before the command because
998
911
    they control how the command is interpreted.
1055
968
        elif a == '--coverage':
1056
969
            opt_coverage_dir = argv[i + 1]
1057
970
            i += 1
1058
 
        elif a == '--profile-imports':
1059
 
            pass # already handled in startup script Bug #588277
1060
971
        elif a.startswith('-D'):
1061
972
            debug.debug_flags.add(a[2:])
1062
973
        else:
1065
976
 
1066
977
    debug.set_debug_flags_from_config()
1067
978
 
 
979
    argv = argv_copy
 
980
    if (not argv):
 
981
        from bzrlib.builtins import cmd_help
 
982
        cmd_help().run_argv_aliases([])
 
983
        return 0
 
984
 
 
985
    if argv[0] == '--version':
 
986
        from bzrlib.builtins import cmd_version
 
987
        cmd_version().run_argv_aliases([])
 
988
        return 0
 
989
 
1068
990
    if not opt_no_plugins:
 
991
        from bzrlib.plugin import load_plugins
1069
992
        load_plugins()
1070
993
    else:
 
994
        from bzrlib.plugin import disable_plugins
1071
995
        disable_plugins()
1072
996
 
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
997
    alias_argv = None
1083
998
 
1084
999
    if not opt_no_aliases:
1085
1000
        alias_argv = get_alias(argv[0])
1086
1001
        if alias_argv:
 
1002
            user_encoding = osutils.get_user_encoding()
 
1003
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1087
1004
            argv[0] = alias_argv.pop(0)
1088
1005
 
1089
1006
    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
 
1090
1011
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
1012
    run = cmd_obj.run_argv_aliases
1092
1013
    run_argv = [argv, alias_argv]
1189
1110
    :return: exit code of bzr command.
1190
1111
    """
1191
1112
    argv = _specified_or_unicode_argv(argv)
1192
 
    _register_builtin_commands()
1193
1113
    ret = run_bzr_catch_errors(argv)
1194
1114
    bzrlib.ui.ui_factory.log_transport_activity(
1195
1115
        display=('bytes' in debug.debug_flags))
1243
1163
        if topic and topic.startswith(self.prefix):
1244
1164
            topic = topic[len(self.prefix):]
1245
1165
        try:
1246
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1166
            cmd = _get_cmd_object(topic)
1247
1167
        except KeyError:
1248
1168
            return []
1249
1169
        else: