/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: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

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
    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()
418
496
 
419
497
        Functions will be called in LIFO order.
420
498
        """
421
 
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
 
499
        self._exit_stack.callback(cleanup_func, *args, **kwargs)
422
500
 
423
501
    def cleanup_now(self):
424
502
        """Execute and empty pending cleanup functions immediately.
433
511
        as it releases all resources, this may release locks that the command
434
512
        wants to hold, so use should be done with care.
435
513
        """
436
 
        self._operation.cleanup_now()
437
 
 
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
 
514
        self._exit_stack.close()
 
515
 
 
516
    def enter_context(self, cm):
 
517
        return self._exit_stack.enter_context(cm)
450
518
 
451
519
    def _usage(self):
452
520
        """Return single-line grammar for this command.
453
521
 
454
522
        Only describes arguments, not options.
455
523
        """
456
 
        s = 'bzr ' + self.name() + ' '
 
524
        s = 'brz ' + self.name() + ' '
457
525
        for aname in self.takes_args:
458
526
            aname = aname.upper()
459
527
            if aname[-1] in ['$', '+']:
481
549
            usage help (e.g. Purpose, Usage, Options) with a
482
550
            message explaining how to obtain full help.
483
551
        """
 
552
        if self.l10n:
 
553
            i18n.install()  # Install i18n only for get_help_text for now.
484
554
        doc = self.help()
485
 
        if doc is None:
486
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
555
        if doc:
 
556
            # Note: If self.gettext() translates ':Usage:\n', the section will
 
557
            # be shown after "Description" section and we don't want to
 
558
            # translate the usage string.
 
559
            # Though, brz export-pot don't exports :Usage: section and it must
 
560
            # not be translated.
 
561
            doc = self.gettext(doc)
 
562
        else:
 
563
            doc = gettext("No help for this command.")
487
564
 
488
565
        # Extract the summary (purpose) and sections out from the text
489
 
        purpose,sections,order = self._get_help_parts(doc)
 
566
        purpose, sections, order = self._get_help_parts(doc)
490
567
 
491
568
        # If a custom usage section was provided, use it
492
 
        if sections.has_key('Usage'):
 
569
        if 'Usage' in sections:
493
570
            usage = sections.pop('Usage')
494
571
        else:
495
572
            usage = self._usage()
496
573
 
497
574
        # The header is the purpose and usage
498
575
        result = ""
499
 
        result += ':Purpose: %s\n' % purpose
 
576
        result += gettext(':Purpose: %s\n') % (purpose,)
500
577
        if usage.find('\n') >= 0:
501
 
            result += ':Usage:\n%s\n' % usage
 
578
            result += gettext(':Usage:\n%s\n') % (usage,)
502
579
        else:
503
 
            result += ':Usage:   %s\n' % usage
 
580
            result += gettext(':Usage:   %s\n') % (usage,)
504
581
        result += '\n'
505
582
 
506
583
        # Add the options
508
585
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
509
586
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
510
587
        # 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:
 
588
        parser = option.get_optparser(
 
589
            [v for k, v in sorted(self.options().items())])
 
590
        options = parser.format_option_help()
 
591
        # FIXME: According to the spec, ReST option lists actually don't
 
592
        # support options like --1.14 so that causes syntax errors (in Sphinx
 
593
        # at least).  As that pattern always appears in the commands that
 
594
        # break, we trap on that and then format that block of 'format' options
 
595
        # as a literal block. We use the most recent format still listed so we
 
596
        # don't have to do that too often -- vila 20110514
 
597
        if not plain and options.find('  --1.14  ') != -1:
518
598
            options = options.replace(' format:\n', ' format::\n\n', 1)
519
599
        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:'):]
 
600
            result += gettext(':Options:%s') % (options[len('options:'):],)
524
601
        else:
525
602
            result += options
526
603
        result += '\n'
528
605
        if verbose:
529
606
            # Add the description, indenting it 2 spaces
530
607
            # to match the indentation of the options
531
 
            if sections.has_key(None):
 
608
            if None in sections:
532
609
                text = sections.pop(None)
533
610
                text = '\n  '.join(text.splitlines())
534
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
611
                result += gettext(':Description:\n  %s\n\n') % (text,)
535
612
 
536
613
            # Add the custom sections (e.g. Examples). Note that there's no need
537
614
            # to indent these as they must be indented already in the source.
538
615
            if sections:
539
616
                for label in order:
540
 
                    if sections.has_key(label):
541
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
617
                    if label in sections:
 
618
                        result += ':%s:\n%s\n' % (label, sections[label])
542
619
                result += '\n'
543
620
        else:
544
 
            result += ("See bzr help %s for more details and examples.\n\n"
545
 
                % self.name())
 
621
            result += (gettext("See brz help %s for more details and examples.\n\n")
 
622
                       % self.name())
546
623
 
547
624
        # Add the aliases, source (plug-in) and see also links, if any
548
625
        if self.aliases:
549
 
            result += ':Aliases:  '
 
626
            result += gettext(':Aliases:  ')
550
627
            result += ', '.join(self.aliases) + '\n'
551
628
        plugin_name = self.plugin_name()
552
629
        if plugin_name is not None:
553
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
630
            result += gettext(':From:     plugin "%s"\n') % plugin_name
554
631
        see_also = self.get_see_also(additional_see_also)
555
632
        if see_also:
556
633
            if not plain and see_also_as_links:
562
639
                        see_also_links.append(item)
563
640
                    else:
564
641
                        # Use a Sphinx link for this entry
565
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
642
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
 
643
                            item, item)
566
644
                        see_also_links.append(link_text)
567
645
                see_also = see_also_links
568
 
            result += ':See also: '
569
 
            result += ', '.join(see_also) + '\n'
 
646
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
570
647
 
571
648
        # If this will be rendered as plain text, convert it
572
649
        if plain:
573
 
            import bzrlib.help_topics
574
 
            result = bzrlib.help_topics.help_as_plain_text(result)
 
650
            import breezy.help_topics
 
651
            result = breezy.help_topics.help_as_plain_text(result)
575
652
        return result
576
653
 
577
654
    @staticmethod
588
665
        """
589
666
        def save_section(sections, order, label, section):
590
667
            if len(section) > 0:
591
 
                if sections.has_key(label):
 
668
                if label in sections:
592
669
                    sections[label] += '\n' + section
593
670
                else:
594
671
                    order.append(label)
598
675
        summary = lines.pop(0)
599
676
        sections = {}
600
677
        order = []
601
 
        label,section = None,''
 
678
        label, section = None, ''
602
679
        for line in lines:
603
680
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
681
                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():
 
682
                label, section = line[1:-1], ''
 
683
            elif (label is not None and len(line) > 1 and
 
684
                    not line[0].isspace()):
607
685
                save_section(sections, order, label, section)
608
 
                label,section = None,line
 
686
                label, section = None, line
609
687
            else:
610
688
                if len(section) > 0:
611
689
                    section += '\n' + line
636
714
 
637
715
        Maps from long option name to option object."""
638
716
        r = Option.STD_OPTIONS.copy()
639
 
        std_names = r.keys()
 
717
        std_names = set(r)
640
718
        for o in self.takes_options:
641
 
            if isinstance(o, basestring):
 
719
            if isinstance(o, string_types):
642
720
                o = option.Option.OPTIONS[o]
643
721
            r[o.name] = o
644
722
            if o.name in std_names:
653
731
    def run_argv_aliases(self, argv, alias_argv=None):
654
732
        """Parse the command line and run with extra aliases in alias_argv."""
655
733
        args, opts = parse_args(self, argv, alias_argv)
 
734
        self._setup_outf()
656
735
 
657
736
        # Process the standard options
658
 
        if 'help' in opts:  # e.g. bzr add --help
659
 
            sys.stdout.write(self.get_help_text())
 
737
        if 'help' in opts:  # e.g. brz add --help
 
738
            self.outf.write(self.get_help_text())
660
739
            return 0
661
 
        if 'usage' in opts:  # e.g. bzr add --usage
662
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
740
        if 'usage' in opts:  # e.g. brz add --usage
 
741
            self.outf.write(self.get_help_text(verbose=False))
663
742
            return 0
664
743
        trace.set_verbosity_level(option._verbosity_level)
665
744
        if 'verbose' in self.supported_std_options:
666
745
            opts['verbose'] = trace.is_verbose()
667
 
        elif opts.has_key('verbose'):
 
746
        elif 'verbose' in opts:
668
747
            del opts['verbose']
669
748
        if 'quiet' in self.supported_std_options:
670
749
            opts['quiet'] = trace.is_quiet()
671
 
        elif opts.has_key('quiet'):
 
750
        elif 'quiet' in opts:
672
751
            del opts['quiet']
673
 
 
674
752
        # mix arguments and options into one dictionary
675
753
        cmdargs = _match_argform(self.name(), self.takes_args, args)
676
754
        cmdopts = {}
680
758
        all_cmd_args = cmdargs.copy()
681
759
        all_cmd_args.update(cmdopts)
682
760
 
683
 
        self._setup_outf()
684
 
 
685
 
        return self.run(**all_cmd_args)
 
761
        try:
 
762
            return self.run(**all_cmd_args)
 
763
        finally:
 
764
            # reset it, so that other commands run in the same process won't
 
765
            # inherit state. Before we reset it, log any activity, so that it
 
766
            # gets properly tracked.
 
767
            ui.ui_factory.log_transport_activity(
 
768
                display=('bytes' in debug.debug_flags))
 
769
            trace.set_verbosity_level(0)
686
770
 
687
771
    def _setup_run(self):
688
772
        """Wrap the defined run method on self with a cleanup.
694
778
        you can override this method.
695
779
        """
696
780
        class_run = self.run
 
781
 
697
782
        def run(*args, **kwargs):
698
 
            self._operation = cleanup.OperationWithCleanups(class_run)
 
783
            for hook in Command.hooks['pre_command']:
 
784
                hook(self)
699
785
            try:
700
 
                return self._operation.run_simple(*args, **kwargs)
 
786
                with cleanup.ExitStack() as self._exit_stack:
 
787
                    return class_run(*args, **kwargs)
701
788
            finally:
702
 
                del self._operation
 
789
                for hook in Command.hooks['post_command']:
 
790
                    hook(self)
703
791
        self.run = run
704
792
 
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
793
    def run(self):
711
794
        """Actually run the command.
712
795
 
717
800
        shell error code if not.  It's OK for this method to allow
718
801
        an exception to raise up.
719
802
 
720
 
        This method is automatically wrapped by Command.__init__ with a 
721
 
        cleanup operation, stored as self._operation. This can be used
 
803
        This method is automatically wrapped by Command.__init__ with a
 
804
        ExitStack, stored as self._exit_stack. This can be used
722
805
        via self.add_cleanup to perform automatic cleanups at the end of
723
806
        run().
724
807
 
738
821
            return None
739
822
        return getdoc(self)
740
823
 
 
824
    def gettext(self, message):
 
825
        """Returns the gettext function used to translate this command's help.
 
826
 
 
827
        Commands provided by plugins should override this to use their
 
828
        own i18n system.
 
829
        """
 
830
        return i18n.gettext_per_paragraph(message)
 
831
 
741
832
    def name(self):
 
833
        """Return the canonical name for this command.
 
834
 
 
835
        The name under which it was actually invoked is available in invoked_as
 
836
        """
742
837
        return _unsquish_command_name(self.__class__.__name__)
743
838
 
744
839
    def plugin_name(self):
746
841
 
747
842
        :return: The name of the plugin or None if the command is builtin.
748
843
        """
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
 
844
        return plugin_name(self.__module__)
754
845
 
755
846
 
756
847
class CommandHooks(Hooks):
762
853
        These are all empty initially, because by default nothing should get
763
854
        notified.
764
855
        """
765
 
        Hooks.__init__(self)
766
 
        self.create_hook(HookPoint('extend_command',
 
856
        Hooks.__init__(self, "breezy.commands", "Command.hooks")
 
857
        self.add_hook(
 
858
            'extend_command',
767
859
            "Called after creating a command object to allow modifications "
768
860
            "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',
 
861
            "new breezy.commands.Command object.", (1, 13))
 
862
        self.add_hook(
 
863
            'get_command',
771
864
            "Called when creating a single command. Called with "
772
865
            "(cmd_or_None, command_name). get_command should either return "
773
866
            "the cmd_or_None parameter, or a replacement Command object that "
774
867
            "should be used for the command. Note that the Command.hooks "
775
868
            "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',
 
869
            "breezy.commands.register_command or plugin_cmds.register_lazy.",
 
870
            (1, 17))
 
871
        self.add_hook(
 
872
            'get_missing_command',
779
873
            "Called when creating a single command if no command could be "
780
874
            "found. Called with (command_name). get_missing_command should "
781
875
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
 
876
            "command.", (1, 17))
 
877
        self.add_hook(
 
878
            'list_commands',
784
879
            "Called when enumerating commands. Called with a set of "
785
880
            "cmd_name strings for all the commands found so far. This set "
786
881
            " is safe to mutate - e.g. to remove a command. "
787
882
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
 
883
            (1, 17))
 
884
        self.add_hook(
 
885
            'pre_command',
 
886
            "Called prior to executing a command. Called with the command "
 
887
            "object.", (2, 6))
 
888
        self.add_hook(
 
889
            'post_command',
 
890
            "Called after executing a command. Called with the command "
 
891
            "object.", (2, 6))
 
892
 
789
893
 
790
894
Command.hooks = CommandHooks()
791
895
 
799
903
    they take, and which commands will accept them.
800
904
    """
801
905
    # TODO: make it a method of the Command?
802
 
    parser = option.get_optparser(command.options())
 
906
    parser = option.get_optparser(
 
907
        [v for k, v in sorted(command.options().items())])
803
908
    if alias_argv is not None:
804
909
        args = alias_argv + argv
805
910
    else:
806
911
        args = argv
807
912
 
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])
 
913
    # python 2's optparse raises this exception if a non-ascii
 
914
    # option name is given.  See http://bugs.python.org/issue2931
 
915
    try:
 
916
        options, args = parser.parse_args(args)
 
917
    except UnicodeEncodeError:
 
918
        raise errors.BzrCommandError(
 
919
            gettext('Only ASCII permitted in option names'))
 
920
 
 
921
    opts = dict((k, v) for k, v in options.__dict__.items() if
 
922
                v is not option.OptionParser.DEFAULT_VALUE)
811
923
    return args, opts
812
924
 
813
925
 
820
932
        if ap[-1] == '?':
821
933
            if args:
822
934
                argdict[argname] = args.pop(0)
823
 
        elif ap[-1] == '*': # all remaining arguments
 
935
        elif ap[-1] == '*':  # all remaining arguments
824
936
            if args:
825
937
                argdict[argname + '_list'] = args[:]
826
938
                args = []
828
940
                argdict[argname + '_list'] = None
829
941
        elif ap[-1] == '+':
830
942
            if not args:
831
 
                raise errors.BzrCommandError("command %r needs one or more %s"
832
 
                                             % (cmd, argname.upper()))
 
943
                raise errors.BzrCommandError(gettext(
 
944
                    "command {0!r} needs one or more {1}").format(
 
945
                    cmd, argname.upper()))
833
946
            else:
834
947
                argdict[argname + '_list'] = args[:]
835
948
                args = []
836
 
        elif ap[-1] == '$': # all but one
 
949
        elif ap[-1] == '$':  # all but one
837
950
            if len(args) < 2:
838
 
                raise errors.BzrCommandError("command %r needs one or more %s"
839
 
                                             % (cmd, argname.upper()))
 
951
                raise errors.BzrCommandError(
 
952
                    gettext("command {0!r} needs one or more {1}").format(
 
953
                        cmd, argname.upper()))
840
954
            argdict[argname + '_list'] = args[:-1]
841
955
            args[:-1] = []
842
956
        else:
843
957
            # just a plain arg
844
958
            argname = ap
845
959
            if not args:
846
 
                raise errors.BzrCommandError("command %r requires argument %s"
847
 
                               % (cmd, argname.upper()))
 
960
                raise errors.BzrCommandError(
 
961
                    gettext("command {0!r} requires argument {1}").format(
 
962
                        cmd, argname.upper()))
848
963
            else:
849
964
                argdict[argname] = args.pop(0)
850
965
 
851
966
    if args:
852
 
        raise errors.BzrCommandError("extra argument to command %s: %s"
853
 
                                     % (cmd, args[0]))
 
967
        raise errors.BzrCommandError(gettext(
 
968
            "extra argument to command {0}: {1}").format(
 
969
            cmd, args[0]))
854
970
 
855
971
    return argdict
856
972
 
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
 
 
 
973
 
 
974
def apply_coveraged(the_callable, *args, **kwargs):
 
975
    import coverage
 
976
    cov = coverage.Coverage()
 
977
    try:
 
978
        config_file = cov.config.config_file
 
979
    except AttributeError:  # older versions of coverage
 
980
        config_file = cov.config_file
 
981
    os.environ['COVERAGE_PROCESS_START'] = config_file
 
982
    cov.start()
866
983
    try:
867
984
        return exception_to_return_code(the_callable, *args, **kwargs)
868
985
    finally:
869
 
        sys.settrace(None)
870
 
        results = tracer.results()
871
 
        results.write_results(show_missing=1, summary=False,
872
 
                              coverdir=dirname)
 
986
        cov.stop()
 
987
        cov.save()
873
988
 
874
989
 
875
990
def apply_profiled(the_callable, *args, **kwargs):
881
996
        prof = hotshot.Profile(pfname)
882
997
        try:
883
998
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
884
 
                **kwargs) or 0
 
999
                               **kwargs) or 0
885
1000
        finally:
886
1001
            prof.close()
887
1002
        stats = hotshot.stats.load(pfname)
888
1003
        stats.strip_dirs()
889
1004
        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
 
1005
        # XXX: Might like to write to stderr or the trace file instead but
 
1006
        # print_stats seems hardcoded to stdout
892
1007
        stats.print_stats(20)
893
1008
        return ret
894
1009
    finally:
905
1020
    """
906
1021
    try:
907
1022
        return the_callable(*args, **kwargs)
908
 
    except (KeyboardInterrupt, Exception), e:
 
1023
    except (KeyboardInterrupt, Exception):
909
1024
        # used to handle AssertionError and KeyboardInterrupt
910
1025
        # specially here, but hopefully they're handled ok by the logger now
911
1026
        exc_info = sys.exc_info()
912
1027
        exitcode = trace.report_exception(exc_info, sys.stderr)
913
 
        if os.environ.get('BZR_PDB'):
914
 
            print '**** entering debugger'
915
 
            tb = exc_info[2]
 
1028
        if os.environ.get('BRZ_PDB'):
 
1029
            print('**** entering debugger')
916
1030
            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)
 
1031
            pdb.post_mortem(exc_info[2])
937
1032
        return exitcode
938
1033
 
939
1034
 
940
1035
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)
 
1036
    from breezy.lsprof import profile
 
1037
    ret, stats = profile(exception_to_return_code, the_callable,
 
1038
                         *args, **kwargs)
943
1039
    stats.sort()
944
1040
    if filename is None:
945
1041
        stats.pprint()
946
1042
    else:
947
1043
        stats.save(filename)
948
 
        trace.note('Profile data written to "%s".', filename)
 
1044
        trace.note(gettext('Profile data written to "%s".'), filename)
949
1045
    return ret
950
1046
 
951
1047
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
 
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
955
 
 
956
 
 
957
1048
def get_alias(cmd, config=None):
958
1049
    """Return an expanded alias, or None if no alias exists.
959
1050
 
965
1056
        If it is unspecified, the global config will be used.
966
1057
    """
967
1058
    if config is None:
968
 
        import bzrlib.config
969
 
        config = bzrlib.config.GlobalConfig()
 
1059
        import breezy.config
 
1060
        config = breezy.config.GlobalConfig()
970
1061
    alias = config.get_alias(cmd)
971
1062
    if (alias):
972
1063
        return cmdline.split(alias)
1009
1100
        Run under the Python lsprof profiler.
1010
1101
 
1011
1102
    --coverage
1012
 
        Generate line coverage report in the specified directory.
 
1103
        Generate code coverage report
1013
1104
 
1014
1105
    --concurrency
1015
 
        Specify the number of processes that can be run concurrently (selftest).
 
1106
        Specify the number of processes that can be run concurrently
 
1107
        (selftest).
1016
1108
    """
1017
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
 
    argv = list(argv)
1019
 
    trace.mutter("bzr arguments: %r", argv)
 
1109
    trace.mutter("breezy version: " + breezy.__version__)
 
1110
    argv = _specified_or_unicode_argv(argv)
 
1111
    trace.mutter("brz arguments: %r", argv)
1020
1112
 
1021
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1022
 
                opt_no_aliases = False
1023
 
    opt_lsprof_file = opt_coverage_dir = None
 
1113
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1114
        opt_coverage = opt_no_l10n = opt_no_aliases = False
 
1115
    opt_lsprof_file = None
1024
1116
 
1025
1117
    # --no-plugins is handled specially at a very early stage. We need
1026
1118
    # to load plugins before doing other command parsing so that they
1028
1120
 
1029
1121
    argv_copy = []
1030
1122
    i = 0
 
1123
    override_config = []
1031
1124
    while i < len(argv):
1032
1125
        a = argv[i]
1033
1126
        if a == '--profile':
1042
1135
            opt_no_plugins = True
1043
1136
        elif a == '--no-aliases':
1044
1137
            opt_no_aliases = True
 
1138
        elif a == '--no-l10n':
 
1139
            opt_no_l10n = True
1045
1140
        elif a == '--builtin':
1046
1141
            opt_builtin = True
1047
1142
        elif a == '--concurrency':
1048
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
 
1143
            os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1049
1144
            i += 1
1050
1145
        elif a == '--coverage':
1051
 
            opt_coverage_dir = argv[i + 1]
1052
 
            i += 1
 
1146
            opt_coverage = True
 
1147
        elif a == '--profile-imports':
 
1148
            pass  # already handled in startup script Bug #588277
1053
1149
        elif a.startswith('-D'):
1054
1150
            debug.debug_flags.add(a[2:])
 
1151
        elif a.startswith('-O'):
 
1152
            override_config.append(a[2:])
1055
1153
        else:
1056
1154
            argv_copy.append(a)
1057
1155
        i += 1
1058
1156
 
 
1157
    cmdline_overrides = breezy.get_global_state().cmdline_overrides
 
1158
    cmdline_overrides._from_cmdline(override_config)
 
1159
 
1059
1160
    debug.set_debug_flags_from_config()
1060
1161
 
1061
1162
    if not opt_no_plugins:
1077
1178
    if not opt_no_aliases:
1078
1179
        alias_argv = get_alias(argv[0])
1079
1180
        if alias_argv:
1080
 
            user_encoding = osutils.get_user_encoding()
1081
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1181
            argv[0] = alias_argv.pop(0)
1083
1182
 
1084
1183
    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
1184
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1185
    if opt_no_l10n:
 
1186
        cmd_obj.l10n = False
1090
1187
    run = cmd_obj.run_argv_aliases
1091
1188
    run_argv = [argv, alias_argv]
1092
1189
 
1096
1193
        saved_verbosity_level = option._verbosity_level
1097
1194
        option._verbosity_level = 0
1098
1195
        if opt_lsprof:
1099
 
            if opt_coverage_dir:
 
1196
            if opt_coverage:
1100
1197
                trace.warning(
1101
1198
                    '--coverage ignored, because --lsprof is in use.')
1102
1199
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1103
1200
        elif opt_profile:
1104
 
            if opt_coverage_dir:
 
1201
            if opt_coverage:
1105
1202
                trace.warning(
1106
1203
                    '--coverage ignored, because --profile is in use.')
1107
1204
            ret = apply_profiled(run, *run_argv)
1108
 
        elif opt_coverage_dir:
1109
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
1205
        elif opt_coverage:
 
1206
            ret = apply_coveraged(run, *run_argv)
1110
1207
        else:
1111
1208
            ret = run(*run_argv)
1112
1209
        return ret or 0
1117
1214
        if 'memory' in debug.debug_flags:
1118
1215
            trace.debug_memory('Process status after command:', short=False)
1119
1216
        option._verbosity_level = saved_verbosity_level
 
1217
        # Reset the overrides
 
1218
        cmdline_overrides._reset()
1120
1219
 
1121
1220
 
1122
1221
def display_command(func):
1126
1225
            result = func(*args, **kwargs)
1127
1226
            sys.stdout.flush()
1128
1227
            return result
1129
 
        except IOError, e:
 
1228
        except IOError as e:
1130
1229
            if getattr(e, 'errno', None) is None:
1131
1230
                raise
1132
1231
            if e.errno != errno.EPIPE:
1144
1243
    if _list_bzr_commands in Command.hooks["list_commands"]:
1145
1244
        return
1146
1245
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1147
 
        "bzr commands")
 
1246
                                     "bzr commands")
1148
1247
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1149
 
        "bzr commands")
 
1248
                                     "bzr commands")
1150
1249
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
 
        "bzr plugin commands")
 
1250
                                     "bzr plugin commands")
1152
1251
    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
 
 
 
1252
                                     "bzr external command lookup")
 
1253
    Command.hooks.install_named_hook("get_missing_command",
 
1254
                                     _try_plugin_provider,
 
1255
                                     "bzr plugin-provider-db check")
1157
1256
 
1158
1257
 
1159
1258
def _specified_or_unicode_argv(argv):
1161
1260
    # the process arguments in a unicode-safe way.
1162
1261
    if argv is None:
1163
1262
        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
 
1263
    new_argv = []
 
1264
    try:
 
1265
        # ensure all arguments are unicode strings
 
1266
        for a in argv:
 
1267
            if not isinstance(a, string_types):
 
1268
                raise ValueError('not native str or unicode: %r' % (a,))
 
1269
            if isinstance(a, bytes):
 
1270
                # For Python 2 only allow ascii native strings
 
1271
                a = a.decode('ascii')
 
1272
            new_argv.append(a)
 
1273
    except (ValueError, UnicodeDecodeError):
 
1274
        raise errors.BzrError("argv should be list of unicode strings.")
 
1275
    return new_argv
1176
1276
 
1177
1277
 
1178
1278
def main(argv=None):
1179
1279
    """Main entry point of command-line interface.
1180
1280
 
1181
 
    Typically `bzrlib.initialize` should be called first.
 
1281
    Typically `breezy.initialize` should be called first.
1182
1282
 
1183
1283
    :param argv: list of unicode command-line arguments similar to sys.argv.
1184
1284
        argv[0] is script name usually, it will be ignored.
1185
1285
        Don't pass here sys.argv because this list contains plain strings
1186
1286
        and not unicode; pass None instead.
1187
1287
 
1188
 
    :return: exit code of bzr command.
 
1288
    :return: exit code of brz command.
1189
1289
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
 
1290
    if argv is not None:
 
1291
        argv = argv[1:]
1191
1292
    _register_builtin_commands()
1192
1293
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
1294
    trace.mutter("return code %d", ret)
1196
1295
    return ret
1197
1296
 
1200
1299
    """Run a bzr command with parameters as described by argv.
1201
1300
 
1202
1301
    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.
 
1302
    are already applied, and that unicode decoding has already been performed
 
1303
    on argv.
1204
1304
    """
1205
1305
    # done here so that they're covered for every test run
1206
1306
    install_bzr_command_hooks()
1208
1308
 
1209
1309
 
1210
1310
def run_bzr_catch_user_errors(argv):
1211
 
    """Run bzr and report user errors, but let internal errors propagate.
 
1311
    """Run brz and report user errors, but let internal errors propagate.
1212
1312
 
1213
1313
    This is used for the test suite, and might be useful for other programs
1214
1314
    that want to wrap the commandline interface.
1217
1317
    install_bzr_command_hooks()
1218
1318
    try:
1219
1319
        return run_bzr(argv)
1220
 
    except Exception, e:
 
1320
    except Exception as e:
1221
1321
        if (isinstance(e, (OSError, IOError))
1222
 
            or not getattr(e, 'internal_error', True)):
 
1322
                or not getattr(e, 'internal_error', True)):
1223
1323
            trace.report_exception(sys.exc_info(), sys.stderr)
1224
1324
            return 3
1225
1325
        else:
1250
1350
 
1251
1351
 
1252
1352
class Provider(object):
1253
 
    '''Generic class to be overriden by plugins'''
 
1353
    """Generic class to be overriden by plugins"""
1254
1354
 
1255
1355
    def plugin_for_command(self, cmd_name):
1256
 
        '''Takes a command and returns the information for that plugin
 
1356
        """Takes a command and returns the information for that plugin
1257
1357
 
1258
1358
        :return: A dictionary with all the available information
1259
 
        for the requested plugin
1260
 
        '''
 
1359
            for the requested plugin
 
1360
        """
1261
1361
        raise NotImplementedError
1262
1362
 
1263
1363
 
1264
1364
class ProvidersRegistry(registry.Registry):
1265
 
    '''This registry exists to allow other providers to exist'''
 
1365
    """This registry exists to allow other providers to exist"""
1266
1366
 
1267
1367
    def __iter__(self):
1268
 
        for key, provider in self.iteritems():
 
1368
        for key, provider in self.items():
1269
1369
            yield provider
1270
1370
 
 
1371
 
1271
1372
command_providers_registry = ProvidersRegistry()