← 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-02-12 04:33:05 UTC
  • mfrom: (5031 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5032.
  • Revision ID: andrew.bennetts@canonical.com-20100212043305-ujdbsdoviql2t7i3
Merge lp:bzr

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) 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
 
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,
71
76
 
72
77
 
73
78
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
79
 
91
80
    @staticmethod
92
81
    def _get_name(command_name):
108
97
        try:
109
98
            previous = self.get(k_unsquished)
110
99
        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
 
100
            previous = _builtin_commands().get(k_unsquished)
117
101
        info = CommandInfo.from_command(cmd)
118
102
        try:
119
103
            registry.Registry.register(self, k_unsquished, cmd,
124
108
                sys.modules[cmd.__module__])
125
109
            trace.warning('Previously this command was registered from %r' %
126
110
                sys.modules[previous.__module__])
127
 
        for a in cmd.aliases:
128
 
            self._alias_dict[a] = k_unsquished
129
111
        return previous
130
112
 
131
113
    def register_lazy(self, command_name, aliases, module_name):
138
120
        key = self._get_name(command_name)
139
121
        registry.Registry.register_lazy(self, key, module_name, command_name,
140
122
                                        info=CommandInfo(aliases))
141
 
        for a in aliases:
142
 
            self._alias_dict[a] = key
143
123
 
144
124
 
145
125
plugin_cmds = CommandRegistry()
146
 
builtin_command_registry = CommandRegistry()
147
 
plugin_cmds.overridden_registry = builtin_command_registry
148
126
 
149
127
 
150
128
def register_command(cmd, decorate=False):
151
 
    """Register a plugin command.
152
 
 
153
 
    Should generally be avoided in favor of lazy registration. 
154
 
    """
155
129
    global plugin_cmds
156
130
    return plugin_cmds.register(cmd, decorate)
157
131
 
164
138
    return cmd[4:].replace('_','-')
165
139
 
166
140
 
167
 
def _register_builtin_commands():
168
 
    if builtin_command_registry.keys():
169
 
        # only load once
170
 
        return
 
141
def _builtin_commands():
171
142
    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()
 
143
    return _scan_module_for_commands(bzrlib.builtins)
175
144
 
176
145
 
177
146
def _scan_module_for_commands(module):
184
153
 
185
154
 
186
155
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
 
    """
 
156
    """Find commands from bzr's core and plugins."""
191
157
    # to eliminate duplicates
192
158
    names.update(builtin_command_names())
193
159
    names.update(plugin_command_names())
211
177
    Use of all_command_names() is encouraged rather than builtin_command_names
212
178
    and/or plugin_command_names.
213
179
    """
214
 
    _register_builtin_commands()
215
 
    return builtin_command_registry.keys()
 
180
    return _builtin_commands().keys()
216
181
 
217
182
 
218
183
def plugin_command_names():
232
197
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
233
198
 
234
199
 
235
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
200
def _get_cmd_object(cmd_name, plugins_override=True):
236
201
    """Get a command object.
237
202
 
238
203
    :param cmd_name: The name of the command.
239
204
    :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
205
    :return: A Command object instance
243
206
    :raises KeyError: If no command is found.
244
207
    """
254
217
            # We've found a non-plugin command, don't permit it to be
255
218
            # overridden.
256
219
            break
257
 
    if cmd is None and check_missing:
 
220
    if cmd is None:
258
221
        for hook in Command.hooks['get_missing_command']:
259
222
            cmd = hook(cmd_name)
260
223
            if cmd is not None:
265
228
    # Allow plugins to extend commands
266
229
    for hook in Command.hooks['extend_command']:
267
230
        hook(cmd)
268
 
    if getattr(cmd, 'invoked_as', None) is None:
269
 
        cmd.invoked_as = cmd_name
270
231
    return cmd
271
232
 
272
233
 
298
259
 
299
260
def _get_bzr_command(cmd_or_None, cmd_name):
300
261
    """Get a command from bzr's core."""
 
262
    cmds = _builtin_commands()
301
263
    try:
302
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
264
        return cmds[cmd_name]()
303
265
    except KeyError:
304
266
        pass
305
 
    else:
306
 
        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()
307
271
    return cmd_or_None
308
272
 
309
273
 
349
313
    summary, then a complete description of the command.  A grammar
350
314
    description will be inserted.
351
315
 
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
 
316
    aliases
 
317
        Other accepted names for this command.
 
318
 
 
319
    takes_args
 
320
        List of argument forms, marked with whether they are optional,
 
321
        repeated, etc.
 
322
 
 
323
                Examples:
 
324
 
 
325
                ['to_location', 'from_branch?', 'file*']
 
326
 
 
327
                'to_location' is required
 
328
                'from_branch' is optional
 
329
                'file' can be specified 0 or more times
 
330
 
 
331
    takes_options
 
332
        List of options that may be given for this command.  These can
 
333
        be either strings, referring to globally-defined options,
 
334
        or option objects.  Retrieve through options().
 
335
 
 
336
    hidden
 
337
        If true, this command isn't advertised.  This is typically
368
338
        for commands intended for expert users.
369
339
 
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.)
 
340
    encoding_type
 
341
        Command objects will get a 'outf' attribute, which has been
 
342
        setup to properly handle encoding of unicode strings.
 
343
        encoding_type determines what will happen when characters cannot
 
344
        be encoded
 
345
            strict - abort if we cannot decode
 
346
            replace - put in a bogus character (typically '?')
 
347
            exact - do not encode sys.stdout
 
348
 
 
349
            NOTE: by default on Windows, sys.stdout is opened as a text
 
350
            stream, therefore LF line-endings are converted to CRLF.
 
351
            When a command uses encoding_type = 'exact', then
 
352
            sys.stdout is forced to be a binary stream, and line-endings
 
353
            will not mangled.
388
354
 
389
355
    :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
356
    """
398
357
    aliases = []
399
358
    takes_args = []
400
359
    takes_options = []
401
360
    encoding_type = 'strict'
402
 
    invoked_as = None
403
 
    l10n = True
404
361
 
405
362
    hidden = False
406
363
 
407
364
    def __init__(self):
408
365
        """Construct an instance of this command."""
 
366
        if self.__doc__ == Command.__doc__:
 
367
            warn("No help message set for %r" % self)
409
368
        # List of standard options directly supported
410
369
        self.supported_std_options = []
411
 
        self._setup_run()
412
 
 
 
370
        self._operation = cleanup.OperationWithCleanups(self.run)
 
371
    
413
372
    def add_cleanup(self, cleanup_func, *args, **kwargs):
414
373
        """Register a function to call after self.run returns or raises.
415
374
 
426
385
 
427
386
        This is useful for releasing expensive or contentious resources (such
428
387
        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.
 
388
        resources (such as writing results to self.outf).
432
389
        """
433
390
        self._operation.cleanup_now()
 
391
        
 
392
    @deprecated_method(deprecated_in((2, 1, 0)))
 
393
    def _maybe_expand_globs(self, file_list):
 
394
        """Glob expand file_list if the platform does not do that itself.
 
395
 
 
396
        Not used anymore, now that the bzr command-line parser globs on
 
397
        Windows.
 
398
 
 
399
        :return: A possibly empty list of unicode paths.
 
400
 
 
401
        Introduced in bzrlib 0.18.
 
402
        """
 
403
        return file_list
434
404
 
435
405
    def _usage(self):
436
406
        """Return single-line grammar for this command.
465
435
            usage help (e.g. Purpose, Usage, Options) with a
466
436
            message explaining how to obtain full help.
467
437
        """
468
 
        if self.l10n and not i18n.installed():
469
 
            i18n.install()  # Install i18n only for get_help_text for now.
470
438
        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.")
 
439
        if doc is None:
 
440
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
480
441
 
481
442
        # Extract the summary (purpose) and sections out from the text
482
443
        purpose,sections,order = self._get_help_parts(doc)
489
450
 
490
451
        # The header is the purpose and usage
491
452
        result = ""
492
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
453
        result += ':Purpose: %s\n' % purpose
493
454
        if usage.find('\n') >= 0:
494
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
455
            result += ':Usage:\n%s\n' % usage
495
456
        else:
496
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
457
            result += ':Usage:   %s\n' % usage
497
458
        result += '\n'
498
459
 
499
460
        # Add the options
501
462
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
502
463
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
503
464
        # 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:
 
465
        options = option.get_optparser(self.options()).format_option_help()
 
466
        # XXX: According to the spec, ReST option lists actually don't support 
 
467
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
468
        # As that pattern always appears in the commands that break, we trap
 
469
        # on that and then format that block of 'format' options as a literal
 
470
        # block.
 
471
        if not plain and options.find('  --1.9  ') != -1:
513
472
            options = options.replace(' format:\n', ' format::\n\n', 1)
514
473
        if options.startswith('Options:'):
515
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
474
            result += ':' + options
 
475
        elif options.startswith('options:'):
 
476
            # Python 2.4 version of optparse
 
477
            result += ':Options:' + options[len('options:'):]
516
478
        else:
517
479
            result += options
518
480
        result += '\n'
523
485
            if sections.has_key(None):
524
486
                text = sections.pop(None)
525
487
                text = '\n  '.join(text.splitlines())
526
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
488
                result += ':%s:\n  %s\n\n' % ('Description',text)
527
489
 
528
490
            # Add the custom sections (e.g. Examples). Note that there's no need
529
491
            # to indent these as they must be indented already in the source.
530
492
            if sections:
531
493
                for label in order:
532
 
                    if label in sections:
533
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
494
                    if sections.has_key(label):
 
495
                        result += ':%s:\n%s\n' % (label,sections[label])
534
496
                result += '\n'
535
497
        else:
536
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
498
            result += ("See bzr help %s for more details and examples.\n\n"
537
499
                % self.name())
538
500
 
539
501
        # Add the aliases, source (plug-in) and see also links, if any
540
502
        if self.aliases:
541
 
            result += gettext(':Aliases:  ')
 
503
            result += ':Aliases:  '
542
504
            result += ', '.join(self.aliases) + '\n'
543
505
        plugin_name = self.plugin_name()
544
506
        if plugin_name is not None:
545
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
507
            result += ':From:     plugin "%s"\n' % plugin_name
546
508
        see_also = self.get_see_also(additional_see_also)
547
509
        if see_also:
548
510
            if not plain and see_also_as_links:
554
516
                        see_also_links.append(item)
555
517
                    else:
556
518
                        # Use a Sphinx link for this entry
557
 
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
 
519
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
558
520
                        see_also_links.append(link_text)
559
521
                see_also = see_also_links
560
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
522
            result += ':See also: '
 
523
            result += ', '.join(see_also) + '\n'
561
524
 
562
525
        # If this will be rendered as plain text, convert it
563
526
        if plain:
644
607
    def run_argv_aliases(self, argv, alias_argv=None):
645
608
        """Parse the command line and run with extra aliases in alias_argv."""
646
609
        args, opts = parse_args(self, argv, alias_argv)
647
 
        self._setup_outf()
648
610
 
649
611
        # Process the standard options
650
612
        if 'help' in opts:  # e.g. bzr add --help
651
 
            self.outf.write(self.get_help_text())
 
613
            sys.stdout.write(self.get_help_text())
652
614
            return 0
653
615
        if 'usage' in opts:  # e.g. bzr add --usage
654
 
            self.outf.write(self.get_help_text(verbose=False))
 
616
            sys.stdout.write(self.get_help_text(verbose=False))
655
617
            return 0
656
618
        trace.set_verbosity_level(option._verbosity_level)
657
619
        if 'verbose' in self.supported_std_options:
672
634
        all_cmd_args = cmdargs.copy()
673
635
        all_cmd_args.update(cmdopts)
674
636
 
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
 
637
        self._setup_outf()
 
638
 
 
639
        return self.run_direct(**all_cmd_args)
 
640
 
 
641
    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)
702
644
 
703
645
    def run(self):
704
646
        """Actually run the command.
709
651
        Return 0 or None if the command was successful, or a non-zero
710
652
        shell error code if not.  It's OK for this method to allow
711
653
        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
654
        """
724
655
        raise NotImplementedError('no implementation of command %r'
725
656
                                  % self.name())
731
662
            return None
732
663
        return getdoc(self)
733
664
 
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
665
    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
666
        return _unsquish_command_name(self.__class__.__name__)
748
667
 
749
668
    def plugin_name(self):
767
686
        These are all empty initially, because by default nothing should get
768
687
        notified.
769
688
        """
770
 
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
 
        self.add_hook('extend_command',
 
689
        Hooks.__init__(self)
 
690
        self.create_hook(HookPoint('extend_command',
772
691
            "Called after creating a command object to allow modifications "
773
692
            "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',
 
693
            "new bzrlib.commands.Command object.", (1, 13), None))
 
694
        self.create_hook(HookPoint('get_command',
776
695
            "Called when creating a single command. Called with "
777
696
            "(cmd_or_None, command_name). get_command should either return "
778
697
            "the cmd_or_None parameter, or a replacement Command object that "
779
698
            "should be used for the command. Note that the Command.hooks "
780
699
            "hooks are core infrastructure. Many users will prefer to use "
781
700
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
 
            (1, 17))
783
 
        self.add_hook('get_missing_command',
 
701
            (1, 17), None))
 
702
        self.create_hook(HookPoint('get_missing_command',
784
703
            "Called when creating a single command if no command could be "
785
704
            "found. Called with (command_name). get_missing_command should "
786
705
            "either return None, or a Command object to be used for the "
787
 
            "command.", (1, 17))
788
 
        self.add_hook('list_commands',
 
706
            "command.", (1, 17), None))
 
707
        self.create_hook(HookPoint('list_commands',
789
708
            "Called when enumerating commands. Called with a set of "
790
709
            "cmd_name strings for all the commands found so far. This set "
791
710
            " is safe to mutate - e.g. to remove a command. "
792
711
            "list_commands should return the updated set of command names.",
793
 
            (1, 17))
 
712
            (1, 17), None))
794
713
 
795
714
Command.hooks = CommandHooks()
796
715
 
810
729
    else:
811
730
        args = argv
812
731
 
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
 
 
 
732
    options, args = parser.parse_args(args)
820
733
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
821
734
                 v is not option.OptionParser.DEFAULT_VALUE])
822
735
    return args, opts
950
863
 
951
864
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
952
865
    from bzrlib.lsprof import profile
953
 
    ret, stats = profile(exception_to_return_code, the_callable,
954
 
                         *args, **kwargs)
 
866
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
955
867
    stats.sort()
956
868
    if filename is None:
957
869
        stats.pprint()
961
873
    return ret
962
874
 
963
875
 
 
876
def shlex_split_unicode(unsplit):
 
877
    import shlex
 
878
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
879
 
 
880
 
964
881
def get_alias(cmd, config=None):
965
882
    """Return an expanded alias, or None if no alias exists.
966
883
 
976
893
        config = bzrlib.config.GlobalConfig()
977
894
    alias = config.get_alias(cmd)
978
895
    if (alias):
979
 
        return cmdline.split(alias)
 
896
        return shlex_split_unicode(alias)
980
897
    return None
981
898
 
982
899
 
983
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
900
def run_bzr(argv):
984
901
    """Execute a command.
985
902
 
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.
 
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.
998
909
 
999
910
    Special master options: these must come before the command because
1000
911
    they control how the command is interpreted.
1022
933
        Specify the number of processes that can be run concurrently (selftest).
1023
934
    """
1024
935
    trace.mutter("bazaar version: " + bzrlib.__version__)
1025
 
    argv = _specified_or_unicode_argv(argv)
 
936
    argv = list(argv)
1026
937
    trace.mutter("bzr arguments: %r", argv)
1027
938
 
1028
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1029
 
            opt_no_l10n = opt_no_aliases = False
 
939
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
940
                opt_no_aliases = False
1030
941
    opt_lsprof_file = opt_coverage_dir = None
1031
942
 
1032
943
    # --no-plugins is handled specially at a very early stage. We need
1049
960
            opt_no_plugins = True
1050
961
        elif a == '--no-aliases':
1051
962
            opt_no_aliases = True
1052
 
        elif a == '--no-l10n':
1053
 
            opt_no_l10n = True
1054
963
        elif a == '--builtin':
1055
964
            opt_builtin = True
1056
965
        elif a == '--concurrency':
1059
968
        elif a == '--coverage':
1060
969
            opt_coverage_dir = argv[i + 1]
1061
970
            i += 1
1062
 
        elif a == '--profile-imports':
1063
 
            pass # already handled in startup script Bug #588277
1064
971
        elif a.startswith('-D'):
1065
972
            debug.debug_flags.add(a[2:])
1066
973
        else:
1069
976
 
1070
977
    debug.set_debug_flags_from_config()
1071
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
 
1072
990
    if not opt_no_plugins:
 
991
        from bzrlib.plugin import load_plugins
1073
992
        load_plugins()
1074
993
    else:
 
994
        from bzrlib.plugin import disable_plugins
1075
995
        disable_plugins()
1076
996
 
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
997
    alias_argv = None
1087
998
 
1088
999
    if not opt_no_aliases:
1089
1000
        alias_argv = get_alias(argv[0])
1090
1001
        if alias_argv:
 
1002
            user_encoding = osutils.get_user_encoding()
 
1003
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1091
1004
            argv[0] = alias_argv.pop(0)
1092
1005
 
1093
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
 
1094
1011
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1095
 
    if opt_no_l10n:
1096
 
        cmd.l10n = False
1097
1012
    run = cmd_obj.run_argv_aliases
1098
1013
    run_argv = [argv, alias_argv]
1099
1014
 
1172
1087
        new_argv = []
1173
1088
        try:
1174
1089
            # ensure all arguments are unicode strings
1175
 
            for a in argv:
 
1090
            for a in argv[1:]:
1176
1091
                if isinstance(a, unicode):
1177
1092
                    new_argv.append(a)
1178
1093
                else:
1194
1109
 
1195
1110
    :return: exit code of bzr command.
1196
1111
    """
1197
 
    if argv is not None:
1198
 
        argv = argv[1:]
1199
 
    _register_builtin_commands()
 
1112
    argv = _specified_or_unicode_argv(argv)
1200
1113
    ret = run_bzr_catch_errors(argv)
 
1114
    bzrlib.ui.ui_factory.log_transport_activity(
 
1115
        display=('bytes' in debug.debug_flags))
1201
1116
    trace.mutter("return code %d", ret)
1202
1117
    return ret
1203
1118
 
1248
1163
        if topic and topic.startswith(self.prefix):
1249
1164
            topic = topic[len(self.prefix):]
1250
1165
        try:
1251
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
1166
            cmd = _get_cmd_object(topic)
1252
1167
        except KeyError:
1253
1168
            return []
1254
1169
        else:
1256
1171
 
1257
1172
 
1258
1173
class Provider(object):
1259
 
    """Generic class to be overriden by plugins"""
 
1174
    '''Generic class to be overriden by plugins'''
1260
1175
 
1261
1176
    def plugin_for_command(self, cmd_name):
1262
 
        """Takes a command and returns the information for that plugin
 
1177
        '''Takes a command and returns the information for that plugin
1263
1178
 
1264
1179
        :return: A dictionary with all the available information
1265
 
            for the requested plugin
1266
 
        """
 
1180
        for the requested plugin
 
1181
        '''
1267
1182
        raise NotImplementedError
1268
1183
 
1269
1184
 
1270
1185
class ProvidersRegistry(registry.Registry):
1271
 
    """This registry exists to allow other providers to exist"""
 
1186
    '''This registry exists to allow other providers to exist'''
1272
1187
 
1273
1188
    def __iter__(self):
1274
1189
        for key, provider in self.iteritems():