/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 breezy/commands.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/commands.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
17
18
 
18
19
# TODO: Define arguments by objects, rather than just using names.
19
20
# Those objects can specify the expected type of the argument, which
25
26
import os
26
27
import sys
27
28
 
28
 
from bzrlib.lazy_import import lazy_import
 
29
from . import (
 
30
    i18n,
 
31
    option,
 
32
    osutils,
 
33
    )
 
34
 
 
35
from .lazy_import import lazy_import
29
36
lazy_import(globals(), """
30
 
import codecs
31
37
import errno
32
 
import threading
33
 
from warnings import warn
34
38
 
35
 
import bzrlib
36
 
from bzrlib import (
 
39
import breezy
 
40
from breezy import (
37
41
    cleanup,
38
42
    cmdline,
39
43
    debug,
40
 
    errors,
41
 
    option,
42
 
    osutils,
43
44
    trace,
44
45
    ui,
45
 
    win32utils,
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.hooks import HookPoint, Hooks
 
49
from .hooks import Hooks
 
50
from .i18n import gettext
50
51
# Compatibility - Option used to be in commands.
51
 
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
 
from bzrlib import registry
54
 
from bzrlib.symbol_versioning import (
55
 
    deprecated_function,
56
 
    deprecated_in,
57
 
    deprecated_method,
 
52
from .option import Option
 
53
from .plugin import disable_plugins, load_plugins, plugin_name
 
54
from . import errors, registry
 
55
from .sixish import (
 
56
    string_types,
58
57
    )
59
58
 
60
59
 
 
60
class BzrOptionError(errors.BzrCommandError):
 
61
 
 
62
    _fmt = "Error in command line options"
 
63
 
 
64
 
 
65
class CommandAvailableInPlugin(Exception):
 
66
 
 
67
    internal_error = False
 
68
 
 
69
    def __init__(self, cmd_name, plugin_metadata, provider):
 
70
 
 
71
        self.plugin_metadata = plugin_metadata
 
72
        self.cmd_name = cmd_name
 
73
        self.provider = provider
 
74
 
 
75
    def __str__(self):
 
76
 
 
77
        _fmt = ('"%s" is not a standard brz command. \n'
 
78
                'However, the following official plugin provides this command: %s\n'
 
79
                'You can install it by going to: %s'
 
80
                % (self.cmd_name, self.plugin_metadata['name'],
 
81
                    self.plugin_metadata['url']))
 
82
 
 
83
        return _fmt
 
84
 
 
85
 
61
86
class CommandInfo(object):
62
87
    """Information about a command."""
63
88
 
73
98
 
74
99
class CommandRegistry(registry.Registry):
75
100
    """Special registry mapping command names to command classes.
76
 
    
 
101
 
77
102
    :ivar overridden_registry: Look in this registry for commands being
78
103
        overridden by this registry.  This can be used to tell plugin commands
79
104
        about the builtin they're decorating.
122
147
        except KeyError:
123
148
            trace.warning('Two plugins defined the same command: %r' % k)
124
149
            trace.warning('Not loading the one in %r' %
125
 
                sys.modules[cmd.__module__])
 
150
                          sys.modules[cmd.__module__])
126
151
            trace.warning('Previously this command was registered from %r' %
127
 
                sys.modules[previous.__module__])
 
152
                          sys.modules[previous.__module__])
128
153
        for a in cmd.aliases:
129
154
            self._alias_dict[a] = k_unsquished
130
155
        return previous
151
176
def register_command(cmd, decorate=False):
152
177
    """Register a plugin command.
153
178
 
154
 
    Should generally be avoided in favor of lazy registration. 
 
179
    Should generally be avoided in favor of lazy registration.
155
180
    """
156
181
    global plugin_cmds
157
182
    return plugin_cmds.register(cmd, decorate)
162
187
 
163
188
 
164
189
def _unsquish_command_name(cmd):
165
 
    return cmd[4:].replace('_','-')
166
 
 
167
 
 
168
 
@deprecated_function(deprecated_in((2, 2, 0)))
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())
 
190
    return cmd[4:].replace('_', '-')
176
191
 
177
192
 
178
193
def _register_builtin_commands():
179
194
    if builtin_command_registry.keys():
180
195
        # only load once
181
196
        return
182
 
    import bzrlib.builtins
183
 
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
 
197
    import breezy.builtins
 
198
    for cmd_class in _scan_module_for_commands(breezy.builtins):
184
199
        builtin_command_registry.register(cmd_class)
185
 
    bzrlib.builtins._register_lazy_builtins()
 
200
    breezy.builtins._register_lazy_builtins()
186
201
 
187
202
 
188
203
def _scan_module_for_commands(module):
189
 
    r = {}
190
 
    for name, obj in module.__dict__.iteritems():
 
204
    module_dict = module.__dict__
 
205
    for name in module_dict:
191
206
        if name.startswith("cmd_"):
192
 
            real_name = _unsquish_command_name(name)
193
 
            r[real_name] = obj
194
 
    return r
 
207
            yield module_dict[name]
195
208
 
196
209
 
197
210
def _list_bzr_commands(names):
198
211
    """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.
 
212
 
 
213
    This is not the public interface, just the default hook called by
 
214
    all_command_names.
201
215
    """
202
216
    # to eliminate duplicates
203
217
    names.update(builtin_command_names())
218
232
 
219
233
def builtin_command_names():
220
234
    """Return list of builtin command names.
221
 
    
 
235
 
222
236
    Use of all_command_names() is encouraged rather than builtin_command_names
223
237
    and/or plugin_command_names.
224
238
    """
 
239
    _register_builtin_commands()
225
240
    return builtin_command_registry.keys()
226
241
 
227
242
 
230
245
    return plugin_cmds.keys()
231
246
 
232
247
 
 
248
# Overrides for common mispellings that heuristics get wrong
 
249
_GUESS_OVERRIDES = {
 
250
    'ic': {'ci': 0},  # heuristic finds nick
 
251
    }
 
252
 
 
253
 
 
254
def guess_command(cmd_name):
 
255
    """Guess what command a user typoed.
 
256
 
 
257
    :param cmd_name: Command to search for
 
258
    :return: None if no command was found, name of a command otherwise
 
259
    """
 
260
    names = set()
 
261
    for name in all_command_names():
 
262
        names.add(name)
 
263
        cmd = get_cmd_object(name)
 
264
        names.update(cmd.aliases)
 
265
    # candidate: modified levenshtein distance against cmd_name.
 
266
    costs = {}
 
267
    from . import patiencediff
 
268
    for name in sorted(names):
 
269
        matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
 
270
        distance = 0.0
 
271
        opcodes = matcher.get_opcodes()
 
272
        for opcode, l1, l2, r1, r2 in opcodes:
 
273
            if opcode == 'delete':
 
274
                distance += l2 - l1
 
275
            elif opcode == 'replace':
 
276
                distance += max(l2 - l1, r2 - l1)
 
277
            elif opcode == 'insert':
 
278
                distance += r2 - r1
 
279
            elif opcode == 'equal':
 
280
                # Score equal ranges lower, making similar commands of equal
 
281
                # length closer than arbitrary same length commands.
 
282
                distance -= 0.1 * (l2 - l1)
 
283
        costs[name] = distance
 
284
    costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
 
285
    costs = sorted((costs[key], key) for key in costs)
 
286
    if not costs:
 
287
        return
 
288
    if costs[0][0] > 4:
 
289
        return
 
290
    candidate = costs[0][1]
 
291
    return candidate
 
292
 
 
293
 
233
294
def get_cmd_object(cmd_name, plugins_override=True):
234
295
    """Return the command object for a command.
235
296
 
239
300
    try:
240
301
        return _get_cmd_object(cmd_name, plugins_override)
241
302
    except KeyError:
242
 
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
 
303
        # No command found, see if this was a typo
 
304
        candidate = guess_command(cmd_name)
 
305
        if candidate is not None:
 
306
            raise errors.BzrCommandError(
 
307
                gettext('unknown command "%s". Perhaps you meant "%s"')
 
308
                % (cmd_name, candidate))
 
309
        raise errors.BzrCommandError(gettext('unknown command "%s"')
 
310
                                     % cmd_name)
243
311
 
244
312
 
245
313
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
275
343
    # Allow plugins to extend commands
276
344
    for hook in Command.hooks['extend_command']:
277
345
        hook(cmd)
 
346
    if getattr(cmd, 'invoked_as', None) is None:
 
347
        cmd.invoked_as = cmd_name
278
348
    return cmd
279
349
 
280
350
 
 
351
class NoPluginAvailable(errors.BzrError):
 
352
    pass
 
353
 
 
354
 
281
355
def _try_plugin_provider(cmd_name):
282
356
    """Probe for a plugin provider having cmd_name."""
283
357
    try:
284
358
        plugin_metadata, provider = probe_for_provider(cmd_name)
285
 
        raise errors.CommandAvailableInPlugin(cmd_name,
286
 
            plugin_metadata, provider)
287
 
    except errors.NoPluginAvailable:
 
359
        raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
 
360
    except NoPluginAvailable:
288
361
        pass
289
362
 
290
363
 
299
372
    for provider in command_providers_registry:
300
373
        try:
301
374
            return provider.plugin_for_command(cmd_name), provider
302
 
        except errors.NoPluginAvailable:
 
375
        except NoPluginAvailable:
303
376
            pass
304
 
    raise errors.NoPluginAvailable(cmd_name)
 
377
    raise NoPluginAvailable(cmd_name)
305
378
 
306
379
 
307
380
def _get_bzr_command(cmd_or_None, cmd_name):
320
393
    # Only do external command lookups when no command is found so far.
321
394
    if cmd_or_None is not None:
322
395
        return cmd_or_None
323
 
    from bzrlib.externalcommand import ExternalCommand
 
396
    from breezy.externalcommand import ExternalCommand
324
397
    cmd_obj = ExternalCommand.find_command(cmd_name)
325
398
    if cmd_obj:
326
399
        return cmd_obj
327
400
 
328
401
 
329
402
def _get_plugin_command(cmd_or_None, cmd_name):
330
 
    """Get a command from bzr's plugins."""
 
403
    """Get a command from brz's plugins."""
331
404
    try:
332
405
        return plugin_cmds.get(cmd_name)()
333
406
    except KeyError:
342
415
class Command(object):
343
416
    """Base class for commands.
344
417
 
345
 
    Commands are the heart of the command-line bzr interface.
 
418
    Commands are the heart of the command-line brz interface.
346
419
 
347
420
    The command object mostly handles the mapping of command-line
348
 
    parameters into one or more bzrlib operations, and of the results
 
421
    parameters into one or more breezy operations, and of the results
349
422
    into textual output.
350
423
 
351
424
    Commands normally don't have any state.  All their arguments are
357
430
    summary, then a complete description of the command.  A grammar
358
431
    description will be inserted.
359
432
 
360
 
    aliases
361
 
        Other accepted names for this command.
362
 
 
363
 
    takes_args
364
 
        List of argument forms, marked with whether they are optional,
365
 
        repeated, etc.
366
 
 
367
 
                Examples:
368
 
 
369
 
                ['to_location', 'from_branch?', 'file*']
370
 
 
371
 
                'to_location' is required
372
 
                'from_branch' is optional
373
 
                'file' can be specified 0 or more times
374
 
 
375
 
    takes_options
376
 
        List of options that may be given for this command.  These can
377
 
        be either strings, referring to globally-defined options,
378
 
        or option objects.  Retrieve through options().
379
 
 
380
 
    hidden
381
 
        If true, this command isn't advertised.  This is typically
 
433
    :cvar aliases: Other accepted names for this command.
 
434
 
 
435
    :cvar takes_args: List of argument forms, marked with whether they are
 
436
        optional, repeated, etc.  Examples::
 
437
 
 
438
            ['to_location', 'from_branch?', 'file*']
 
439
 
 
440
        * 'to_location' is required
 
441
        * 'from_branch' is optional
 
442
        * 'file' can be specified 0 or more times
 
443
 
 
444
    :cvar takes_options: List of options that may be given for this command.
 
445
        These can be either strings, referring to globally-defined options, or
 
446
        option objects.  Retrieve through options().
 
447
 
 
448
    :cvar hidden: If true, this command isn't advertised.  This is typically
382
449
        for commands intended for expert users.
383
450
 
384
 
    encoding_type
385
 
        Command objects will get a 'outf' attribute, which has been
386
 
        setup to properly handle encoding of unicode strings.
387
 
        encoding_type determines what will happen when characters cannot
388
 
        be encoded
389
 
            strict - abort if we cannot decode
390
 
            replace - put in a bogus character (typically '?')
391
 
            exact - do not encode sys.stdout
392
 
 
393
 
            NOTE: by default on Windows, sys.stdout is opened as a text
394
 
            stream, therefore LF line-endings are converted to CRLF.
395
 
            When a command uses encoding_type = 'exact', then
396
 
            sys.stdout is forced to be a binary stream, and line-endings
397
 
            will not mangled.
 
451
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
 
452
        been setup to properly handle encoding of unicode strings.
 
453
        encoding_type determines what will happen when characters cannot be
 
454
        encoded:
 
455
 
 
456
        * strict - abort if we cannot decode
 
457
        * replace - put in a bogus character (typically '?')
 
458
        * exact - do not encode sys.stdout
 
459
 
 
460
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
 
461
        therefore LF line-endings are converted to CRLF.  When a command uses
 
462
        encoding_type = 'exact', then sys.stdout is forced to be a binary
 
463
        stream, and line-endings will not mangled.
 
464
 
 
465
    :cvar invoked_as:
 
466
        A string indicating the real name under which this command was
 
467
        invoked, before expansion of aliases.
 
468
        (This may be None if the command was constructed and run in-process.)
398
469
 
399
470
    :cvar hooks: An instance of CommandHooks.
 
471
 
 
472
    :cvar __doc__: The help shown by 'brz help command' for this command.
 
473
        This is set by assigning explicitly to __doc__ so that -OO can
 
474
        be used::
 
475
 
 
476
            class Foo(Command):
 
477
                __doc__ = "My help goes here"
400
478
    """
401
479
    aliases = []
402
480
    takes_args = []
403
481
    takes_options = []
404
482
    encoding_type = 'strict'
 
483
    invoked_as = None
 
484
    l10n = True
405
485
 
406
486
    hidden = False
407
487
 
408
488
    def __init__(self):
409
489
        """Construct an instance of this command."""
410
 
        if self.__doc__ == Command.__doc__:
411
 
            warn("No help message set for %r" % self)
412
490
        # List of standard options directly supported
413
491
        self.supported_std_options = []
414
492
        self._setup_run()
435
513
        """
436
514
        self._operation.cleanup_now()
437
515
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
 
    def _maybe_expand_globs(self, file_list):
440
 
        """Glob expand file_list if the platform does not do that itself.
441
 
 
442
 
        Not used anymore, now that the bzr command-line parser globs on
443
 
        Windows.
444
 
 
445
 
        :return: A possibly empty list of unicode paths.
446
 
 
447
 
        Introduced in bzrlib 0.18.
448
 
        """
449
 
        return file_list
450
 
 
451
516
    def _usage(self):
452
517
        """Return single-line grammar for this command.
453
518
 
454
519
        Only describes arguments, not options.
455
520
        """
456
 
        s = 'bzr ' + self.name() + ' '
 
521
        s = 'brz ' + self.name() + ' '
457
522
        for aname in self.takes_args:
458
523
            aname = aname.upper()
459
524
            if aname[-1] in ['$', '+']:
481
546
            usage help (e.g. Purpose, Usage, Options) with a
482
547
            message explaining how to obtain full help.
483
548
        """
 
549
        if self.l10n:
 
550
            i18n.install()  # Install i18n only for get_help_text for now.
484
551
        doc = self.help()
485
 
        if doc is None:
486
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
552
        if doc:
 
553
            # Note: If self.gettext() translates ':Usage:\n', the section will
 
554
            # be shown after "Description" section and we don't want to
 
555
            # translate the usage string.
 
556
            # Though, brz export-pot don't exports :Usage: section and it must
 
557
            # not be translated.
 
558
            doc = self.gettext(doc)
 
559
        else:
 
560
            doc = gettext("No help for this command.")
487
561
 
488
562
        # Extract the summary (purpose) and sections out from the text
489
 
        purpose,sections,order = self._get_help_parts(doc)
 
563
        purpose, sections, order = self._get_help_parts(doc)
490
564
 
491
565
        # If a custom usage section was provided, use it
492
 
        if sections.has_key('Usage'):
 
566
        if 'Usage' in sections:
493
567
            usage = sections.pop('Usage')
494
568
        else:
495
569
            usage = self._usage()
496
570
 
497
571
        # The header is the purpose and usage
498
572
        result = ""
499
 
        result += ':Purpose: %s\n' % purpose
 
573
        result += gettext(':Purpose: %s\n') % (purpose,)
500
574
        if usage.find('\n') >= 0:
501
 
            result += ':Usage:\n%s\n' % usage
 
575
            result += gettext(':Usage:\n%s\n') % (usage,)
502
576
        else:
503
 
            result += ':Usage:   %s\n' % usage
 
577
            result += gettext(':Usage:   %s\n') % (usage,)
504
578
        result += '\n'
505
579
 
506
580
        # Add the options
508
582
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
509
583
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
510
584
        # 20090319
511
 
        options = option.get_optparser(self.options()).format_option_help()
512
 
        # XXX: According to the spec, ReST option lists actually don't support 
513
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
514
 
        # As that pattern always appears in the commands that break, we trap
515
 
        # on that and then format that block of 'format' options as a literal
516
 
        # block.
517
 
        if not plain and options.find('  --1.9  ') != -1:
 
585
        parser = option.get_optparser(
 
586
            [v for k, v in sorted(self.options().items())])
 
587
        options = parser.format_option_help()
 
588
        # FIXME: According to the spec, ReST option lists actually don't
 
589
        # support options like --1.14 so that causes syntax errors (in Sphinx
 
590
        # at least).  As that pattern always appears in the commands that
 
591
        # break, we trap on that and then format that block of 'format' options
 
592
        # as a literal block. We use the most recent format still listed so we
 
593
        # don't have to do that too often -- vila 20110514
 
594
        if not plain and options.find('  --1.14  ') != -1:
518
595
            options = options.replace(' format:\n', ' format::\n\n', 1)
519
596
        if options.startswith('Options:'):
520
 
            result += ':' + options
521
 
        elif options.startswith('options:'):
522
 
            # Python 2.4 version of optparse
523
 
            result += ':Options:' + options[len('options:'):]
 
597
            result += gettext(':Options:%s') % (options[len('options:'):],)
524
598
        else:
525
599
            result += options
526
600
        result += '\n'
528
602
        if verbose:
529
603
            # Add the description, indenting it 2 spaces
530
604
            # to match the indentation of the options
531
 
            if sections.has_key(None):
 
605
            if None in sections:
532
606
                text = sections.pop(None)
533
607
                text = '\n  '.join(text.splitlines())
534
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
608
                result += gettext(':Description:\n  %s\n\n') % (text,)
535
609
 
536
610
            # Add the custom sections (e.g. Examples). Note that there's no need
537
611
            # to indent these as they must be indented already in the source.
538
612
            if sections:
539
613
                for label in order:
540
 
                    if sections.has_key(label):
541
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
614
                    if label in sections:
 
615
                        result += ':%s:\n%s\n' % (label, sections[label])
542
616
                result += '\n'
543
617
        else:
544
 
            result += ("See bzr help %s for more details and examples.\n\n"
545
 
                % self.name())
 
618
            result += (gettext("See brz help %s for more details and examples.\n\n")
 
619
                       % self.name())
546
620
 
547
621
        # Add the aliases, source (plug-in) and see also links, if any
548
622
        if self.aliases:
549
 
            result += ':Aliases:  '
 
623
            result += gettext(':Aliases:  ')
550
624
            result += ', '.join(self.aliases) + '\n'
551
625
        plugin_name = self.plugin_name()
552
626
        if plugin_name is not None:
553
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
627
            result += gettext(':From:     plugin "%s"\n') % plugin_name
554
628
        see_also = self.get_see_also(additional_see_also)
555
629
        if see_also:
556
630
            if not plain and see_also_as_links:
562
636
                        see_also_links.append(item)
563
637
                    else:
564
638
                        # Use a Sphinx link for this entry
565
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
639
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
 
640
                            item, item)
566
641
                        see_also_links.append(link_text)
567
642
                see_also = see_also_links
568
 
            result += ':See also: '
569
 
            result += ', '.join(see_also) + '\n'
 
643
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
570
644
 
571
645
        # If this will be rendered as plain text, convert it
572
646
        if plain:
573
 
            import bzrlib.help_topics
574
 
            result = bzrlib.help_topics.help_as_plain_text(result)
 
647
            import breezy.help_topics
 
648
            result = breezy.help_topics.help_as_plain_text(result)
575
649
        return result
576
650
 
577
651
    @staticmethod
588
662
        """
589
663
        def save_section(sections, order, label, section):
590
664
            if len(section) > 0:
591
 
                if sections.has_key(label):
 
665
                if label in sections:
592
666
                    sections[label] += '\n' + section
593
667
                else:
594
668
                    order.append(label)
598
672
        summary = lines.pop(0)
599
673
        sections = {}
600
674
        order = []
601
 
        label,section = None,''
 
675
        label, section = None, ''
602
676
        for line in lines:
603
677
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
678
                save_section(sections, order, label, section)
605
 
                label,section = line[1:-1],''
606
 
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
 
679
                label, section = line[1:-1], ''
 
680
            elif (label is not None and len(line) > 1 and
 
681
                    not line[0].isspace()):
607
682
                save_section(sections, order, label, section)
608
 
                label,section = None,line
 
683
                label, section = None, line
609
684
            else:
610
685
                if len(section) > 0:
611
686
                    section += '\n' + line
636
711
 
637
712
        Maps from long option name to option object."""
638
713
        r = Option.STD_OPTIONS.copy()
639
 
        std_names = r.keys()
 
714
        std_names = set(r)
640
715
        for o in self.takes_options:
641
 
            if isinstance(o, basestring):
 
716
            if isinstance(o, string_types):
642
717
                o = option.Option.OPTIONS[o]
643
718
            r[o.name] = o
644
719
            if o.name in std_names:
653
728
    def run_argv_aliases(self, argv, alias_argv=None):
654
729
        """Parse the command line and run with extra aliases in alias_argv."""
655
730
        args, opts = parse_args(self, argv, alias_argv)
 
731
        self._setup_outf()
656
732
 
657
733
        # Process the standard options
658
 
        if 'help' in opts:  # e.g. bzr add --help
659
 
            sys.stdout.write(self.get_help_text())
 
734
        if 'help' in opts:  # e.g. brz add --help
 
735
            self.outf.write(self.get_help_text())
660
736
            return 0
661
 
        if 'usage' in opts:  # e.g. bzr add --usage
662
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
737
        if 'usage' in opts:  # e.g. brz add --usage
 
738
            self.outf.write(self.get_help_text(verbose=False))
663
739
            return 0
664
740
        trace.set_verbosity_level(option._verbosity_level)
665
741
        if 'verbose' in self.supported_std_options:
666
742
            opts['verbose'] = trace.is_verbose()
667
 
        elif opts.has_key('verbose'):
 
743
        elif 'verbose' in opts:
668
744
            del opts['verbose']
669
745
        if 'quiet' in self.supported_std_options:
670
746
            opts['quiet'] = trace.is_quiet()
671
 
        elif opts.has_key('quiet'):
 
747
        elif 'quiet' in opts:
672
748
            del opts['quiet']
673
 
 
674
749
        # mix arguments and options into one dictionary
675
750
        cmdargs = _match_argform(self.name(), self.takes_args, args)
676
751
        cmdopts = {}
680
755
        all_cmd_args = cmdargs.copy()
681
756
        all_cmd_args.update(cmdopts)
682
757
 
683
 
        self._setup_outf()
684
 
 
685
 
        return self.run(**all_cmd_args)
 
758
        try:
 
759
            return self.run(**all_cmd_args)
 
760
        finally:
 
761
            # reset it, so that other commands run in the same process won't
 
762
            # inherit state. Before we reset it, log any activity, so that it
 
763
            # gets properly tracked.
 
764
            ui.ui_factory.log_transport_activity(
 
765
                display=('bytes' in debug.debug_flags))
 
766
            trace.set_verbosity_level(0)
686
767
 
687
768
    def _setup_run(self):
688
769
        """Wrap the defined run method on self with a cleanup.
694
775
        you can override this method.
695
776
        """
696
777
        class_run = self.run
 
778
 
697
779
        def run(*args, **kwargs):
 
780
            for hook in Command.hooks['pre_command']:
 
781
                hook(self)
698
782
            self._operation = cleanup.OperationWithCleanups(class_run)
699
783
            try:
700
784
                return self._operation.run_simple(*args, **kwargs)
701
785
            finally:
702
786
                del self._operation
 
787
                for hook in Command.hooks['post_command']:
 
788
                    hook(self)
703
789
        self.run = run
704
790
 
705
 
    @deprecated_method(deprecated_in((2, 2, 0)))
706
 
    def run_direct(self, *args, **kwargs):
707
 
        """Deprecated thunk from bzrlib 2.1."""
708
 
        return self.run(*args, **kwargs)
709
 
 
710
791
    def run(self):
711
792
        """Actually run the command.
712
793
 
717
798
        shell error code if not.  It's OK for this method to allow
718
799
        an exception to raise up.
719
800
 
720
 
        This method is automatically wrapped by Command.__init__ with a 
 
801
        This method is automatically wrapped by Command.__init__ with a
721
802
        cleanup operation, stored as self._operation. This can be used
722
803
        via self.add_cleanup to perform automatic cleanups at the end of
723
804
        run().
738
819
            return None
739
820
        return getdoc(self)
740
821
 
 
822
    def gettext(self, message):
 
823
        """Returns the gettext function used to translate this command's help.
 
824
 
 
825
        Commands provided by plugins should override this to use their
 
826
        own i18n system.
 
827
        """
 
828
        return i18n.gettext_per_paragraph(message)
 
829
 
741
830
    def name(self):
 
831
        """Return the canonical name for this command.
 
832
 
 
833
        The name under which it was actually invoked is available in invoked_as
 
834
        """
742
835
        return _unsquish_command_name(self.__class__.__name__)
743
836
 
744
837
    def plugin_name(self):
746
839
 
747
840
        :return: The name of the plugin or None if the command is builtin.
748
841
        """
749
 
        mod_parts = self.__module__.split('.')
750
 
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
751
 
            return mod_parts[2]
752
 
        else:
753
 
            return None
 
842
        return plugin_name(self.__module__)
754
843
 
755
844
 
756
845
class CommandHooks(Hooks):
762
851
        These are all empty initially, because by default nothing should get
763
852
        notified.
764
853
        """
765
 
        Hooks.__init__(self)
766
 
        self.create_hook(HookPoint('extend_command',
 
854
        Hooks.__init__(self, "breezy.commands", "Command.hooks")
 
855
        self.add_hook(
 
856
            'extend_command',
767
857
            "Called after creating a command object to allow modifications "
768
858
            "such as adding or removing options, docs etc. Called with the "
769
 
            "new bzrlib.commands.Command object.", (1, 13), None))
770
 
        self.create_hook(HookPoint('get_command',
 
859
            "new breezy.commands.Command object.", (1, 13))
 
860
        self.add_hook(
 
861
            'get_command',
771
862
            "Called when creating a single command. Called with "
772
863
            "(cmd_or_None, command_name). get_command should either return "
773
864
            "the cmd_or_None parameter, or a replacement Command object that "
774
865
            "should be used for the command. Note that the Command.hooks "
775
866
            "hooks are core infrastructure. Many users will prefer to use "
776
 
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
777
 
            (1, 17), None))
778
 
        self.create_hook(HookPoint('get_missing_command',
 
867
            "breezy.commands.register_command or plugin_cmds.register_lazy.",
 
868
            (1, 17))
 
869
        self.add_hook(
 
870
            'get_missing_command',
779
871
            "Called when creating a single command if no command could be "
780
872
            "found. Called with (command_name). get_missing_command should "
781
873
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
 
874
            "command.", (1, 17))
 
875
        self.add_hook(
 
876
            'list_commands',
784
877
            "Called when enumerating commands. Called with a set of "
785
878
            "cmd_name strings for all the commands found so far. This set "
786
879
            " is safe to mutate - e.g. to remove a command. "
787
880
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
 
881
            (1, 17))
 
882
        self.add_hook(
 
883
            'pre_command',
 
884
            "Called prior to executing a command. Called with the command "
 
885
            "object.", (2, 6))
 
886
        self.add_hook(
 
887
            'post_command',
 
888
            "Called after executing a command. Called with the command "
 
889
            "object.", (2, 6))
 
890
 
789
891
 
790
892
Command.hooks = CommandHooks()
791
893
 
799
901
    they take, and which commands will accept them.
800
902
    """
801
903
    # TODO: make it a method of the Command?
802
 
    parser = option.get_optparser(command.options())
 
904
    parser = option.get_optparser(
 
905
        [v for k, v in sorted(command.options().items())])
803
906
    if alias_argv is not None:
804
907
        args = alias_argv + argv
805
908
    else:
806
909
        args = argv
807
910
 
808
 
    options, args = parser.parse_args(args)
809
 
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
 
                 v is not option.OptionParser.DEFAULT_VALUE])
 
911
    # python 2's optparse raises this exception if a non-ascii
 
912
    # option name is given.  See http://bugs.python.org/issue2931
 
913
    try:
 
914
        options, args = parser.parse_args(args)
 
915
    except UnicodeEncodeError:
 
916
        raise errors.BzrCommandError(
 
917
            gettext('Only ASCII permitted in option names'))
 
918
 
 
919
    opts = dict((k, v) for k, v in options.__dict__.items() if
 
920
                v is not option.OptionParser.DEFAULT_VALUE)
811
921
    return args, opts
812
922
 
813
923
 
820
930
        if ap[-1] == '?':
821
931
            if args:
822
932
                argdict[argname] = args.pop(0)
823
 
        elif ap[-1] == '*': # all remaining arguments
 
933
        elif ap[-1] == '*':  # all remaining arguments
824
934
            if args:
825
935
                argdict[argname + '_list'] = args[:]
826
936
                args = []
828
938
                argdict[argname + '_list'] = None
829
939
        elif ap[-1] == '+':
830
940
            if not args:
831
 
                raise errors.BzrCommandError("command %r needs one or more %s"
832
 
                                             % (cmd, argname.upper()))
 
941
                raise errors.BzrCommandError(gettext(
 
942
                    "command {0!r} needs one or more {1}").format(
 
943
                    cmd, argname.upper()))
833
944
            else:
834
945
                argdict[argname + '_list'] = args[:]
835
946
                args = []
836
 
        elif ap[-1] == '$': # all but one
 
947
        elif ap[-1] == '$':  # all but one
837
948
            if len(args) < 2:
838
 
                raise errors.BzrCommandError("command %r needs one or more %s"
839
 
                                             % (cmd, argname.upper()))
 
949
                raise errors.BzrCommandError(
 
950
                    gettext("command {0!r} needs one or more {1}").format(
 
951
                        cmd, argname.upper()))
840
952
            argdict[argname + '_list'] = args[:-1]
841
953
            args[:-1] = []
842
954
        else:
843
955
            # just a plain arg
844
956
            argname = ap
845
957
            if not args:
846
 
                raise errors.BzrCommandError("command %r requires argument %s"
847
 
                               % (cmd, argname.upper()))
 
958
                raise errors.BzrCommandError(
 
959
                    gettext("command {0!r} requires argument {1}").format(
 
960
                        cmd, argname.upper()))
848
961
            else:
849
962
                argdict[argname] = args.pop(0)
850
963
 
851
964
    if args:
852
 
        raise errors.BzrCommandError("extra argument to command %s: %s"
853
 
                                     % (cmd, args[0]))
 
965
        raise errors.BzrCommandError(gettext(
 
966
            "extra argument to command {0}: {1}").format(
 
967
            cmd, args[0]))
854
968
 
855
969
    return argdict
856
970
 
857
 
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
 
    # Cannot use "import trace", as that would import bzrlib.trace instead of
859
 
    # the standard library's trace.
860
 
    trace = __import__('trace')
861
 
 
862
 
    tracer = trace.Trace(count=1, trace=0)
863
 
    sys.settrace(tracer.globaltrace)
864
 
    threading.settrace(tracer.globaltrace)
865
 
 
 
971
 
 
972
def apply_coveraged(the_callable, *args, **kwargs):
 
973
    import coverage
 
974
    cov = coverage.Coverage()
 
975
    os.environ['COVERAGE_PROCESS_START'] = cov.config_file
 
976
    cov.start()
866
977
    try:
867
978
        return exception_to_return_code(the_callable, *args, **kwargs)
868
979
    finally:
869
 
        sys.settrace(None)
870
 
        results = tracer.results()
871
 
        results.write_results(show_missing=1, summary=False,
872
 
                              coverdir=dirname)
 
980
        cov.stop()
 
981
        cov.save()
873
982
 
874
983
 
875
984
def apply_profiled(the_callable, *args, **kwargs):
881
990
        prof = hotshot.Profile(pfname)
882
991
        try:
883
992
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
884
 
                **kwargs) or 0
 
993
                               **kwargs) or 0
885
994
        finally:
886
995
            prof.close()
887
996
        stats = hotshot.stats.load(pfname)
888
997
        stats.strip_dirs()
889
998
        stats.sort_stats('cum')   # 'time'
890
 
        ## XXX: Might like to write to stderr or the trace file instead but
891
 
        ## print_stats seems hardcoded to stdout
 
999
        # XXX: Might like to write to stderr or the trace file instead but
 
1000
        # print_stats seems hardcoded to stdout
892
1001
        stats.print_stats(20)
893
1002
        return ret
894
1003
    finally:
905
1014
    """
906
1015
    try:
907
1016
        return the_callable(*args, **kwargs)
908
 
    except (KeyboardInterrupt, Exception), e:
 
1017
    except (KeyboardInterrupt, Exception):
909
1018
        # used to handle AssertionError and KeyboardInterrupt
910
1019
        # specially here, but hopefully they're handled ok by the logger now
911
1020
        exc_info = sys.exc_info()
912
1021
        exitcode = trace.report_exception(exc_info, sys.stderr)
913
 
        if os.environ.get('BZR_PDB'):
914
 
            print '**** entering debugger'
915
 
            tb = exc_info[2]
 
1022
        if os.environ.get('BRZ_PDB'):
 
1023
            print('**** entering debugger')
916
1024
            import pdb
917
 
            if sys.version_info[:2] < (2, 6):
918
 
                # XXX: we want to do
919
 
                #    pdb.post_mortem(tb)
920
 
                # but because pdb.post_mortem gives bad results for tracebacks
921
 
                # from inside generators, we do it manually.
922
 
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
923
 
 
924
 
                # Setup pdb on the traceback
925
 
                p = pdb.Pdb()
926
 
                p.reset()
927
 
                p.setup(tb.tb_frame, tb)
928
 
                # Point the debugger at the deepest frame of the stack
929
 
                p.curindex = len(p.stack) - 1
930
 
                p.curframe = p.stack[p.curindex][0]
931
 
                # Start the pdb prompt.
932
 
                p.print_stack_entry(p.stack[p.curindex])
933
 
                p.execRcLines()
934
 
                p.cmdloop()
935
 
            else:
936
 
                pdb.post_mortem(tb)
 
1025
            pdb.post_mortem(exc_info[2])
937
1026
        return exitcode
938
1027
 
939
1028
 
940
1029
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
 
    from bzrlib.lsprof import profile
942
 
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
 
1030
    from breezy.lsprof import profile
 
1031
    ret, stats = profile(exception_to_return_code, the_callable,
 
1032
                         *args, **kwargs)
943
1033
    stats.sort()
944
1034
    if filename is None:
945
1035
        stats.pprint()
946
1036
    else:
947
1037
        stats.save(filename)
948
 
        trace.note('Profile data written to "%s".', filename)
 
1038
        trace.note(gettext('Profile data written to "%s".'), filename)
949
1039
    return ret
950
1040
 
951
1041
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
 
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
955
 
 
956
 
 
957
1042
def get_alias(cmd, config=None):
958
1043
    """Return an expanded alias, or None if no alias exists.
959
1044
 
965
1050
        If it is unspecified, the global config will be used.
966
1051
    """
967
1052
    if config is None:
968
 
        import bzrlib.config
969
 
        config = bzrlib.config.GlobalConfig()
 
1053
        import breezy.config
 
1054
        config = breezy.config.GlobalConfig()
970
1055
    alias = config.get_alias(cmd)
971
1056
    if (alias):
972
1057
        return cmdline.split(alias)
1009
1094
        Run under the Python lsprof profiler.
1010
1095
 
1011
1096
    --coverage
1012
 
        Generate line coverage report in the specified directory.
 
1097
        Generate code coverage report
1013
1098
 
1014
1099
    --concurrency
1015
 
        Specify the number of processes that can be run concurrently (selftest).
 
1100
        Specify the number of processes that can be run concurrently
 
1101
        (selftest).
1016
1102
    """
1017
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
 
    argv = list(argv)
1019
 
    trace.mutter("bzr arguments: %r", argv)
 
1103
    trace.mutter("breezy version: " + breezy.__version__)
 
1104
    argv = _specified_or_unicode_argv(argv)
 
1105
    trace.mutter("brz arguments: %r", argv)
1020
1106
 
1021
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1022
 
                opt_no_aliases = False
1023
 
    opt_lsprof_file = opt_coverage_dir = None
 
1107
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1108
        opt_coverage = opt_no_l10n = opt_no_aliases = False
 
1109
    opt_lsprof_file = None
1024
1110
 
1025
1111
    # --no-plugins is handled specially at a very early stage. We need
1026
1112
    # to load plugins before doing other command parsing so that they
1028
1114
 
1029
1115
    argv_copy = []
1030
1116
    i = 0
 
1117
    override_config = []
1031
1118
    while i < len(argv):
1032
1119
        a = argv[i]
1033
1120
        if a == '--profile':
1042
1129
            opt_no_plugins = True
1043
1130
        elif a == '--no-aliases':
1044
1131
            opt_no_aliases = True
 
1132
        elif a == '--no-l10n':
 
1133
            opt_no_l10n = True
1045
1134
        elif a == '--builtin':
1046
1135
            opt_builtin = True
1047
1136
        elif a == '--concurrency':
1048
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
 
1137
            os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1049
1138
            i += 1
1050
1139
        elif a == '--coverage':
1051
 
            opt_coverage_dir = argv[i + 1]
1052
 
            i += 1
 
1140
            opt_coverage = True
 
1141
        elif a == '--profile-imports':
 
1142
            pass  # already handled in startup script Bug #588277
1053
1143
        elif a.startswith('-D'):
1054
1144
            debug.debug_flags.add(a[2:])
 
1145
        elif a.startswith('-O'):
 
1146
            override_config.append(a[2:])
1055
1147
        else:
1056
1148
            argv_copy.append(a)
1057
1149
        i += 1
1058
1150
 
 
1151
    cmdline_overrides = breezy.get_global_state().cmdline_overrides
 
1152
    cmdline_overrides._from_cmdline(override_config)
 
1153
 
1059
1154
    debug.set_debug_flags_from_config()
1060
1155
 
1061
1156
    if not opt_no_plugins:
1077
1172
    if not opt_no_aliases:
1078
1173
        alias_argv = get_alias(argv[0])
1079
1174
        if alias_argv:
1080
 
            user_encoding = osutils.get_user_encoding()
1081
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1175
            argv[0] = alias_argv.pop(0)
1083
1176
 
1084
1177
    cmd = argv.pop(0)
1085
 
    # We want only 'ascii' command names, but the user may have typed
1086
 
    # in a Unicode name. In that case, they should just get a
1087
 
    # 'command not found' error later.
1088
 
 
1089
1178
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1179
    if opt_no_l10n:
 
1180
        cmd_obj.l10n = False
1090
1181
    run = cmd_obj.run_argv_aliases
1091
1182
    run_argv = [argv, alias_argv]
1092
1183
 
1096
1187
        saved_verbosity_level = option._verbosity_level
1097
1188
        option._verbosity_level = 0
1098
1189
        if opt_lsprof:
1099
 
            if opt_coverage_dir:
 
1190
            if opt_coverage:
1100
1191
                trace.warning(
1101
1192
                    '--coverage ignored, because --lsprof is in use.')
1102
1193
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1103
1194
        elif opt_profile:
1104
 
            if opt_coverage_dir:
 
1195
            if opt_coverage:
1105
1196
                trace.warning(
1106
1197
                    '--coverage ignored, because --profile is in use.')
1107
1198
            ret = apply_profiled(run, *run_argv)
1108
 
        elif opt_coverage_dir:
1109
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
1199
        elif opt_coverage:
 
1200
            ret = apply_coveraged(run, *run_argv)
1110
1201
        else:
1111
1202
            ret = run(*run_argv)
1112
1203
        return ret or 0
1117
1208
        if 'memory' in debug.debug_flags:
1118
1209
            trace.debug_memory('Process status after command:', short=False)
1119
1210
        option._verbosity_level = saved_verbosity_level
 
1211
        # Reset the overrides
 
1212
        cmdline_overrides._reset()
1120
1213
 
1121
1214
 
1122
1215
def display_command(func):
1126
1219
            result = func(*args, **kwargs)
1127
1220
            sys.stdout.flush()
1128
1221
            return result
1129
 
        except IOError, e:
 
1222
        except IOError as e:
1130
1223
            if getattr(e, 'errno', None) is None:
1131
1224
                raise
1132
1225
            if e.errno != errno.EPIPE:
1144
1237
    if _list_bzr_commands in Command.hooks["list_commands"]:
1145
1238
        return
1146
1239
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1147
 
        "bzr commands")
 
1240
                                     "bzr commands")
1148
1241
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1149
 
        "bzr commands")
 
1242
                                     "bzr commands")
1150
1243
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
 
        "bzr plugin commands")
 
1244
                                     "bzr plugin commands")
1152
1245
    Command.hooks.install_named_hook("get_command", _get_external_command,
1153
 
        "bzr external command lookup")
1154
 
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
 
        "bzr plugin-provider-db check")
1156
 
 
 
1246
                                     "bzr external command lookup")
 
1247
    Command.hooks.install_named_hook("get_missing_command",
 
1248
                                     _try_plugin_provider,
 
1249
                                     "bzr plugin-provider-db check")
1157
1250
 
1158
1251
 
1159
1252
def _specified_or_unicode_argv(argv):
1161
1254
    # the process arguments in a unicode-safe way.
1162
1255
    if argv is None:
1163
1256
        return osutils.get_unicode_argv()
1164
 
    else:
1165
 
        new_argv = []
1166
 
        try:
1167
 
            # ensure all arguments are unicode strings
1168
 
            for a in argv[1:]:
1169
 
                if isinstance(a, unicode):
1170
 
                    new_argv.append(a)
1171
 
                else:
1172
 
                    new_argv.append(a.decode('ascii'))
1173
 
        except UnicodeDecodeError:
1174
 
            raise errors.BzrError("argv should be list of unicode strings.")
1175
 
        return new_argv
 
1257
    new_argv = []
 
1258
    try:
 
1259
        # ensure all arguments are unicode strings
 
1260
        for a in argv:
 
1261
            if not isinstance(a, string_types):
 
1262
                raise ValueError('not native str or unicode: %r' % (a,))
 
1263
            if isinstance(a, bytes):
 
1264
                # For Python 2 only allow ascii native strings
 
1265
                a = a.decode('ascii')
 
1266
            new_argv.append(a)
 
1267
    except (ValueError, UnicodeDecodeError):
 
1268
        raise errors.BzrError("argv should be list of unicode strings.")
 
1269
    return new_argv
1176
1270
 
1177
1271
 
1178
1272
def main(argv=None):
1179
1273
    """Main entry point of command-line interface.
1180
1274
 
1181
 
    Typically `bzrlib.initialize` should be called first.
 
1275
    Typically `breezy.initialize` should be called first.
1182
1276
 
1183
1277
    :param argv: list of unicode command-line arguments similar to sys.argv.
1184
1278
        argv[0] is script name usually, it will be ignored.
1185
1279
        Don't pass here sys.argv because this list contains plain strings
1186
1280
        and not unicode; pass None instead.
1187
1281
 
1188
 
    :return: exit code of bzr command.
 
1282
    :return: exit code of brz command.
1189
1283
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
 
1284
    if argv is not None:
 
1285
        argv = argv[1:]
1191
1286
    _register_builtin_commands()
1192
1287
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
1288
    trace.mutter("return code %d", ret)
1196
1289
    return ret
1197
1290
 
1200
1293
    """Run a bzr command with parameters as described by argv.
1201
1294
 
1202
1295
    This function assumed that that UI layer is setup, that symbol deprecations
1203
 
    are already applied, and that unicode decoding has already been performed on argv.
 
1296
    are already applied, and that unicode decoding has already been performed
 
1297
    on argv.
1204
1298
    """
1205
1299
    # done here so that they're covered for every test run
1206
1300
    install_bzr_command_hooks()
1208
1302
 
1209
1303
 
1210
1304
def run_bzr_catch_user_errors(argv):
1211
 
    """Run bzr and report user errors, but let internal errors propagate.
 
1305
    """Run brz and report user errors, but let internal errors propagate.
1212
1306
 
1213
1307
    This is used for the test suite, and might be useful for other programs
1214
1308
    that want to wrap the commandline interface.
1217
1311
    install_bzr_command_hooks()
1218
1312
    try:
1219
1313
        return run_bzr(argv)
1220
 
    except Exception, e:
 
1314
    except Exception as e:
1221
1315
        if (isinstance(e, (OSError, IOError))
1222
 
            or not getattr(e, 'internal_error', True)):
 
1316
                or not getattr(e, 'internal_error', True)):
1223
1317
            trace.report_exception(sys.exc_info(), sys.stderr)
1224
1318
            return 3
1225
1319
        else:
1250
1344
 
1251
1345
 
1252
1346
class Provider(object):
1253
 
    '''Generic class to be overriden by plugins'''
 
1347
    """Generic class to be overriden by plugins"""
1254
1348
 
1255
1349
    def plugin_for_command(self, cmd_name):
1256
 
        '''Takes a command and returns the information for that plugin
 
1350
        """Takes a command and returns the information for that plugin
1257
1351
 
1258
1352
        :return: A dictionary with all the available information
1259
 
        for the requested plugin
1260
 
        '''
 
1353
            for the requested plugin
 
1354
        """
1261
1355
        raise NotImplementedError
1262
1356
 
1263
1357
 
1264
1358
class ProvidersRegistry(registry.Registry):
1265
 
    '''This registry exists to allow other providers to exist'''
 
1359
    """This registry exists to allow other providers to exist"""
1266
1360
 
1267
1361
    def __iter__(self):
1268
 
        for key, provider in self.iteritems():
 
1362
        for key, provider in self.items():
1269
1363
            yield provider
1270
1364
 
 
1365
 
1271
1366
command_providers_registry = ProvidersRegistry()