/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: 2018-11-11 04:08:32 UTC
  • mto: (7143.16.20 even-more-cleanups)
  • mto: This revision was merged to the branch mainline in revision 7175.
  • Revision ID: jelmer@jelmer.uk-20181111040832-nsljjynzzwmznf3h
Run autopep8.

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 (
 
41
    config,
37
42
    cleanup,
38
43
    cmdline,
39
44
    debug,
40
 
    errors,
41
 
    option,
42
 
    osutils,
43
45
    trace,
44
46
    ui,
45
 
    win32utils,
46
47
    )
47
48
""")
48
49
 
49
 
from bzrlib.hooks import HookPoint, Hooks
 
50
from .hooks import Hooks
 
51
from .i18n import gettext
50
52
# 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,
 
53
from .option import Option
 
54
from .plugin import disable_plugins, load_plugins, plugin_name
 
55
from . import errors, registry
 
56
from .sixish import (
 
57
    string_types,
58
58
    )
59
59
 
60
60
 
 
61
class BzrOptionError(errors.BzrCommandError):
 
62
 
 
63
    _fmt = "Error in command line options"
 
64
 
 
65
 
 
66
class CommandAvailableInPlugin(Exception):
 
67
 
 
68
    internal_error = False
 
69
 
 
70
    def __init__(self, cmd_name, plugin_metadata, provider):
 
71
 
 
72
        self.plugin_metadata = plugin_metadata
 
73
        self.cmd_name = cmd_name
 
74
        self.provider = provider
 
75
 
 
76
    def __str__(self):
 
77
 
 
78
        _fmt = ('"%s" is not a standard brz command. \n'
 
79
                'However, the following official plugin provides this command: %s\n'
 
80
                'You can install it by going to: %s'
 
81
                % (self.cmd_name, self.plugin_metadata['name'],
 
82
                    self.plugin_metadata['url']))
 
83
 
 
84
        return _fmt
 
85
 
 
86
 
61
87
class CommandInfo(object):
62
88
    """Information about a command."""
63
89
 
73
99
 
74
100
class CommandRegistry(registry.Registry):
75
101
    """Special registry mapping command names to command classes.
76
 
    
 
102
 
77
103
    :ivar overridden_registry: Look in this registry for commands being
78
104
        overridden by this registry.  This can be used to tell plugin commands
79
105
        about the builtin they're decorating.
122
148
        except KeyError:
123
149
            trace.warning('Two plugins defined the same command: %r' % k)
124
150
            trace.warning('Not loading the one in %r' %
125
 
                sys.modules[cmd.__module__])
 
151
                          sys.modules[cmd.__module__])
126
152
            trace.warning('Previously this command was registered from %r' %
127
 
                sys.modules[previous.__module__])
 
153
                          sys.modules[previous.__module__])
128
154
        for a in cmd.aliases:
129
155
            self._alias_dict[a] = k_unsquished
130
156
        return previous
162
188
 
163
189
 
164
190
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())
 
191
    return cmd[4:].replace('_', '-')
176
192
 
177
193
 
178
194
def _register_builtin_commands():
179
195
    if builtin_command_registry.keys():
180
196
        # only load once
181
197
        return
182
 
    import bzrlib.builtins
183
 
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
 
198
    import breezy.builtins
 
199
    for cmd_class in _scan_module_for_commands(breezy.builtins):
184
200
        builtin_command_registry.register(cmd_class)
185
 
    bzrlib.builtins._register_lazy_builtins()
 
201
    breezy.builtins._register_lazy_builtins()
186
202
 
187
203
 
188
204
def _scan_module_for_commands(module):
189
 
    r = {}
190
 
    for name, obj in module.__dict__.iteritems():
 
205
    module_dict = module.__dict__
 
206
    for name in module_dict:
191
207
        if name.startswith("cmd_"):
192
 
            real_name = _unsquish_command_name(name)
193
 
            r[real_name] = obj
194
 
    return r
 
208
            yield module_dict[name]
195
209
 
196
210
 
197
211
def _list_bzr_commands(names):
198
212
    """Find commands from bzr's core and plugins.
199
 
    
 
213
 
200
214
    This is not the public interface, just the default hook called by all_command_names.
201
215
    """
202
216
    # to eliminate duplicates
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],''
 
679
                label, section = line[1:-1], ''
606
680
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
681
                save_section(sections, order, label, section)
608
 
                label,section = None,line
 
682
                label, section = None, line
609
683
            else:
610
684
                if len(section) > 0:
611
685
                    section += '\n' + line
636
710
 
637
711
        Maps from long option name to option object."""
638
712
        r = Option.STD_OPTIONS.copy()
639
 
        std_names = r.keys()
 
713
        std_names = set(r)
640
714
        for o in self.takes_options:
641
 
            if isinstance(o, basestring):
 
715
            if isinstance(o, string_types):
642
716
                o = option.Option.OPTIONS[o]
643
717
            r[o.name] = o
644
718
            if o.name in std_names:
653
727
    def run_argv_aliases(self, argv, alias_argv=None):
654
728
        """Parse the command line and run with extra aliases in alias_argv."""
655
729
        args, opts = parse_args(self, argv, alias_argv)
 
730
        self._setup_outf()
656
731
 
657
732
        # Process the standard options
658
 
        if 'help' in opts:  # e.g. bzr add --help
659
 
            sys.stdout.write(self.get_help_text())
 
733
        if 'help' in opts:  # e.g. brz add --help
 
734
            self.outf.write(self.get_help_text())
660
735
            return 0
661
 
        if 'usage' in opts:  # e.g. bzr add --usage
662
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
736
        if 'usage' in opts:  # e.g. brz add --usage
 
737
            self.outf.write(self.get_help_text(verbose=False))
663
738
            return 0
664
739
        trace.set_verbosity_level(option._verbosity_level)
665
740
        if 'verbose' in self.supported_std_options:
666
741
            opts['verbose'] = trace.is_verbose()
667
 
        elif opts.has_key('verbose'):
 
742
        elif 'verbose' in opts:
668
743
            del opts['verbose']
669
744
        if 'quiet' in self.supported_std_options:
670
745
            opts['quiet'] = trace.is_quiet()
671
 
        elif opts.has_key('quiet'):
 
746
        elif 'quiet' in opts:
672
747
            del opts['quiet']
673
 
 
674
748
        # mix arguments and options into one dictionary
675
749
        cmdargs = _match_argform(self.name(), self.takes_args, args)
676
750
        cmdopts = {}
680
754
        all_cmd_args = cmdargs.copy()
681
755
        all_cmd_args.update(cmdopts)
682
756
 
683
 
        self._setup_outf()
684
 
 
685
 
        return self.run(**all_cmd_args)
 
757
        try:
 
758
            return self.run(**all_cmd_args)
 
759
        finally:
 
760
            # reset it, so that other commands run in the same process won't
 
761
            # inherit state. Before we reset it, log any activity, so that it
 
762
            # gets properly tracked.
 
763
            ui.ui_factory.log_transport_activity(
 
764
                display=('bytes' in debug.debug_flags))
 
765
            trace.set_verbosity_level(0)
686
766
 
687
767
    def _setup_run(self):
688
768
        """Wrap the defined run method on self with a cleanup.
694
774
        you can override this method.
695
775
        """
696
776
        class_run = self.run
 
777
 
697
778
        def run(*args, **kwargs):
 
779
            for hook in Command.hooks['pre_command']:
 
780
                hook(self)
698
781
            self._operation = cleanup.OperationWithCleanups(class_run)
699
782
            try:
700
783
                return self._operation.run_simple(*args, **kwargs)
701
784
            finally:
702
785
                del self._operation
 
786
                for hook in Command.hooks['post_command']:
 
787
                    hook(self)
703
788
        self.run = run
704
789
 
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
790
    def run(self):
711
791
        """Actually run the command.
712
792
 
738
818
            return None
739
819
        return getdoc(self)
740
820
 
 
821
    def gettext(self, message):
 
822
        """Returns the gettext function used to translate this command's help.
 
823
 
 
824
        Commands provided by plugins should override this to use their
 
825
        own i18n system.
 
826
        """
 
827
        return i18n.gettext_per_paragraph(message)
 
828
 
741
829
    def name(self):
 
830
        """Return the canonical name for this command.
 
831
 
 
832
        The name under which it was actually invoked is available in invoked_as.
 
833
        """
742
834
        return _unsquish_command_name(self.__class__.__name__)
743
835
 
744
836
    def plugin_name(self):
746
838
 
747
839
        :return: The name of the plugin or None if the command is builtin.
748
840
        """
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
 
841
        return plugin_name(self.__module__)
754
842
 
755
843
 
756
844
class CommandHooks(Hooks):
762
850
        These are all empty initially, because by default nothing should get
763
851
        notified.
764
852
        """
765
 
        Hooks.__init__(self)
766
 
        self.create_hook(HookPoint('extend_command',
767
 
            "Called after creating a command object to allow modifications "
768
 
            "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',
771
 
            "Called when creating a single command. Called with "
772
 
            "(cmd_or_None, command_name). get_command should either return "
773
 
            "the cmd_or_None parameter, or a replacement Command object that "
774
 
            "should be used for the command. Note that the Command.hooks "
775
 
            "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',
779
 
            "Called when creating a single command if no command could be "
780
 
            "found. Called with (command_name). get_missing_command should "
781
 
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
784
 
            "Called when enumerating commands. Called with a set of "
785
 
            "cmd_name strings for all the commands found so far. This set "
786
 
            " is safe to mutate - e.g. to remove a command. "
787
 
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
 
853
        Hooks.__init__(self, "breezy.commands", "Command.hooks")
 
854
        self.add_hook('extend_command',
 
855
                      "Called after creating a command object to allow modifications "
 
856
                      "such as adding or removing options, docs etc. Called with the "
 
857
                      "new breezy.commands.Command object.", (1, 13))
 
858
        self.add_hook('get_command',
 
859
                      "Called when creating a single command. Called with "
 
860
                      "(cmd_or_None, command_name). get_command should either return "
 
861
                      "the cmd_or_None parameter, or a replacement Command object that "
 
862
                      "should be used for the command. Note that the Command.hooks "
 
863
                      "hooks are core infrastructure. Many users will prefer to use "
 
864
                      "breezy.commands.register_command or plugin_cmds.register_lazy.",
 
865
                      (1, 17))
 
866
        self.add_hook('get_missing_command',
 
867
                      "Called when creating a single command if no command could be "
 
868
                      "found. Called with (command_name). get_missing_command should "
 
869
                      "either return None, or a Command object to be used for the "
 
870
                      "command.", (1, 17))
 
871
        self.add_hook('list_commands',
 
872
                      "Called when enumerating commands. Called with a set of "
 
873
                      "cmd_name strings for all the commands found so far. This set "
 
874
                      " is safe to mutate - e.g. to remove a command. "
 
875
                      "list_commands should return the updated set of command names.",
 
876
                      (1, 17))
 
877
        self.add_hook('pre_command',
 
878
                      "Called prior to executing a command. Called with the command "
 
879
                      "object.", (2, 6))
 
880
        self.add_hook('post_command',
 
881
                      "Called after executing a command. Called with the command "
 
882
                      "object.", (2, 6))
 
883
 
789
884
 
790
885
Command.hooks = CommandHooks()
791
886
 
799
894
    they take, and which commands will accept them.
800
895
    """
801
896
    # TODO: make it a method of the Command?
802
 
    parser = option.get_optparser(command.options())
 
897
    parser = option.get_optparser(
 
898
        [v for k, v in sorted(command.options().items())])
803
899
    if alias_argv is not None:
804
900
        args = alias_argv + argv
805
901
    else:
806
902
        args = argv
807
903
 
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])
 
904
    # python 2's optparse raises this exception if a non-ascii
 
905
    # option name is given.  See http://bugs.python.org/issue2931
 
906
    try:
 
907
        options, args = parser.parse_args(args)
 
908
    except UnicodeEncodeError as e:
 
909
        raise errors.BzrCommandError(
 
910
            gettext('Only ASCII permitted in option names'))
 
911
 
 
912
    opts = dict((k, v) for k, v in options.__dict__.items() if
 
913
                v is not option.OptionParser.DEFAULT_VALUE)
811
914
    return args, opts
812
915
 
813
916
 
820
923
        if ap[-1] == '?':
821
924
            if args:
822
925
                argdict[argname] = args.pop(0)
823
 
        elif ap[-1] == '*': # all remaining arguments
 
926
        elif ap[-1] == '*':  # all remaining arguments
824
927
            if args:
825
928
                argdict[argname + '_list'] = args[:]
826
929
                args = []
828
931
                argdict[argname + '_list'] = None
829
932
        elif ap[-1] == '+':
830
933
            if not args:
831
 
                raise errors.BzrCommandError("command %r needs one or more %s"
832
 
                                             % (cmd, argname.upper()))
 
934
                raise errors.BzrCommandError(gettext(
 
935
                    "command {0!r} needs one or more {1}").format(
 
936
                    cmd, argname.upper()))
833
937
            else:
834
938
                argdict[argname + '_list'] = args[:]
835
939
                args = []
836
 
        elif ap[-1] == '$': # all but one
 
940
        elif ap[-1] == '$':  # all but one
837
941
            if len(args) < 2:
838
 
                raise errors.BzrCommandError("command %r needs one or more %s"
839
 
                                             % (cmd, argname.upper()))
 
942
                raise errors.BzrCommandError(
 
943
                    gettext("command {0!r} needs one or more {1}").format(
 
944
                        cmd, argname.upper()))
840
945
            argdict[argname + '_list'] = args[:-1]
841
946
            args[:-1] = []
842
947
        else:
843
948
            # just a plain arg
844
949
            argname = ap
845
950
            if not args:
846
 
                raise errors.BzrCommandError("command %r requires argument %s"
847
 
                               % (cmd, argname.upper()))
 
951
                raise errors.BzrCommandError(
 
952
                    gettext("command {0!r} requires argument {1}").format(
 
953
                        cmd, argname.upper()))
848
954
            else:
849
955
                argdict[argname] = args.pop(0)
850
956
 
851
957
    if args:
852
 
        raise errors.BzrCommandError("extra argument to command %s: %s"
853
 
                                     % (cmd, args[0]))
 
958
        raise errors.BzrCommandError(gettext(
 
959
            "extra argument to command {0}: {1}").format(
 
960
            cmd, args[0]))
854
961
 
855
962
    return argdict
856
963
 
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
 
 
 
964
 
 
965
def apply_coveraged(the_callable, *args, **kwargs):
 
966
    import coverage
 
967
    cov = coverage.Coverage()
 
968
    os.environ['COVERAGE_PROCESS_START'] = cov.config_file
 
969
    cov.start()
866
970
    try:
867
971
        return exception_to_return_code(the_callable, *args, **kwargs)
868
972
    finally:
869
 
        sys.settrace(None)
870
 
        results = tracer.results()
871
 
        results.write_results(show_missing=1, summary=False,
872
 
                              coverdir=dirname)
 
973
        cov.stop()
 
974
        cov.save()
873
975
 
874
976
 
875
977
def apply_profiled(the_callable, *args, **kwargs):
881
983
        prof = hotshot.Profile(pfname)
882
984
        try:
883
985
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
884
 
                **kwargs) or 0
 
986
                               **kwargs) or 0
885
987
        finally:
886
988
            prof.close()
887
989
        stats = hotshot.stats.load(pfname)
888
990
        stats.strip_dirs()
889
991
        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
 
992
        # XXX: Might like to write to stderr or the trace file instead but
 
993
        # print_stats seems hardcoded to stdout
892
994
        stats.print_stats(20)
893
995
        return ret
894
996
    finally:
905
1007
    """
906
1008
    try:
907
1009
        return the_callable(*args, **kwargs)
908
 
    except (KeyboardInterrupt, Exception), e:
 
1010
    except (KeyboardInterrupt, Exception) as e:
909
1011
        # used to handle AssertionError and KeyboardInterrupt
910
1012
        # specially here, but hopefully they're handled ok by the logger now
911
1013
        exc_info = sys.exc_info()
912
1014
        exitcode = trace.report_exception(exc_info, sys.stderr)
913
 
        if os.environ.get('BZR_PDB'):
914
 
            print '**** entering debugger'
915
 
            tb = exc_info[2]
 
1015
        if os.environ.get('BRZ_PDB'):
 
1016
            print('**** entering debugger')
916
1017
            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)
 
1018
            pdb.post_mortem(exc_info[2])
937
1019
        return exitcode
938
1020
 
939
1021
 
940
1022
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)
 
1023
    from breezy.lsprof import profile
 
1024
    ret, stats = profile(exception_to_return_code, the_callable,
 
1025
                         *args, **kwargs)
943
1026
    stats.sort()
944
1027
    if filename is None:
945
1028
        stats.pprint()
946
1029
    else:
947
1030
        stats.save(filename)
948
 
        trace.note('Profile data written to "%s".', filename)
 
1031
        trace.note(gettext('Profile data written to "%s".'), filename)
949
1032
    return ret
950
1033
 
951
1034
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
 
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
955
 
 
956
 
 
957
1035
def get_alias(cmd, config=None):
958
1036
    """Return an expanded alias, or None if no alias exists.
959
1037
 
965
1043
        If it is unspecified, the global config will be used.
966
1044
    """
967
1045
    if config is None:
968
 
        import bzrlib.config
969
 
        config = bzrlib.config.GlobalConfig()
 
1046
        import breezy.config
 
1047
        config = breezy.config.GlobalConfig()
970
1048
    alias = config.get_alias(cmd)
971
1049
    if (alias):
972
1050
        return cmdline.split(alias)
1009
1087
        Run under the Python lsprof profiler.
1010
1088
 
1011
1089
    --coverage
1012
 
        Generate line coverage report in the specified directory.
 
1090
        Generate code coverage report
1013
1091
 
1014
1092
    --concurrency
1015
1093
        Specify the number of processes that can be run concurrently (selftest).
1016
1094
    """
1017
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
 
    argv = list(argv)
1019
 
    trace.mutter("bzr arguments: %r", argv)
 
1095
    trace.mutter("breezy version: " + breezy.__version__)
 
1096
    argv = _specified_or_unicode_argv(argv)
 
1097
    trace.mutter("brz arguments: %r", argv)
1020
1098
 
1021
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1022
 
                opt_no_aliases = False
1023
 
    opt_lsprof_file = opt_coverage_dir = None
 
1099
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1100
        opt_coverage = opt_no_l10n = opt_no_aliases = False
 
1101
    opt_lsprof_file = None
1024
1102
 
1025
1103
    # --no-plugins is handled specially at a very early stage. We need
1026
1104
    # to load plugins before doing other command parsing so that they
1028
1106
 
1029
1107
    argv_copy = []
1030
1108
    i = 0
 
1109
    override_config = []
1031
1110
    while i < len(argv):
1032
1111
        a = argv[i]
1033
1112
        if a == '--profile':
1042
1121
            opt_no_plugins = True
1043
1122
        elif a == '--no-aliases':
1044
1123
            opt_no_aliases = True
 
1124
        elif a == '--no-l10n':
 
1125
            opt_no_l10n = True
1045
1126
        elif a == '--builtin':
1046
1127
            opt_builtin = True
1047
1128
        elif a == '--concurrency':
1048
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
 
1129
            os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1049
1130
            i += 1
1050
1131
        elif a == '--coverage':
1051
 
            opt_coverage_dir = argv[i + 1]
1052
 
            i += 1
 
1132
            opt_coverage = True
 
1133
        elif a == '--profile-imports':
 
1134
            pass  # already handled in startup script Bug #588277
1053
1135
        elif a.startswith('-D'):
1054
1136
            debug.debug_flags.add(a[2:])
 
1137
        elif a.startswith('-O'):
 
1138
            override_config.append(a[2:])
1055
1139
        else:
1056
1140
            argv_copy.append(a)
1057
1141
        i += 1
1058
1142
 
 
1143
    cmdline_overrides = breezy.get_global_state().cmdline_overrides
 
1144
    cmdline_overrides._from_cmdline(override_config)
 
1145
 
1059
1146
    debug.set_debug_flags_from_config()
1060
1147
 
1061
1148
    if not opt_no_plugins:
1077
1164
    if not opt_no_aliases:
1078
1165
        alias_argv = get_alias(argv[0])
1079
1166
        if alias_argv:
1080
 
            user_encoding = osutils.get_user_encoding()
1081
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1167
            argv[0] = alias_argv.pop(0)
1083
1168
 
1084
1169
    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
1170
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1171
    if opt_no_l10n:
 
1172
        cmd_obj.l10n = False
1090
1173
    run = cmd_obj.run_argv_aliases
1091
1174
    run_argv = [argv, alias_argv]
1092
1175
 
1096
1179
        saved_verbosity_level = option._verbosity_level
1097
1180
        option._verbosity_level = 0
1098
1181
        if opt_lsprof:
1099
 
            if opt_coverage_dir:
 
1182
            if opt_coverage:
1100
1183
                trace.warning(
1101
1184
                    '--coverage ignored, because --lsprof is in use.')
1102
1185
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1103
1186
        elif opt_profile:
1104
 
            if opt_coverage_dir:
 
1187
            if opt_coverage:
1105
1188
                trace.warning(
1106
1189
                    '--coverage ignored, because --profile is in use.')
1107
1190
            ret = apply_profiled(run, *run_argv)
1108
 
        elif opt_coverage_dir:
1109
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
1191
        elif opt_coverage:
 
1192
            ret = apply_coveraged(run, *run_argv)
1110
1193
        else:
1111
1194
            ret = run(*run_argv)
1112
1195
        return ret or 0
1117
1200
        if 'memory' in debug.debug_flags:
1118
1201
            trace.debug_memory('Process status after command:', short=False)
1119
1202
        option._verbosity_level = saved_verbosity_level
 
1203
        # Reset the overrides
 
1204
        cmdline_overrides._reset()
1120
1205
 
1121
1206
 
1122
1207
def display_command(func):
1126
1211
            result = func(*args, **kwargs)
1127
1212
            sys.stdout.flush()
1128
1213
            return result
1129
 
        except IOError, e:
 
1214
        except IOError as e:
1130
1215
            if getattr(e, 'errno', None) is None:
1131
1216
                raise
1132
1217
            if e.errno != errno.EPIPE:
1144
1229
    if _list_bzr_commands in Command.hooks["list_commands"]:
1145
1230
        return
1146
1231
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1147
 
        "bzr commands")
 
1232
                                     "bzr commands")
1148
1233
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1149
 
        "bzr commands")
 
1234
                                     "bzr commands")
1150
1235
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
 
        "bzr plugin commands")
 
1236
                                     "bzr plugin commands")
1152
1237
    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
 
 
 
1238
                                     "bzr external command lookup")
 
1239
    Command.hooks.install_named_hook("get_missing_command",
 
1240
                                     _try_plugin_provider,
 
1241
                                     "bzr plugin-provider-db check")
1157
1242
 
1158
1243
 
1159
1244
def _specified_or_unicode_argv(argv):
1161
1246
    # the process arguments in a unicode-safe way.
1162
1247
    if argv is None:
1163
1248
        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
 
1249
    new_argv = []
 
1250
    try:
 
1251
        # ensure all arguments are unicode strings
 
1252
        for a in argv:
 
1253
            if not isinstance(a, string_types):
 
1254
                raise ValueError('not native str or unicode: %r' % (a,))
 
1255
            if isinstance(a, bytes):
 
1256
                # For Python 2 only allow ascii native strings
 
1257
                a = a.decode('ascii')
 
1258
            new_argv.append(a)
 
1259
    except (ValueError, UnicodeDecodeError):
 
1260
        raise errors.BzrError("argv should be list of unicode strings.")
 
1261
    return new_argv
1176
1262
 
1177
1263
 
1178
1264
def main(argv=None):
1179
1265
    """Main entry point of command-line interface.
1180
1266
 
1181
 
    Typically `bzrlib.initialize` should be called first.
 
1267
    Typically `breezy.initialize` should be called first.
1182
1268
 
1183
1269
    :param argv: list of unicode command-line arguments similar to sys.argv.
1184
1270
        argv[0] is script name usually, it will be ignored.
1185
1271
        Don't pass here sys.argv because this list contains plain strings
1186
1272
        and not unicode; pass None instead.
1187
1273
 
1188
 
    :return: exit code of bzr command.
 
1274
    :return: exit code of brz command.
1189
1275
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
 
1276
    if argv is not None:
 
1277
        argv = argv[1:]
1191
1278
    _register_builtin_commands()
1192
1279
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
1280
    trace.mutter("return code %d", ret)
1196
1281
    return ret
1197
1282
 
1208
1293
 
1209
1294
 
1210
1295
def run_bzr_catch_user_errors(argv):
1211
 
    """Run bzr and report user errors, but let internal errors propagate.
 
1296
    """Run brz and report user errors, but let internal errors propagate.
1212
1297
 
1213
1298
    This is used for the test suite, and might be useful for other programs
1214
1299
    that want to wrap the commandline interface.
1217
1302
    install_bzr_command_hooks()
1218
1303
    try:
1219
1304
        return run_bzr(argv)
1220
 
    except Exception, e:
 
1305
    except Exception as e:
1221
1306
        if (isinstance(e, (OSError, IOError))
1222
 
            or not getattr(e, 'internal_error', True)):
 
1307
                or not getattr(e, 'internal_error', True)):
1223
1308
            trace.report_exception(sys.exc_info(), sys.stderr)
1224
1309
            return 3
1225
1310
        else:
1250
1335
 
1251
1336
 
1252
1337
class Provider(object):
1253
 
    '''Generic class to be overriden by plugins'''
 
1338
    """Generic class to be overriden by plugins"""
1254
1339
 
1255
1340
    def plugin_for_command(self, cmd_name):
1256
 
        '''Takes a command and returns the information for that plugin
 
1341
        """Takes a command and returns the information for that plugin
1257
1342
 
1258
1343
        :return: A dictionary with all the available information
1259
 
        for the requested plugin
1260
 
        '''
 
1344
            for the requested plugin
 
1345
        """
1261
1346
        raise NotImplementedError
1262
1347
 
1263
1348
 
1264
1349
class ProvidersRegistry(registry.Registry):
1265
 
    '''This registry exists to allow other providers to exist'''
 
1350
    """This registry exists to allow other providers to exist"""
1266
1351
 
1267
1352
    def __iter__(self):
1268
 
        for key, provider in self.iteritems():
 
1353
        for key, provider in self.items():
1269
1354
            yield provider
1270
1355
 
 
1356
 
1271
1357
command_providers_registry = ProvidersRegistry()