/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: 2018-11-16 18:26:22 UTC
  • mfrom: (7167.1.4 run-flake8)
  • Revision ID: breezy.the.bot@gmail.com-20181116182622-qw3gan3hz78a2imw
Add a flake8 test.

Merged from https://code.launchpad.net/~jelmer/brz/run-flake8/+merge/358902

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
17
18
 
18
19
# TODO: Define arguments by objects, rather than just using names.
19
20
# Those objects can specify the expected type of the argument, which
25
26
import os
26
27
import sys
27
28
 
28
 
from bzrlib.lazy_import import lazy_import
 
29
from . import (
 
30
    i18n,
 
31
    option,
 
32
    osutils,
 
33
    )
 
34
 
 
35
from .lazy_import import lazy_import
29
36
lazy_import(globals(), """
30
 
import codecs
31
37
import errno
32
 
import threading
33
 
from warnings import warn
34
38
 
35
 
import bzrlib
36
 
from bzrlib import (
 
39
import breezy
 
40
from breezy import (
 
41
    config,
37
42
    cleanup,
38
43
    cmdline,
39
44
    debug,
40
 
    errors,
41
 
    option,
42
 
    osutils,
43
45
    trace,
44
46
    ui,
45
 
    win32utils,
46
47
    )
47
48
""")
48
49
 
49
 
from bzrlib.hooks import HookPoint, Hooks
 
50
from .hooks import Hooks
 
51
from .i18n import gettext
50
52
# Compatibility - Option used to be in commands.
51
 
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
 
from bzrlib import registry
54
 
from bzrlib.symbol_versioning import (
55
 
    deprecated_function,
56
 
    deprecated_in,
57
 
    deprecated_method,
 
53
from .option import Option
 
54
from .plugin import disable_plugins, load_plugins, plugin_name
 
55
from . import errors, registry
 
56
from .sixish import (
 
57
    string_types,
58
58
    )
59
59
 
60
60
 
 
61
class BzrOptionError(errors.BzrCommandError):
 
62
 
 
63
    _fmt = "Error in command line options"
 
64
 
 
65
 
 
66
class CommandAvailableInPlugin(Exception):
 
67
 
 
68
    internal_error = False
 
69
 
 
70
    def __init__(self, cmd_name, plugin_metadata, provider):
 
71
 
 
72
        self.plugin_metadata = plugin_metadata
 
73
        self.cmd_name = cmd_name
 
74
        self.provider = provider
 
75
 
 
76
    def __str__(self):
 
77
 
 
78
        _fmt = ('"%s" is not a standard brz command. \n'
 
79
                'However, the following official plugin provides this command: %s\n'
 
80
                'You can install it by going to: %s'
 
81
                % (self.cmd_name, self.plugin_metadata['name'],
 
82
                    self.plugin_metadata['url']))
 
83
 
 
84
        return _fmt
 
85
 
 
86
 
61
87
class CommandInfo(object):
62
88
    """Information about a command."""
63
89
 
162
188
 
163
189
 
164
190
def _unsquish_command_name(cmd):
165
 
    return cmd[4:].replace('_','-')
166
 
 
167
 
 
168
 
@deprecated_function(deprecated_in((2, 2, 0)))
169
 
def _builtin_commands():
170
 
    """Return a dict of {name: cmd_class} for builtin commands.
171
 
 
172
 
    :deprecated: Use the builtin_command_registry registry instead
173
 
    """
174
 
    # return dict(name: cmd_class)
175
 
    return dict(builtin_command_registry.items())
 
191
    return cmd[4:].replace('_', '-')
176
192
 
177
193
 
178
194
def _register_builtin_commands():
179
195
    if builtin_command_registry.keys():
180
196
        # only load once
181
197
        return
182
 
    import bzrlib.builtins
183
 
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
 
198
    import breezy.builtins
 
199
    for cmd_class in _scan_module_for_commands(breezy.builtins):
184
200
        builtin_command_registry.register(cmd_class)
185
 
    bzrlib.builtins._register_lazy_builtins()
 
201
    breezy.builtins._register_lazy_builtins()
186
202
 
187
203
 
188
204
def _scan_module_for_commands(module):
189
 
    r = {}
190
 
    for name, obj in module.__dict__.iteritems():
 
205
    module_dict = module.__dict__
 
206
    for name in module_dict:
191
207
        if name.startswith("cmd_"):
192
 
            real_name = _unsquish_command_name(name)
193
 
            r[real_name] = obj
194
 
    return r
 
208
            yield module_dict[name]
195
209
 
196
210
 
197
211
def _list_bzr_commands(names):
222
236
    Use of all_command_names() is encouraged rather than builtin_command_names
223
237
    and/or plugin_command_names.
224
238
    """
 
239
    _register_builtin_commands()
225
240
    return builtin_command_registry.keys()
226
241
 
227
242
 
230
245
    return plugin_cmds.keys()
231
246
 
232
247
 
 
248
# Overrides for common mispellings that heuristics get wrong
 
249
_GUESS_OVERRIDES = {
 
250
    'ic': {'ci': 0}, # heuristic finds nick
 
251
    }
 
252
 
 
253
 
 
254
def guess_command(cmd_name):
 
255
    """Guess what command a user typoed.
 
256
 
 
257
    :param cmd_name: Command to search for
 
258
    :return: None if no command was found, name of a command otherwise
 
259
    """
 
260
    names = set()
 
261
    for name in all_command_names():
 
262
        names.add(name)
 
263
        cmd = get_cmd_object(name)
 
264
        names.update(cmd.aliases)
 
265
    # candidate: modified levenshtein distance against cmd_name.
 
266
    costs = {}
 
267
    from . import patiencediff
 
268
    for name in sorted(names):
 
269
        matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
 
270
        distance = 0.0
 
271
        opcodes = matcher.get_opcodes()
 
272
        for opcode, l1, l2, r1, r2 in opcodes:
 
273
            if opcode == 'delete':
 
274
                distance += l2-l1
 
275
            elif opcode == 'replace':
 
276
                distance += max(l2-l1, r2-l1)
 
277
            elif opcode == 'insert':
 
278
                distance += r2-r1
 
279
            elif opcode == 'equal':
 
280
                # Score equal ranges lower, making similar commands of equal
 
281
                # length closer than arbitrary same length commands.
 
282
                distance -= 0.1 * (l2-l1)
 
283
        costs[name] = distance
 
284
    costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
 
285
    costs = sorted((costs[key], key) for key in costs)
 
286
    if not costs:
 
287
        return
 
288
    if costs[0][0] > 4:
 
289
        return
 
290
    candidate = costs[0][1]
 
291
    return candidate
 
292
 
 
293
 
233
294
def get_cmd_object(cmd_name, plugins_override=True):
234
295
    """Return the command object for a command.
235
296
 
239
300
    try:
240
301
        return _get_cmd_object(cmd_name, plugins_override)
241
302
    except KeyError:
242
 
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
 
303
        # No command found, see if this was a typo
 
304
        candidate = guess_command(cmd_name)
 
305
        if candidate is not None:
 
306
            raise errors.BzrCommandError(
 
307
                    gettext('unknown command "%s". Perhaps you meant "%s"')
 
308
                    % (cmd_name, candidate))
 
309
        raise errors.BzrCommandError(gettext('unknown command "%s"')
 
310
                % cmd_name)
243
311
 
244
312
 
245
313
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
275
343
    # Allow plugins to extend commands
276
344
    for hook in Command.hooks['extend_command']:
277
345
        hook(cmd)
 
346
    if getattr(cmd, 'invoked_as', None) is None:
 
347
        cmd.invoked_as = cmd_name
278
348
    return cmd
279
349
 
280
350
 
 
351
class NoPluginAvailable(errors.BzrError):
 
352
    pass
 
353
 
 
354
 
281
355
def _try_plugin_provider(cmd_name):
282
356
    """Probe for a plugin provider having cmd_name."""
283
357
    try:
284
358
        plugin_metadata, provider = probe_for_provider(cmd_name)
285
 
        raise errors.CommandAvailableInPlugin(cmd_name,
286
 
            plugin_metadata, provider)
287
 
    except errors.NoPluginAvailable:
 
359
        raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
 
360
    except NoPluginAvailable:
288
361
        pass
289
362
 
290
363
 
299
372
    for provider in command_providers_registry:
300
373
        try:
301
374
            return provider.plugin_for_command(cmd_name), provider
302
 
        except errors.NoPluginAvailable:
 
375
        except NoPluginAvailable:
303
376
            pass
304
 
    raise errors.NoPluginAvailable(cmd_name)
 
377
    raise NoPluginAvailable(cmd_name)
305
378
 
306
379
 
307
380
def _get_bzr_command(cmd_or_None, cmd_name):
320
393
    # Only do external command lookups when no command is found so far.
321
394
    if cmd_or_None is not None:
322
395
        return cmd_or_None
323
 
    from bzrlib.externalcommand import ExternalCommand
 
396
    from breezy.externalcommand import ExternalCommand
324
397
    cmd_obj = ExternalCommand.find_command(cmd_name)
325
398
    if cmd_obj:
326
399
        return cmd_obj
327
400
 
328
401
 
329
402
def _get_plugin_command(cmd_or_None, cmd_name):
330
 
    """Get a command from bzr's plugins."""
 
403
    """Get a command from brz's plugins."""
331
404
    try:
332
405
        return plugin_cmds.get(cmd_name)()
333
406
    except KeyError:
342
415
class Command(object):
343
416
    """Base class for commands.
344
417
 
345
 
    Commands are the heart of the command-line bzr interface.
 
418
    Commands are the heart of the command-line brz interface.
346
419
 
347
420
    The command object mostly handles the mapping of command-line
348
 
    parameters into one or more bzrlib operations, and of the results
 
421
    parameters into one or more breezy operations, and of the results
349
422
    into textual output.
350
423
 
351
424
    Commands normally don't have any state.  All their arguments are
357
430
    summary, then a complete description of the command.  A grammar
358
431
    description will be inserted.
359
432
 
360
 
    aliases
361
 
        Other accepted names for this command.
362
 
 
363
 
    takes_args
364
 
        List of argument forms, marked with whether they are optional,
365
 
        repeated, etc.
366
 
 
367
 
                Examples:
368
 
 
369
 
                ['to_location', 'from_branch?', 'file*']
370
 
 
371
 
                'to_location' is required
372
 
                'from_branch' is optional
373
 
                'file' can be specified 0 or more times
374
 
 
375
 
    takes_options
376
 
        List of options that may be given for this command.  These can
377
 
        be either strings, referring to globally-defined options,
378
 
        or option objects.  Retrieve through options().
379
 
 
380
 
    hidden
381
 
        If true, this command isn't advertised.  This is typically
 
433
    :cvar aliases: Other accepted names for this command.
 
434
 
 
435
    :cvar takes_args: List of argument forms, marked with whether they are
 
436
        optional, repeated, etc.  Examples::
 
437
 
 
438
            ['to_location', 'from_branch?', 'file*']
 
439
 
 
440
        * 'to_location' is required
 
441
        * 'from_branch' is optional
 
442
        * 'file' can be specified 0 or more times
 
443
 
 
444
    :cvar takes_options: List of options that may be given for this command.
 
445
        These can be either strings, referring to globally-defined options, or
 
446
        option objects.  Retrieve through options().
 
447
 
 
448
    :cvar hidden: If true, this command isn't advertised.  This is typically
382
449
        for commands intended for expert users.
383
450
 
384
 
    encoding_type
385
 
        Command objects will get a 'outf' attribute, which has been
386
 
        setup to properly handle encoding of unicode strings.
387
 
        encoding_type determines what will happen when characters cannot
388
 
        be encoded
389
 
            strict - abort if we cannot decode
390
 
            replace - put in a bogus character (typically '?')
391
 
            exact - do not encode sys.stdout
392
 
 
393
 
            NOTE: by default on Windows, sys.stdout is opened as a text
394
 
            stream, therefore LF line-endings are converted to CRLF.
395
 
            When a command uses encoding_type = 'exact', then
396
 
            sys.stdout is forced to be a binary stream, and line-endings
397
 
            will not mangled.
 
451
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
 
452
        been setup to properly handle encoding of unicode strings.
 
453
        encoding_type determines what will happen when characters cannot be
 
454
        encoded:
 
455
 
 
456
        * strict - abort if we cannot decode
 
457
        * replace - put in a bogus character (typically '?')
 
458
        * exact - do not encode sys.stdout
 
459
 
 
460
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
 
461
        therefore LF line-endings are converted to CRLF.  When a command uses
 
462
        encoding_type = 'exact', then sys.stdout is forced to be a binary
 
463
        stream, and line-endings will not mangled.
 
464
 
 
465
    :cvar invoked_as:
 
466
        A string indicating the real name under which this command was
 
467
        invoked, before expansion of aliases.
 
468
        (This may be None if the command was constructed and run in-process.)
398
469
 
399
470
    :cvar hooks: An instance of CommandHooks.
 
471
 
 
472
    :cvar __doc__: The help shown by 'brz help command' for this command.
 
473
        This is set by assigning explicitly to __doc__ so that -OO can
 
474
        be used::
 
475
 
 
476
            class Foo(Command):
 
477
                __doc__ = "My help goes here"
400
478
    """
401
479
    aliases = []
402
480
    takes_args = []
403
481
    takes_options = []
404
482
    encoding_type = 'strict'
 
483
    invoked_as = None
 
484
    l10n = True
405
485
 
406
486
    hidden = False
407
487
 
408
488
    def __init__(self):
409
489
        """Construct an instance of this command."""
410
 
        if self.__doc__ == Command.__doc__:
411
 
            warn("No help message set for %r" % self)
412
490
        # List of standard options directly supported
413
491
        self.supported_std_options = []
414
492
        self._setup_run()
435
513
        """
436
514
        self._operation.cleanup_now()
437
515
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
 
    def _maybe_expand_globs(self, file_list):
440
 
        """Glob expand file_list if the platform does not do that itself.
441
 
 
442
 
        Not used anymore, now that the bzr command-line parser globs on
443
 
        Windows.
444
 
 
445
 
        :return: A possibly empty list of unicode paths.
446
 
 
447
 
        Introduced in bzrlib 0.18.
448
 
        """
449
 
        return file_list
450
 
 
451
516
    def _usage(self):
452
517
        """Return single-line grammar for this command.
453
518
 
454
519
        Only describes arguments, not options.
455
520
        """
456
 
        s = 'bzr ' + self.name() + ' '
 
521
        s = 'brz ' + self.name() + ' '
457
522
        for aname in self.takes_args:
458
523
            aname = aname.upper()
459
524
            if aname[-1] in ['$', '+']:
481
546
            usage help (e.g. Purpose, Usage, Options) with a
482
547
            message explaining how to obtain full help.
483
548
        """
 
549
        if self.l10n:
 
550
            i18n.install()  # Install i18n only for get_help_text for now.
484
551
        doc = self.help()
485
 
        if doc is None:
486
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
552
        if doc:
 
553
            # Note: If self.gettext() translates ':Usage:\n', the section will
 
554
            # be shown after "Description" section and we don't want to
 
555
            # translate the usage string.
 
556
            # Though, brz export-pot don't exports :Usage: section and it must
 
557
            # not be translated.
 
558
            doc = self.gettext(doc)
 
559
        else:
 
560
            doc = gettext("No help for this command.")
487
561
 
488
562
        # Extract the summary (purpose) and sections out from the text
489
 
        purpose,sections,order = self._get_help_parts(doc)
 
563
        purpose, sections, order = self._get_help_parts(doc)
490
564
 
491
565
        # If a custom usage section was provided, use it
492
 
        if sections.has_key('Usage'):
 
566
        if 'Usage' in sections:
493
567
            usage = sections.pop('Usage')
494
568
        else:
495
569
            usage = self._usage()
496
570
 
497
571
        # The header is the purpose and usage
498
572
        result = ""
499
 
        result += ':Purpose: %s\n' % purpose
 
573
        result += gettext(':Purpose: %s\n') % (purpose,)
500
574
        if usage.find('\n') >= 0:
501
 
            result += ':Usage:\n%s\n' % usage
 
575
            result += gettext(':Usage:\n%s\n') % (usage,)
502
576
        else:
503
 
            result += ':Usage:   %s\n' % usage
 
577
            result += gettext(':Usage:   %s\n') % (usage,)
504
578
        result += '\n'
505
579
 
506
580
        # Add the options
508
582
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
509
583
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
510
584
        # 20090319
511
 
        options = option.get_optparser(self.options()).format_option_help()
512
 
        # XXX: According to the spec, ReST option lists actually don't support 
513
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
514
 
        # As that pattern always appears in the commands that break, we trap
515
 
        # on that and then format that block of 'format' options as a literal
516
 
        # block.
517
 
        if not plain and options.find('  --1.9  ') != -1:
 
585
        parser = option.get_optparser([v for k, v in sorted(self.options().items())])
 
586
        options = parser.format_option_help()
 
587
        # FIXME: According to the spec, ReST option lists actually don't
 
588
        # support options like --1.14 so that causes syntax errors (in Sphinx
 
589
        # at least).  As that pattern always appears in the commands that
 
590
        # break, we trap on that and then format that block of 'format' options
 
591
        # as a literal block. We use the most recent format still listed so we
 
592
        # don't have to do that too often -- vila 20110514
 
593
        if not plain and options.find('  --1.14  ') != -1:
518
594
            options = options.replace(' format:\n', ' format::\n\n', 1)
519
595
        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:'):]
 
596
            result += gettext(':Options:%s') % (options[len('options:'):],)
524
597
        else:
525
598
            result += options
526
599
        result += '\n'
528
601
        if verbose:
529
602
            # Add the description, indenting it 2 spaces
530
603
            # to match the indentation of the options
531
 
            if sections.has_key(None):
 
604
            if None in sections:
532
605
                text = sections.pop(None)
533
606
                text = '\n  '.join(text.splitlines())
534
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
607
                result += gettext(':Description:\n  %s\n\n') % (text,)
535
608
 
536
609
            # Add the custom sections (e.g. Examples). Note that there's no need
537
610
            # to indent these as they must be indented already in the source.
538
611
            if sections:
539
612
                for label in order:
540
 
                    if sections.has_key(label):
541
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
613
                    if label in sections:
 
614
                        result += ':%s:\n%s\n' % (label, sections[label])
542
615
                result += '\n'
543
616
        else:
544
 
            result += ("See bzr help %s for more details and examples.\n\n"
 
617
            result += (gettext("See brz help %s for more details and examples.\n\n")
545
618
                % self.name())
546
619
 
547
620
        # Add the aliases, source (plug-in) and see also links, if any
548
621
        if self.aliases:
549
 
            result += ':Aliases:  '
 
622
            result += gettext(':Aliases:  ')
550
623
            result += ', '.join(self.aliases) + '\n'
551
624
        plugin_name = self.plugin_name()
552
625
        if plugin_name is not None:
553
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
626
            result += gettext(':From:     plugin "%s"\n') % plugin_name
554
627
        see_also = self.get_see_also(additional_see_also)
555
628
        if see_also:
556
629
            if not plain and see_also_as_links:
562
635
                        see_also_links.append(item)
563
636
                    else:
564
637
                        # Use a Sphinx link for this entry
565
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
638
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
 
639
                                                                    item, item)
566
640
                        see_also_links.append(link_text)
567
641
                see_also = see_also_links
568
 
            result += ':See also: '
569
 
            result += ', '.join(see_also) + '\n'
 
642
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
570
643
 
571
644
        # If this will be rendered as plain text, convert it
572
645
        if plain:
573
 
            import bzrlib.help_topics
574
 
            result = bzrlib.help_topics.help_as_plain_text(result)
 
646
            import breezy.help_topics
 
647
            result = breezy.help_topics.help_as_plain_text(result)
575
648
        return result
576
649
 
577
650
    @staticmethod
588
661
        """
589
662
        def save_section(sections, order, label, section):
590
663
            if len(section) > 0:
591
 
                if sections.has_key(label):
 
664
                if label in sections:
592
665
                    sections[label] += '\n' + section
593
666
                else:
594
667
                    order.append(label)
598
671
        summary = lines.pop(0)
599
672
        sections = {}
600
673
        order = []
601
 
        label,section = None,''
 
674
        label, section = None, ''
602
675
        for line in lines:
603
676
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
677
                save_section(sections, order, label, section)
605
 
                label,section = line[1:-1],''
 
678
                label, section = line[1:-1], ''
606
679
            elif (label is not None) and len(line) > 1 and 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, string_types):
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.
695
774
        """
696
775
        class_run = self.run
697
776
        def run(*args, **kwargs):
 
777
            for hook in Command.hooks['pre_command']:
 
778
                hook(self)
698
779
            self._operation = cleanup.OperationWithCleanups(class_run)
699
780
            try:
700
781
                return self._operation.run_simple(*args, **kwargs)
701
782
            finally:
702
783
                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
 
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('extend_command',
767
853
            "Called after creating a command object to allow modifications "
768
854
            "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',
 
855
            "new breezy.commands.Command object.", (1, 13))
 
856
        self.add_hook('get_command',
771
857
            "Called when creating a single command. Called with "
772
858
            "(cmd_or_None, command_name). get_command should either return "
773
859
            "the cmd_or_None parameter, or a replacement Command object that "
774
860
            "should be used for the command. Note that the Command.hooks "
775
861
            "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',
 
862
            "breezy.commands.register_command or plugin_cmds.register_lazy.",
 
863
            (1, 17))
 
864
        self.add_hook('get_missing_command',
779
865
            "Called when creating a single command if no command could be "
780
866
            "found. Called with (command_name). get_missing_command should "
781
867
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
 
868
            "command.", (1, 17))
 
869
        self.add_hook('list_commands',
784
870
            "Called when enumerating commands. Called with a set of "
785
871
            "cmd_name strings for all the commands found so far. This set "
786
872
            " is safe to mutate - e.g. to remove a command. "
787
873
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
 
874
            (1, 17))
 
875
        self.add_hook('pre_command',
 
876
            "Called prior to executing a command. Called with the command "
 
877
            "object.", (2, 6))
 
878
        self.add_hook('post_command',
 
879
            "Called after executing a command. Called with the command "
 
880
            "object.", (2, 6))
789
881
 
790
882
Command.hooks = CommandHooks()
791
883
 
799
891
    they take, and which commands will accept them.
800
892
    """
801
893
    # TODO: make it a method of the Command?
802
 
    parser = option.get_optparser(command.options())
 
894
    parser = option.get_optparser(
 
895
            [v for k, v in sorted(command.options().items())])
803
896
    if alias_argv is not None:
804
897
        args = alias_argv + argv
805
898
    else:
806
899
        args = argv
807
900
 
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])
 
901
    # python 2's optparse raises this exception if a non-ascii
 
902
    # option name is given.  See http://bugs.python.org/issue2931
 
903
    try:
 
904
        options, args = parser.parse_args(args)
 
905
    except UnicodeEncodeError as e:
 
906
        raise errors.BzrCommandError(
 
907
            gettext('Only ASCII permitted in option names'))
 
908
 
 
909
    opts = dict((k, v) for k, v in options.__dict__.items() if
 
910
                v is not option.OptionParser.DEFAULT_VALUE)
811
911
    return args, opts
812
912
 
813
913
 
828
928
                argdict[argname + '_list'] = None
829
929
        elif ap[-1] == '+':
830
930
            if not args:
831
 
                raise errors.BzrCommandError("command %r needs one or more %s"
832
 
                                             % (cmd, argname.upper()))
 
931
                raise errors.BzrCommandError(gettext(
 
932
                      "command {0!r} needs one or more {1}").format(
 
933
                      cmd, argname.upper()))
833
934
            else:
834
935
                argdict[argname + '_list'] = args[:]
835
936
                args = []
836
937
        elif ap[-1] == '$': # all but one
837
938
            if len(args) < 2:
838
 
                raise errors.BzrCommandError("command %r needs one or more %s"
839
 
                                             % (cmd, argname.upper()))
 
939
                raise errors.BzrCommandError(
 
940
                      gettext("command {0!r} needs one or more {1}").format(
 
941
                                             cmd, argname.upper()))
840
942
            argdict[argname + '_list'] = args[:-1]
841
943
            args[:-1] = []
842
944
        else:
843
945
            # just a plain arg
844
946
            argname = ap
845
947
            if not args:
846
 
                raise errors.BzrCommandError("command %r requires argument %s"
847
 
                               % (cmd, argname.upper()))
 
948
                raise errors.BzrCommandError(
 
949
                     gettext("command {0!r} requires argument {1}").format(
 
950
                               cmd, argname.upper()))
848
951
            else:
849
952
                argdict[argname] = args.pop(0)
850
953
 
851
954
    if args:
852
 
        raise errors.BzrCommandError("extra argument to command %s: %s"
853
 
                                     % (cmd, args[0]))
 
955
        raise errors.BzrCommandError( gettext(
 
956
                              "extra argument to command {0}: {1}").format(
 
957
                                       cmd, args[0]) )
854
958
 
855
959
    return argdict
856
960
 
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
 
 
 
961
 
 
962
def apply_coveraged(the_callable, *args, **kwargs):
 
963
    import coverage
 
964
    cov = coverage.Coverage()
 
965
    os.environ['COVERAGE_PROCESS_START'] = cov.config_file
 
966
    cov.start()
866
967
    try:
867
968
        return exception_to_return_code(the_callable, *args, **kwargs)
868
969
    finally:
869
 
        sys.settrace(None)
870
 
        results = tracer.results()
871
 
        results.write_results(show_missing=1, summary=False,
872
 
                              coverdir=dirname)
 
970
        cov.stop()
 
971
        cov.save()
873
972
 
874
973
 
875
974
def apply_profiled(the_callable, *args, **kwargs):
905
1004
    """
906
1005
    try:
907
1006
        return the_callable(*args, **kwargs)
908
 
    except (KeyboardInterrupt, Exception), e:
 
1007
    except (KeyboardInterrupt, Exception) as e:
909
1008
        # used to handle AssertionError and KeyboardInterrupt
910
1009
        # specially here, but hopefully they're handled ok by the logger now
911
1010
        exc_info = sys.exc_info()
912
1011
        exitcode = trace.report_exception(exc_info, sys.stderr)
913
 
        if os.environ.get('BZR_PDB'):
914
 
            print '**** entering debugger'
915
 
            tb = exc_info[2]
 
1012
        if os.environ.get('BRZ_PDB'):
 
1013
            print('**** entering debugger')
916
1014
            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)
 
1015
            pdb.post_mortem(exc_info[2])
937
1016
        return exitcode
938
1017
 
939
1018
 
940
1019
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)
 
1020
    from breezy.lsprof import profile
 
1021
    ret, stats = profile(exception_to_return_code, the_callable,
 
1022
                         *args, **kwargs)
943
1023
    stats.sort()
944
1024
    if filename is None:
945
1025
        stats.pprint()
946
1026
    else:
947
1027
        stats.save(filename)
948
 
        trace.note('Profile data written to "%s".', filename)
 
1028
        trace.note(gettext('Profile data written to "%s".'), filename)
949
1029
    return ret
950
1030
 
951
1031
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
 
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
955
 
 
956
 
 
957
1032
def get_alias(cmd, config=None):
958
1033
    """Return an expanded alias, or None if no alias exists.
959
1034
 
965
1040
        If it is unspecified, the global config will be used.
966
1041
    """
967
1042
    if config is None:
968
 
        import bzrlib.config
969
 
        config = bzrlib.config.GlobalConfig()
 
1043
        import breezy.config
 
1044
        config = breezy.config.GlobalConfig()
970
1045
    alias = config.get_alias(cmd)
971
1046
    if (alias):
972
1047
        return cmdline.split(alias)
1009
1084
        Run under the Python lsprof profiler.
1010
1085
 
1011
1086
    --coverage
1012
 
        Generate line coverage report in the specified directory.
 
1087
        Generate code coverage report
1013
1088
 
1014
1089
    --concurrency
1015
1090
        Specify the number of processes that can be run concurrently (selftest).
1016
1091
    """
1017
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
 
    argv = list(argv)
1019
 
    trace.mutter("bzr arguments: %r", argv)
 
1092
    trace.mutter("breezy version: " + breezy.__version__)
 
1093
    argv = _specified_or_unicode_argv(argv)
 
1094
    trace.mutter("brz arguments: %r", argv)
1020
1095
 
1021
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1022
 
                opt_no_aliases = False
1023
 
    opt_lsprof_file = opt_coverage_dir = None
 
1096
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1097
            opt_coverage = opt_no_l10n = opt_no_aliases = False
 
1098
    opt_lsprof_file = None
1024
1099
 
1025
1100
    # --no-plugins is handled specially at a very early stage. We need
1026
1101
    # to load plugins before doing other command parsing so that they
1028
1103
 
1029
1104
    argv_copy = []
1030
1105
    i = 0
 
1106
    override_config = []
1031
1107
    while i < len(argv):
1032
1108
        a = argv[i]
1033
1109
        if a == '--profile':
1042
1118
            opt_no_plugins = True
1043
1119
        elif a == '--no-aliases':
1044
1120
            opt_no_aliases = True
 
1121
        elif a == '--no-l10n':
 
1122
            opt_no_l10n = True
1045
1123
        elif a == '--builtin':
1046
1124
            opt_builtin = True
1047
1125
        elif a == '--concurrency':
1048
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
 
1126
            os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1049
1127
            i += 1
1050
1128
        elif a == '--coverage':
1051
 
            opt_coverage_dir = argv[i + 1]
1052
 
            i += 1
 
1129
            opt_coverage = True
 
1130
        elif a == '--profile-imports':
 
1131
            pass # already handled in startup script Bug #588277
1053
1132
        elif a.startswith('-D'):
1054
1133
            debug.debug_flags.add(a[2:])
 
1134
        elif a.startswith('-O'):
 
1135
            override_config.append(a[2:])
1055
1136
        else:
1056
1137
            argv_copy.append(a)
1057
1138
        i += 1
1058
1139
 
 
1140
    cmdline_overrides = breezy.get_global_state().cmdline_overrides
 
1141
    cmdline_overrides._from_cmdline(override_config)
 
1142
 
1059
1143
    debug.set_debug_flags_from_config()
1060
1144
 
1061
1145
    if not opt_no_plugins:
1077
1161
    if not opt_no_aliases:
1078
1162
        alias_argv = get_alias(argv[0])
1079
1163
        if alias_argv:
1080
 
            user_encoding = osutils.get_user_encoding()
1081
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1164
            argv[0] = alias_argv.pop(0)
1083
1165
 
1084
1166
    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
1167
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1168
    if opt_no_l10n:
 
1169
        cmd_obj.l10n = False
1090
1170
    run = cmd_obj.run_argv_aliases
1091
1171
    run_argv = [argv, alias_argv]
1092
1172
 
1096
1176
        saved_verbosity_level = option._verbosity_level
1097
1177
        option._verbosity_level = 0
1098
1178
        if opt_lsprof:
1099
 
            if opt_coverage_dir:
 
1179
            if opt_coverage:
1100
1180
                trace.warning(
1101
1181
                    '--coverage ignored, because --lsprof is in use.')
1102
1182
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1103
1183
        elif opt_profile:
1104
 
            if opt_coverage_dir:
 
1184
            if opt_coverage:
1105
1185
                trace.warning(
1106
1186
                    '--coverage ignored, because --profile is in use.')
1107
1187
            ret = apply_profiled(run, *run_argv)
1108
 
        elif opt_coverage_dir:
1109
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
1188
        elif opt_coverage:
 
1189
            ret = apply_coveraged(run, *run_argv)
1110
1190
        else:
1111
1191
            ret = run(*run_argv)
1112
1192
        return ret or 0
1117
1197
        if 'memory' in debug.debug_flags:
1118
1198
            trace.debug_memory('Process status after command:', short=False)
1119
1199
        option._verbosity_level = saved_verbosity_level
 
1200
        # Reset the overrides 
 
1201
        cmdline_overrides._reset()
1120
1202
 
1121
1203
 
1122
1204
def display_command(func):
1126
1208
            result = func(*args, **kwargs)
1127
1209
            sys.stdout.flush()
1128
1210
            return result
1129
 
        except IOError, e:
 
1211
        except IOError as e:
1130
1212
            if getattr(e, 'errno', None) is None:
1131
1213
                raise
1132
1214
            if e.errno != errno.EPIPE:
1151
1233
        "bzr plugin commands")
1152
1234
    Command.hooks.install_named_hook("get_command", _get_external_command,
1153
1235
        "bzr external command lookup")
1154
 
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
 
        "bzr plugin-provider-db check")
 
1236
    Command.hooks.install_named_hook("get_missing_command",
 
1237
                                     _try_plugin_provider,
 
1238
                                     "bzr plugin-provider-db check")
1156
1239
 
1157
1240
 
1158
1241
 
1161
1244
    # the process arguments in a unicode-safe way.
1162
1245
    if argv is None:
1163
1246
        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
 
1247
    new_argv = []
 
1248
    try:
 
1249
        # ensure all arguments are unicode strings
 
1250
        for a in argv:
 
1251
            if not isinstance(a, string_types):
 
1252
                raise ValueError('not native str or unicode: %r' % (a,))
 
1253
            if isinstance(a, bytes):
 
1254
                # For Python 2 only allow ascii native strings
 
1255
                a = a.decode('ascii')
 
1256
            new_argv.append(a)
 
1257
    except (ValueError, UnicodeDecodeError):
 
1258
        raise errors.BzrError("argv should be list of unicode strings.")
 
1259
    return new_argv
1176
1260
 
1177
1261
 
1178
1262
def main(argv=None):
1179
1263
    """Main entry point of command-line interface.
1180
1264
 
1181
 
    Typically `bzrlib.initialize` should be called first.
 
1265
    Typically `breezy.initialize` should be called first.
1182
1266
 
1183
1267
    :param argv: list of unicode command-line arguments similar to sys.argv.
1184
1268
        argv[0] is script name usually, it will be ignored.
1185
1269
        Don't pass here sys.argv because this list contains plain strings
1186
1270
        and not unicode; pass None instead.
1187
1271
 
1188
 
    :return: exit code of bzr command.
 
1272
    :return: exit code of brz command.
1189
1273
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
 
1274
    if argv is not None:
 
1275
        argv = argv[1:]
1191
1276
    _register_builtin_commands()
1192
1277
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
1278
    trace.mutter("return code %d", ret)
1196
1279
    return ret
1197
1280
 
1208
1291
 
1209
1292
 
1210
1293
def run_bzr_catch_user_errors(argv):
1211
 
    """Run bzr and report user errors, but let internal errors propagate.
 
1294
    """Run brz and report user errors, but let internal errors propagate.
1212
1295
 
1213
1296
    This is used for the test suite, and might be useful for other programs
1214
1297
    that want to wrap the commandline interface.
1217
1300
    install_bzr_command_hooks()
1218
1301
    try:
1219
1302
        return run_bzr(argv)
1220
 
    except Exception, e:
 
1303
    except Exception as e:
1221
1304
        if (isinstance(e, (OSError, IOError))
1222
1305
            or not getattr(e, 'internal_error', True)):
1223
1306
            trace.report_exception(sys.exc_info(), sys.stderr)
1250
1333
 
1251
1334
 
1252
1335
class Provider(object):
1253
 
    '''Generic class to be overriden by plugins'''
 
1336
    """Generic class to be overriden by plugins"""
1254
1337
 
1255
1338
    def plugin_for_command(self, cmd_name):
1256
 
        '''Takes a command and returns the information for that plugin
 
1339
        """Takes a command and returns the information for that plugin
1257
1340
 
1258
1341
        :return: A dictionary with all the available information
1259
 
        for the requested plugin
1260
 
        '''
 
1342
            for the requested plugin
 
1343
        """
1261
1344
        raise NotImplementedError
1262
1345
 
1263
1346
 
1264
1347
class ProvidersRegistry(registry.Registry):
1265
 
    '''This registry exists to allow other providers to exist'''
 
1348
    """This registry exists to allow other providers to exist"""
1266
1349
 
1267
1350
    def __iter__(self):
1268
 
        for key, provider in self.iteritems():
 
1351
        for key, provider in self.items():
1269
1352
            yield provider
1270
1353
 
1271
1354
command_providers_registry = ProvidersRegistry()