/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-08-23 01:15:41 UTC
  • mfrom: (7520.1.4 merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200823011541-nv0oh7nzaganx2qy
Merge lp:brz/3.1.

Merged from https://code.launchpad.net/~jelmer/brz/merge-3.1/+merge/389690

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