← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Andrew Bennetts
  • Date: 2010-01-12 03:53:21 UTC
  • mfrom: (4948 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4964.
  • Revision ID: andrew.bennetts@canonical.com-20100112035321-hofpz5p10224ryj3
Merge lp:bzr, resolving conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2005-2011 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
 
28
34
from bzrlib.lazy_import import lazy_import
29
35
lazy_import(globals(), """
 
36
import codecs
30
37
import errno
31
38
import threading
 
39
from warnings import warn
32
40
 
33
41
import bzrlib
34
42
from bzrlib import (
35
43
    cleanup,
36
 
    cmdline,
37
44
    debug,
38
45
    errors,
39
 
    i18n,
40
46
    option,
41
47
    osutils,
42
48
    trace,
43
49
    ui,
 
50
    win32utils,
44
51
    )
45
52
""")
46
53
 
47
 
from bzrlib.hooks import Hooks
48
 
from bzrlib.i18n import gettext
 
54
from bzrlib.hooks import HookPoint, Hooks
49
55
# Compatibility - Option used to be in commands.
50
56
from bzrlib.option import Option
51
 
from bzrlib.plugin import disable_plugins, load_plugins
52
57
from bzrlib import registry
53
58
from bzrlib.symbol_versioning import (
54
59
    deprecated_function,
55
60
    deprecated_in,
56
61
    deprecated_method,
 
62
    suppress_deprecation_warnings,
57
63
    )
58
64
 
59
65
 
71
77
 
72
78
 
73
79
class CommandRegistry(registry.Registry):
74
 
    """Special registry mapping command names to command classes.
75
 
    
76
 
    :ivar overridden_registry: Look in this registry for commands being
77
 
        overridden by this registry.  This can be used to tell plugin commands
78
 
        about the builtin they're decorating.
79
 
    """
80
 
 
81
 
    def __init__(self):
82
 
        registry.Registry.__init__(self)
83
 
        self.overridden_registry = None
84
 
        # map from aliases to the real command that implements the name
85
 
        self._alias_dict = {}
86
 
 
87
 
    def get(self, command_name):
88
 
        real_name = self._alias_dict.get(command_name, command_name)
89
 
        return registry.Registry.get(self, real_name)
90
80
 
91
81
    @staticmethod
92
82
    def _get_name(command_name):
108
98
        try:
109
99
            previous = self.get(k_unsquished)
110
100
        except KeyError:
111
 
            previous = None
112
 
            if self.overridden_registry:
113
 
                try:
114
 
                    previous = self.overridden_registry.get(k_unsquished)
115
 
                except KeyError:
116
 
                    pass
 
101
            previous = _builtin_commands().get(k_unsquished)
117
102
        info = CommandInfo.from_command(cmd)
118
103
        try:
119
104
            registry.Registry.register(self, k_unsquished, cmd,
124
109
                sys.modules[cmd.__module__])
125
110
            trace.warning('Previously this command was registered from %r' %
126
111
                sys.modules[previous.__module__])
127
 
        for a in cmd.aliases:
128
 
            self._alias_dict[a] = k_unsquished
129
112
        return previous
130
113
 
131
114
    def register_lazy(self, command_name, aliases, module_name):
138
121
        key = self._get_name(command_name)
139
122
        registry.Registry.register_lazy(self, key, module_name, command_name,
140
123
                                        info=CommandInfo(aliases))
141
 
        for a in aliases:
142
 
            self._alias_dict[a] = key
143
124
 
144
125
 
145
126
plugin_cmds = CommandRegistry()
146
 
builtin_command_registry = CommandRegistry()
147
 
plugin_cmds.overridden_registry = builtin_command_registry
148
127
 
149
128
 
150
129
def register_command(cmd, decorate=False):
151
 
    """Register a plugin command.
152
 
 
153
 
    Should generally be avoided in favor of lazy registration. 
154
 
    """
155
130
    global plugin_cmds
156
131
    return plugin_cmds.register(cmd, decorate)
157
132
 
164
139
    return cmd[4:].replace('_','-')
165
140
 
166
141
 
167
 
def _register_builtin_commands():
168
 
    if builtin_command_registry.keys():
169
 
        # only load once
170
 
        return
 
142
def _builtin_commands():
171
143
    import bzrlib.builtins
172
 
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
 
        builtin_command_registry.register(cmd_class)
174
 
    bzrlib.builtins._register_lazy_builtins()
 
144
    return _scan_module_for_commands(bzrlib.builtins)
175
145
 
176
146
 
177
147
def _scan_module_for_commands(module):
184
154
 
185
155
 
186
156
def _list_bzr_commands(names):
187
 
    """Find commands from bzr's core and plugins.
188
 
    
189
 
    This is not the public interface, just the default hook called by all_command_names.
190
 
    """
 
157
    """Find commands from bzr's core and plugins."""
191
158
    # to eliminate duplicates
192
159
    names.update(builtin_command_names())
193
160
    names.update(plugin_command_names())
211
178
    Use of all_command_names() is encouraged rather than builtin_command_names
212
179
    and/or plugin_command_names.
213
180
    """
214
 
    _register_builtin_commands()
215
 
    return builtin_command_registry.keys()
 
181
    return _builtin_commands().keys()
216
182
 
217
183
 
218
184
def plugin_command_names():
220
186
    return plugin_cmds.keys()
221
187
 
222
188
 
 
189
@deprecated_function(deprecated_in((1, 17, 0)))
 
190
def get_all_cmds(plugins_override=False):
 
191
    """Return canonical name and class for most commands.
 
192
    
 
193
    NB: This does not return all commands since the introduction of
 
194
    command hooks, and returning the class is not sufficient to 
 
195
    get correctly setup commands, which is why it is deprecated.
 
196
 
 
197
    Use 'all_command_names' + 'get_cmd_object' instead.
 
198
    """
 
199
    d = _builtin_commands()
 
200
    if plugins_override:
 
201
        d.update(plugin_cmds.iteritems())
 
202
    for k, v in d.iteritems():
 
203
        yield k,v
 
204
 
 
205
 
223
206
def get_cmd_object(cmd_name, plugins_override=True):
224
207
    """Return the command object for a command.
225
208
 
232
215
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
233
216
 
234
217
 
235
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
218
def _get_cmd_object(cmd_name, plugins_override=True):
236
219
    """Get a command object.
237
220
 
238
221
    :param cmd_name: The name of the command.
239
222
    :param plugins_override: Allow plugins to override builtins.
240
 
    :param check_missing: Look up commands not found in the regular index via
241
 
        the get_missing_command hook.
242
223
    :return: A Command object instance
243
224
    :raises KeyError: If no command is found.
244
225
    """
254
235
            # We've found a non-plugin command, don't permit it to be
255
236
            # overridden.
256
237
            break
257
 
    if cmd is None and check_missing:
 
238
    if cmd is None:
258
239
        for hook in Command.hooks['get_missing_command']:
259
240
            cmd = hook(cmd_name)
260
241
            if cmd is not None:
265
246
    # Allow plugins to extend commands
266
247
    for hook in Command.hooks['extend_command']:
267
248
        hook(cmd)
268
 
    if getattr(cmd, 'invoked_as', None) is None:
269
 
        cmd.invoked_as = cmd_name
270
249
    return cmd
271
250
 
272
251
 
298
277
 
299
278
def _get_bzr_command(cmd_or_None, cmd_name):
300
279
    """Get a command from bzr's core."""
 
280
    cmds = _builtin_commands()
301
281
    try:
302
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
282
        return cmds[cmd_name]()
303
283
    except KeyError:
304
284
        pass
305
 
    else:
306
 
        return cmd_class()
 
285
    # look for any command which claims this as an alias
 
286
    for real_cmd_name, cmd_class in cmds.iteritems():
 
287
        if cmd_name in cmd_class.aliases:
 
288
            return cmd_class()
307
289
    return cmd_or_None
308
290
 
309
291
 
349
331
    summary, then a complete description of the command.  A grammar
350
332
    description will be inserted.
351
333
 
352
 
    :cvar aliases: Other accepted names for this command.
353
 
 
354
 
    :cvar takes_args: List of argument forms, marked with whether they are
355
 
        optional, repeated, etc.  Examples::
356
 
 
357
 
            ['to_location', 'from_branch?', 'file*']
358
 
 
359
 
        * 'to_location' is required
360
 
        * 'from_branch' is optional
361
 
        * 'file' can be specified 0 or more times
362
 
 
363
 
    :cvar takes_options: List of options that may be given for this command.
364
 
        These can be either strings, referring to globally-defined options, or
365
 
        option objects.  Retrieve through options().
366
 
 
367
 
    :cvar hidden: If true, this command isn't advertised.  This is typically
 
334
    aliases
 
335
        Other accepted names for this command.
 
336
 
 
337
    takes_args
 
338
        List of argument forms, marked with whether they are optional,
 
339
        repeated, etc.
 
340
 
 
341
                Examples:
 
342
 
 
343
                ['to_location', 'from_branch?', 'file*']
 
344
 
 
345
                'to_location' is required
 
346
                'from_branch' is optional
 
347
                'file' can be specified 0 or more times
 
348
 
 
349
    takes_options
 
350
        List of options that may be given for this command.  These can
 
351
        be either strings, referring to globally-defined options,
 
352
        or option objects.  Retrieve through options().
 
353
 
 
354
    hidden
 
355
        If true, this command isn't advertised.  This is typically
368
356
        for commands intended for expert users.
369
357
 
370
 
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
 
        been setup to properly handle encoding of unicode strings.
372
 
        encoding_type determines what will happen when characters cannot be
373
 
        encoded:
374
 
 
375
 
        * strict - abort if we cannot decode
376
 
        * replace - put in a bogus character (typically '?')
377
 
        * exact - do not encode sys.stdout
378
 
 
379
 
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
 
        therefore LF line-endings are converted to CRLF.  When a command uses
381
 
        encoding_type = 'exact', then sys.stdout is forced to be a binary
382
 
        stream, and line-endings will not mangled.
383
 
 
384
 
    :cvar invoked_as:
385
 
        A string indicating the real name under which this command was
386
 
        invoked, before expansion of aliases.
387
 
        (This may be None if the command was constructed and run in-process.)
 
358
    encoding_type
 
359
        Command objects will get a 'outf' attribute, which has been
 
360
        setup to properly handle encoding of unicode strings.
 
361
        encoding_type determines what will happen when characters cannot
 
362
        be encoded
 
363
            strict - abort if we cannot decode
 
364
            replace - put in a bogus character (typically '?')
 
365
            exact - do not encode sys.stdout
 
366
 
 
367
            NOTE: by default on Windows, sys.stdout is opened as a text
 
368
            stream, therefore LF line-endings are converted to CRLF.
 
369
            When a command uses encoding_type = 'exact', then
 
370
            sys.stdout is forced to be a binary stream, and line-endings
 
371
            will not mangled.
388
372
 
389
373
    :cvar hooks: An instance of CommandHooks.
390
 
 
391
 
    :cvar __doc__: The help shown by 'bzr help command' for this command.
392
 
        This is set by assigning explicitly to __doc__ so that -OO can
393
 
        be used::
394
 
 
395
 
            class Foo(Command):
396
 
                __doc__ = "My help goes here"
397
374
    """
398
375
    aliases = []
399
376
    takes_args = []
400
377
    takes_options = []
401
378
    encoding_type = 'strict'
402
 
    invoked_as = None
403
 
    l10n = True
404
379
 
405
380
    hidden = False
406
381
 
407
382
    def __init__(self):
408
383
        """Construct an instance of this command."""
 
384
        if self.__doc__ == Command.__doc__:
 
385
            warn("No help message set for %r" % self)
409
386
        # List of standard options directly supported
410
387
        self.supported_std_options = []
411
 
        self._setup_run()
412
 
 
 
388
        self._operation = cleanup.OperationWithCleanups(self.run)
 
389
    
413
390
    def add_cleanup(self, cleanup_func, *args, **kwargs):
414
391
        """Register a function to call after self.run returns or raises.
415
392
 
426
403
 
427
404
        This is useful for releasing expensive or contentious resources (such
428
405
        as write locks) before doing further work that does not require those
429
 
        resources (such as writing results to self.outf). Note though, that
430
 
        as it releases all resources, this may release locks that the command
431
 
        wants to hold, so use should be done with care.
 
406
        resources (such as writing results to self.outf).
432
407
        """
433
408
        self._operation.cleanup_now()
 
409
        
 
410
    @deprecated_method(deprecated_in((2, 1, 0)))
 
411
    def _maybe_expand_globs(self, file_list):
 
412
        """Glob expand file_list if the platform does not do that itself.
 
413
 
 
414
        Not used anymore, now that the bzr command-line parser globs on
 
415
        Windows.
 
416
 
 
417
        :return: A possibly empty list of unicode paths.
 
418
 
 
419
        Introduced in bzrlib 0.18.
 
420
        """
 
421
        return file_list
434
422
 
435
423
    def _usage(self):
436
424
        """Return single-line grammar for this command.
465
453
            usage help (e.g. Purpose, Usage, Options) with a
466
454
            message explaining how to obtain full help.
467
455
        """
468
 
        if self.l10n and not i18n.installed():
469
 
            i18n.install()  # Install i18n only for get_help_text for now.
470
456
        doc = self.help()
471
 
        if doc:
472
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
473
 
            # be shown after "Description" section and we don't want to
474
 
            # translate the usage string.
475
 
            # Though, bzr export-pot don't exports :Usage: section and it must
476
 
            # not be translated.
477
 
            doc = self.gettext(doc)
478
 
        else:
479
 
            doc = gettext("No help for this command.")
 
457
        if doc is None:
 
458
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
480
459
 
481
460
        # Extract the summary (purpose) and sections out from the text
482
461
        purpose,sections,order = self._get_help_parts(doc)
489
468
 
490
469
        # The header is the purpose and usage
491
470
        result = ""
492
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
471
        result += ':Purpose: %s\n' % purpose
493
472
        if usage.find('\n') >= 0:
494
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
473
            result += ':Usage:\n%s\n' % usage
495
474
        else:
496
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
475
            result += ':Usage:   %s\n' % usage
497
476
        result += '\n'
498
477
 
499
478
        # Add the options
501
480
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
502
481
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
503
482
        # 20090319
504
 
        parser = option.get_optparser(self.options())
505
 
        options = parser.format_option_help()
506
 
        # FIXME: According to the spec, ReST option lists actually don't
507
 
        # support options like --1.14 so that causes syntax errors (in Sphinx
508
 
        # at least).  As that pattern always appears in the commands that
509
 
        # break, we trap on that and then format that block of 'format' options
510
 
        # as a literal block. We use the most recent format still listed so we
511
 
        # don't have to do that too often -- vila 20110514
512
 
        if not plain and options.find('  --1.14  ') != -1:
 
483
        options = option.get_optparser(self.options()).format_option_help()
 
484
        # XXX: According to the spec, ReST option lists actually don't support 
 
485
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
486
        # As that pattern always appears in the commands that break, we trap
 
487
        # on that and then format that block of 'format' options as a literal
 
488
        # block.
 
489
        if not plain and options.find('  --1.9  ') != -1:
513
490
            options = options.replace(' format:\n', ' format::\n\n', 1)
514
491
        if options.startswith('Options:'):
515
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
492
            result += ':' + options
 
493
        elif options.startswith('options:'):
 
494
            # Python 2.4 version of optparse
 
495
            result += ':Options:' + options[len('options:'):]
516
496
        else:
517
497
            result += options
518
498
        result += '\n'
523
503
            if sections.has_key(None):
524
504
                text = sections.pop(None)
525
505
                text = '\n  '.join(text.splitlines())
526
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
506
                result += ':%s:\n  %s\n\n' % ('Description',text)
527
507
 
528
508
            # Add the custom sections (e.g. Examples). Note that there's no need
529
509
            # to indent these as they must be indented already in the source.
530
510
            if sections:
531
511
                for label in order:
532
 
                    if label in sections:
533
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
512
                    if sections.has_key(label):
 
513
                        result += ':%s:\n%s\n' % (label,sections[label])
534
514
                result += '\n'
535
515
        else:
536
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
516
            result += ("See bzr help %s for more details and examples.\n\n"
537
517
                % self.name())
538
518
 
539
519
        # Add the aliases, source (plug-in) and see also links, if any
540
520
        if self.aliases:
541
 
            result += gettext(':Aliases:  ')
 
521
            result += ':Aliases:  '
542
522
            result += ', '.join(self.aliases) + '\n'
543
523
        plugin_name = self.plugin_name()
544
524
        if plugin_name is not None:
545
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
525
            result += ':From:     plugin "%s"\n' % plugin_name
546
526
        see_also = self.get_see_also(additional_see_also)
547
527
        if see_also:
548
528
            if not plain and see_also_as_links:
554
534
                        see_also_links.append(item)
555
535
                    else:
556
536
                        # Use a Sphinx link for this entry
557
 
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
 
537
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
558
538
                        see_also_links.append(link_text)
559
539
                see_also = see_also_links
560
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
540
            result += ':See also: '
 
541
            result += ', '.join(see_also) + '\n'
561
542
 
562
543
        # If this will be rendered as plain text, convert it
563
544
        if plain:
643
624
 
644
625
    def run_argv_aliases(self, argv, alias_argv=None):
645
626
        """Parse the command line and run with extra aliases in alias_argv."""
 
627
        if argv is None:
 
628
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
629
                 DeprecationWarning, stacklevel=2)
 
630
            argv = []
646
631
        args, opts = parse_args(self, argv, alias_argv)
647
 
        self._setup_outf()
648
632
 
649
633
        # Process the standard options
650
634
        if 'help' in opts:  # e.g. bzr add --help
651
 
            self.outf.write(self.get_help_text())
 
635
            sys.stdout.write(self.get_help_text())
652
636
            return 0
653
637
        if 'usage' in opts:  # e.g. bzr add --usage
654
 
            self.outf.write(self.get_help_text(verbose=False))
 
638
            sys.stdout.write(self.get_help_text(verbose=False))
655
639
            return 0
656
640
        trace.set_verbosity_level(option._verbosity_level)
657
641
        if 'verbose' in self.supported_std_options:
672
656
        all_cmd_args = cmdargs.copy()
673
657
        all_cmd_args.update(cmdopts)
674
658
 
675
 
        try:
676
 
            return self.run(**all_cmd_args)
677
 
        finally:
678
 
            # reset it, so that other commands run in the same process won't
679
 
            # inherit state. Before we reset it, log any activity, so that it
680
 
            # gets properly tracked.
681
 
            ui.ui_factory.log_transport_activity(
682
 
                display=('bytes' in debug.debug_flags))
683
 
            trace.set_verbosity_level(0)
684
 
 
685
 
    def _setup_run(self):
686
 
        """Wrap the defined run method on self with a cleanup.
687
 
 
688
 
        This is called by __init__ to make the Command be able to be run
689
 
        by just calling run(), as it could be before cleanups were added.
690
 
 
691
 
        If a different form of cleanups are in use by your Command subclass,
692
 
        you can override this method.
693
 
        """
694
 
        class_run = self.run
695
 
        def run(*args, **kwargs):
696
 
            self._operation = cleanup.OperationWithCleanups(class_run)
697
 
            try:
698
 
                return self._operation.run_simple(*args, **kwargs)
699
 
            finally:
700
 
                del self._operation
701
 
        self.run = run
 
659
        self._setup_outf()
 
660
 
 
661
        return self.run_direct(**all_cmd_args)
 
662
 
 
663
    def run_direct(self, *args, **kwargs):
 
664
        """Call run directly with objects (without parsing an argv list)."""
 
665
        return self._operation.run_simple(*args, **kwargs)
702
666
 
703
667
    def run(self):
704
668
        """Actually run the command.
709
673
        Return 0 or None if the command was successful, or a non-zero
710
674
        shell error code if not.  It's OK for this method to allow
711
675
        an exception to raise up.
712
 
 
713
 
        This method is automatically wrapped by Command.__init__ with a 
714
 
        cleanup operation, stored as self._operation. This can be used
715
 
        via self.add_cleanup to perform automatic cleanups at the end of
716
 
        run().
717
 
 
718
 
        The argument for run are assembled by introspection. So for instance,
719
 
        if your command takes an argument files, you would declare::
720
 
 
721
 
            def run(self, files=None):
722
 
                pass
723
676
        """
724
677
        raise NotImplementedError('no implementation of command %r'
725
678
                                  % self.name())
731
684
            return None
732
685
        return getdoc(self)
733
686
 
734
 
    def gettext(self, message):
735
 
        """Returns the gettext function used to translate this command's help.
736
 
 
737
 
        Commands provided by plugins should override this to use their
738
 
        own i18n system.
739
 
        """
740
 
        return i18n.gettext_per_paragraph(message)
741
 
 
742
687
    def name(self):
743
 
        """Return the canonical name for this command.
744
 
 
745
 
        The name under which it was actually invoked is available in invoked_as.
746
 
        """
747
688
        return _unsquish_command_name(self.__class__.__name__)
748
689
 
749
690
    def plugin_name(self):
767
708
        These are all empty initially, because by default nothing should get
768
709
        notified.
769
710
        """
770
 
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
 
        self.add_hook('extend_command',
 
711
        Hooks.__init__(self)
 
712
        self.create_hook(HookPoint('extend_command',
772
713
            "Called after creating a command object to allow modifications "
773
714
            "such as adding or removing options, docs etc. Called with the "
774
 
            "new bzrlib.commands.Command object.", (1, 13))
775
 
        self.add_hook('get_command',
 
715
            "new bzrlib.commands.Command object.", (1, 13), None))
 
716
        self.create_hook(HookPoint('get_command',
776
717
            "Called when creating a single command. Called with "
777
718
            "(cmd_or_None, command_name). get_command should either return "
778
719
            "the cmd_or_None parameter, or a replacement Command object that "
779
720
            "should be used for the command. Note that the Command.hooks "
780
721
            "hooks are core infrastructure. Many users will prefer to use "
781
722
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
 
            (1, 17))
783
 
        self.add_hook('get_missing_command',
 
723
            (1, 17), None))
 
724
        self.create_hook(HookPoint('get_missing_command',
784
725
            "Called when creating a single command if no command could be "
785
726
            "found. Called with (command_name). get_missing_command should "
786
727
            "either return None, or a Command object to be used for the "
787
 
            "command.", (1, 17))
788
 
        self.add_hook('list_commands',
 
728
            "command.", (1, 17), None))
 
729
        self.create_hook(HookPoint('list_commands',
789
730
            "Called when enumerating commands. Called with a set of "
790
731
            "cmd_name strings for all the commands found so far. This set "
791
732
            " is safe to mutate - e.g. to remove a command. "
792
733
            "list_commands should return the updated set of command names.",
793
 
            (1, 17))
 
734
            (1, 17), None))
794
735
 
795
736
Command.hooks = CommandHooks()
796
737
 
810
751
    else:
811
752
        args = argv
812
753
 
813
 
    # for python 2.5 and later, optparse raises this exception if a non-ascii
814
 
    # option name is given.  See http://bugs.python.org/issue2931
815
 
    try:
816
 
        options, args = parser.parse_args(args)
817
 
    except UnicodeEncodeError,e:
818
 
        raise errors.BzrCommandError('Only ASCII permitted in option names')
819
 
 
 
754
    options, args = parser.parse_args(args)
820
755
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
821
756
                 v is not option.OptionParser.DEFAULT_VALUE])
822
757
    return args, opts
950
885
 
951
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
952
887
    from bzrlib.lsprof import profile
953
 
    ret, stats = profile(exception_to_return_code, the_callable,
954
 
                         *args, **kwargs)
 
888
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
955
889
    stats.sort()
956
890
    if filename is None:
957
891
        stats.pprint()
961
895
    return ret
962
896
 
963
897
 
 
898
def shlex_split_unicode(unsplit):
 
899
    import shlex
 
900
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
901
 
 
902
 
964
903
def get_alias(cmd, config=None):
965
904
    """Return an expanded alias, or None if no alias exists.
966
905
 
976
915
        config = bzrlib.config.GlobalConfig()
977
916
    alias = config.get_alias(cmd)
978
917
    if (alias):
979
 
        return cmdline.split(alias)
 
918
        return shlex_split_unicode(alias)
980
919
    return None
981
920
 
982
921
 
983
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
922
def run_bzr(argv):
984
923
    """Execute a command.
985
924
 
986
 
    :param argv: The command-line arguments, without the program name from
987
 
        argv[0] These should already be decoded. All library/test code calling
988
 
        run_bzr should be passing valid strings (don't need decoding).
989
 
    :param load_plugins: What function to call when triggering plugin loading.
990
 
        This function should take no arguments and cause all plugins to be
991
 
        loaded.
992
 
    :param disable_plugins: What function to call when disabling plugin
993
 
        loading. This function should take no arguments and cause all plugin
994
 
        loading to be prohibited (so that code paths in your application that
995
 
        know about some plugins possibly being present will fail to import
996
 
        those plugins even if they are installed.)
997
 
    :return: Returns a command exit code or raises an exception.
 
925
    argv
 
926
       The command-line arguments, without the program name from argv[0]
 
927
       These should already be decoded. All library/test code calling
 
928
       run_bzr should be passing valid strings (don't need decoding).
 
929
 
 
930
    Returns a command status or raises an exception.
998
931
 
999
932
    Special master options: these must come before the command because
1000
933
    they control how the command is interpreted.
1022
955
        Specify the number of processes that can be run concurrently (selftest).
1023
956
    """
1024
957
    trace.mutter("bazaar version: " + bzrlib.__version__)
1025
 
    argv = _specified_or_unicode_argv(argv)
 
958
    argv = list(argv)
1026
959
    trace.mutter("bzr arguments: %r", argv)
1027
960
 
1028
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1029
 
            opt_no_l10n = opt_no_aliases = False
 
961
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
962
                opt_no_aliases = False
1030
963
    opt_lsprof_file = opt_coverage_dir = None
1031
964
 
1032
965
    # --no-plugins is handled specially at a very early stage. We need
1049
982
            opt_no_plugins = True
1050
983
        elif a == '--no-aliases':
1051
984
            opt_no_aliases = True
1052
 
        elif a == '--no-l10n':
1053
 
            opt_no_l10n = True
1054
985
        elif a == '--builtin':
1055
986
            opt_builtin = True
1056
987
        elif a == '--concurrency':
1059
990
        elif a == '--coverage':
1060
991
            opt_coverage_dir = argv[i + 1]
1061
992
            i += 1
1062
 
        elif a == '--profile-imports':
1063
 
            pass # already handled in startup script Bug #588277
1064
993
        elif a.startswith('-D'):
1065
994
            debug.debug_flags.add(a[2:])
1066
995
        else:
1069
998
 
1070
999
    debug.set_debug_flags_from_config()
1071
1000
 
 
1001
    argv = argv_copy
 
1002
    if (not argv):
 
1003
        from bzrlib.builtins import cmd_help
 
1004
        cmd_help().run_argv_aliases([])
 
1005
        return 0
 
1006
 
 
1007
    if argv[0] == '--version':
 
1008
        from bzrlib.builtins import cmd_version
 
1009
        cmd_version().run_argv_aliases([])
 
1010
        return 0
 
1011
 
1072
1012
    if not opt_no_plugins:
 
1013
        from bzrlib.plugin import load_plugins
1073
1014
        load_plugins()
1074
1015
    else:
 
1016
        from bzrlib.plugin import disable_plugins
1075
1017
        disable_plugins()
1076
1018
 
1077
 
    argv = argv_copy
1078
 
    if (not argv):
1079
 
        get_cmd_object('help').run_argv_aliases([])
1080
 
        return 0
1081
 
 
1082
 
    if argv[0] == '--version':
1083
 
        get_cmd_object('version').run_argv_aliases([])
1084
 
        return 0
1085
 
 
1086
1019
    alias_argv = None
1087
1020
 
1088
1021
    if not opt_no_aliases:
1089
1022
        alias_argv = get_alias(argv[0])
1090
1023
        if alias_argv:
 
1024
            user_encoding = osutils.get_user_encoding()
 
1025
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1091
1026
            argv[0] = alias_argv.pop(0)
1092
1027
 
1093
1028
    cmd = argv.pop(0)
 
1029
    # We want only 'ascii' command names, but the user may have typed
 
1030
    # in a Unicode name. In that case, they should just get a
 
1031
    # 'command not found' error later.
 
1032
 
1094
1033
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1095
 
    if opt_no_l10n:
1096
 
        cmd.l10n = False
1097
1034
    run = cmd_obj.run_argv_aliases
1098
1035
    run_argv = [argv, alias_argv]
1099
1036
 
1162
1099
        "bzr plugin-provider-db check")
1163
1100
 
1164
1101
 
1165
 
 
1166
 
def _specified_or_unicode_argv(argv):
1167
 
    # For internal or testing use, argv can be passed.  Otherwise, get it from
1168
 
    # the process arguments in a unicode-safe way.
 
1102
def main(argv=None):
 
1103
    """Main entry point of command-line interface.
 
1104
 
 
1105
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1106
        argv[0] is script name usually, it will be ignored.
 
1107
        Don't pass here sys.argv because this list contains plain strings
 
1108
        and not unicode; pass None instead.
 
1109
 
 
1110
    :return: exit code of bzr command.
 
1111
    """
 
1112
    import bzrlib.ui
 
1113
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
1114
        sys.stdin, sys.stdout, sys.stderr)
 
1115
 
 
1116
    # Is this a final release version? If so, we should suppress warnings
 
1117
    if bzrlib.version_info[3] == 'final':
 
1118
        suppress_deprecation_warnings(override=True)
1169
1119
    if argv is None:
1170
 
        return osutils.get_unicode_argv()
 
1120
        argv = osutils.get_unicode_argv()
1171
1121
    else:
1172
1122
        new_argv = []
1173
1123
        try:
1174
1124
            # ensure all arguments are unicode strings
1175
 
            for a in argv:
 
1125
            for a in argv[1:]:
1176
1126
                if isinstance(a, unicode):
1177
1127
                    new_argv.append(a)
1178
1128
                else:
1179
1129
                    new_argv.append(a.decode('ascii'))
1180
1130
        except UnicodeDecodeError:
1181
1131
            raise errors.BzrError("argv should be list of unicode strings.")
1182
 
        return new_argv
1183
 
 
1184
 
 
1185
 
def main(argv=None):
1186
 
    """Main entry point of command-line interface.
1187
 
 
1188
 
    Typically `bzrlib.initialize` should be called first.
1189
 
 
1190
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1191
 
        argv[0] is script name usually, it will be ignored.
1192
 
        Don't pass here sys.argv because this list contains plain strings
1193
 
        and not unicode; pass None instead.
1194
 
 
1195
 
    :return: exit code of bzr command.
1196
 
    """
1197
 
    if argv is not None:
1198
 
        argv = argv[1:]
1199
 
    _register_builtin_commands()
 
1132
        argv = new_argv
1200
1133
    ret = run_bzr_catch_errors(argv)
 
1134
    bzrlib.ui.ui_factory.log_transport_activity(
 
1135
        display=('bytes' in debug.debug_flags))
1201
1136
    trace.mutter("return code %d", ret)
 
1137
    osutils.report_extension_load_failures()
1202
1138
    return ret
1203
1139
 
1204
1140
 
1208
1144
    This function assumed that that UI layer is setup, that symbol deprecations
1209
1145
    are already applied, and that unicode decoding has already been performed on argv.
1210
1146
    """
1211
 
    # done here so that they're covered for every test run
1212
1147
    install_bzr_command_hooks()
1213
1148
    return exception_to_return_code(run_bzr, argv)
1214
1149
 
1219
1154
    This is used for the test suite, and might be useful for other programs
1220
1155
    that want to wrap the commandline interface.
1221
1156
    """
1222
 
    # done here so that they're covered for every test run
1223
1157
    install_bzr_command_hooks()
1224
1158
    try:
1225
1159
        return run_bzr(argv)
1248
1182
        if topic and topic.startswith(self.prefix):
1249
1183
            topic = topic[len(self.prefix):]
1250
1184
        try:
1251
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1185
            cmd = _get_cmd_object(topic)
1252
1186
        except KeyError:
1253
1187
            return []
1254
1188
        else:
1256
1190
 
1257
1191
 
1258
1192
class Provider(object):
1259
 
    """Generic class to be overriden by plugins"""
 
1193
    '''Generic class to be overriden by plugins'''
1260
1194
 
1261
1195
    def plugin_for_command(self, cmd_name):
1262
 
        """Takes a command and returns the information for that plugin
 
1196
        '''Takes a command and returns the information for that plugin
1263
1197
 
1264
1198
        :return: A dictionary with all the available information
1265
 
            for the requested plugin
1266
 
        """
 
1199
        for the requested plugin
 
1200
        '''
1267
1201
        raise NotImplementedError
1268
1202
 
1269
1203
 
1270
1204
class ProvidersRegistry(registry.Registry):
1271
 
    """This registry exists to allow other providers to exist"""
 
1205
    '''This registry exists to allow other providers to exist'''
1272
1206
 
1273
1207
    def __iter__(self):
1274
1208
        for key, provider in self.iteritems():
1275
1209
            yield provider
1276
1210
 
1277
1211
command_providers_registry = ProvidersRegistry()
 
1212
 
 
1213
 
 
1214
if __name__ == '__main__':
 
1215
    sys.exit(main(sys.argv))