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

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
18
17
 
19
18
# TODO: Define arguments by objects, rather than just using names.
20
19
# Those objects can specify the expected type of the argument, which
26
25
import os
27
26
import sys
28
27
 
29
 
from . import (
30
 
    i18n,
31
 
    option,
32
 
    osutils,
33
 
    )
34
 
 
35
 
from .lazy_import import lazy_import
 
28
from bzrlib.lazy_import import lazy_import
36
29
lazy_import(globals(), """
 
30
import codecs
37
31
import errno
 
32
import threading
 
33
from warnings import warn
38
34
 
39
 
import breezy
40
 
from breezy import (
41
 
    config,
 
35
import bzrlib
 
36
from bzrlib import (
42
37
    cleanup,
43
38
    cmdline,
44
39
    debug,
 
40
    errors,
 
41
    option,
 
42
    osutils,
45
43
    trace,
46
44
    ui,
 
45
    win32utils,
47
46
    )
48
47
""")
49
48
 
50
 
from .hooks import Hooks
51
 
from .i18n import gettext
 
49
from bzrlib.hooks import HookPoint, Hooks
52
50
# Compatibility - Option used to be in commands.
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,
 
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
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
 
 
87
61
class CommandInfo(object):
88
62
    """Information about a command."""
89
63
 
188
162
 
189
163
 
190
164
def _unsquish_command_name(cmd):
191
 
    return cmd[4:].replace('_', '-')
 
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())
192
176
 
193
177
 
194
178
def _register_builtin_commands():
195
179
    if builtin_command_registry.keys():
196
180
        # only load once
197
181
        return
198
 
    import breezy.builtins
199
 
    for cmd_class in _scan_module_for_commands(breezy.builtins):
 
182
    import bzrlib.builtins
 
183
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
200
184
        builtin_command_registry.register(cmd_class)
201
 
    breezy.builtins._register_lazy_builtins()
 
185
    bzrlib.builtins._register_lazy_builtins()
202
186
 
203
187
 
204
188
def _scan_module_for_commands(module):
205
 
    module_dict = module.__dict__
206
 
    for name in module_dict:
 
189
    r = {}
 
190
    for name, obj in module.__dict__.iteritems():
207
191
        if name.startswith("cmd_"):
208
 
            yield module_dict[name]
 
192
            real_name = _unsquish_command_name(name)
 
193
            r[real_name] = obj
 
194
    return r
209
195
 
210
196
 
211
197
def _list_bzr_commands(names):
236
222
    Use of all_command_names() is encouraged rather than builtin_command_names
237
223
    and/or plugin_command_names.
238
224
    """
239
 
    _register_builtin_commands()
240
225
    return builtin_command_registry.keys()
241
226
 
242
227
 
245
230
    return plugin_cmds.keys()
246
231
 
247
232
 
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
 
 
294
233
def get_cmd_object(cmd_name, plugins_override=True):
295
234
    """Return the command object for a command.
296
235
 
300
239
    try:
301
240
        return _get_cmd_object(cmd_name, plugins_override)
302
241
    except KeyError:
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)
 
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
311
243
 
312
244
 
313
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
343
275
    # Allow plugins to extend commands
344
276
    for hook in Command.hooks['extend_command']:
345
277
        hook(cmd)
346
 
    if getattr(cmd, 'invoked_as', None) is None:
347
 
        cmd.invoked_as = cmd_name
348
278
    return cmd
349
279
 
350
280
 
351
 
class NoPluginAvailable(errors.BzrError):
352
 
    pass
353
 
 
354
 
 
355
281
def _try_plugin_provider(cmd_name):
356
282
    """Probe for a plugin provider having cmd_name."""
357
283
    try:
358
284
        plugin_metadata, provider = probe_for_provider(cmd_name)
359
 
        raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
360
 
    except NoPluginAvailable:
 
285
        raise errors.CommandAvailableInPlugin(cmd_name,
 
286
            plugin_metadata, provider)
 
287
    except errors.NoPluginAvailable:
361
288
        pass
362
289
 
363
290
 
372
299
    for provider in command_providers_registry:
373
300
        try:
374
301
            return provider.plugin_for_command(cmd_name), provider
375
 
        except NoPluginAvailable:
 
302
        except errors.NoPluginAvailable:
376
303
            pass
377
 
    raise NoPluginAvailable(cmd_name)
 
304
    raise errors.NoPluginAvailable(cmd_name)
378
305
 
379
306
 
380
307
def _get_bzr_command(cmd_or_None, cmd_name):
393
320
    # Only do external command lookups when no command is found so far.
394
321
    if cmd_or_None is not None:
395
322
        return cmd_or_None
396
 
    from breezy.externalcommand import ExternalCommand
 
323
    from bzrlib.externalcommand import ExternalCommand
397
324
    cmd_obj = ExternalCommand.find_command(cmd_name)
398
325
    if cmd_obj:
399
326
        return cmd_obj
400
327
 
401
328
 
402
329
def _get_plugin_command(cmd_or_None, cmd_name):
403
 
    """Get a command from brz's plugins."""
 
330
    """Get a command from bzr's plugins."""
404
331
    try:
405
332
        return plugin_cmds.get(cmd_name)()
406
333
    except KeyError:
415
342
class Command(object):
416
343
    """Base class for commands.
417
344
 
418
 
    Commands are the heart of the command-line brz interface.
 
345
    Commands are the heart of the command-line bzr interface.
419
346
 
420
347
    The command object mostly handles the mapping of command-line
421
 
    parameters into one or more breezy operations, and of the results
 
348
    parameters into one or more bzrlib operations, and of the results
422
349
    into textual output.
423
350
 
424
351
    Commands normally don't have any state.  All their arguments are
430
357
    summary, then a complete description of the command.  A grammar
431
358
    description will be inserted.
432
359
 
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
 
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
449
382
        for commands intended for expert users.
450
383
 
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.)
 
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.
469
398
 
470
399
    :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"
478
400
    """
479
401
    aliases = []
480
402
    takes_args = []
481
403
    takes_options = []
482
404
    encoding_type = 'strict'
483
 
    invoked_as = None
484
 
    l10n = True
485
405
 
486
406
    hidden = False
487
407
 
488
408
    def __init__(self):
489
409
        """Construct an instance of this command."""
 
410
        if self.__doc__ == Command.__doc__:
 
411
            warn("No help message set for %r" % self)
490
412
        # List of standard options directly supported
491
413
        self.supported_std_options = []
492
414
        self._setup_run()
513
435
        """
514
436
        self._operation.cleanup_now()
515
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
 
450
 
516
451
    def _usage(self):
517
452
        """Return single-line grammar for this command.
518
453
 
519
454
        Only describes arguments, not options.
520
455
        """
521
 
        s = 'brz ' + self.name() + ' '
 
456
        s = 'bzr ' + self.name() + ' '
522
457
        for aname in self.takes_args:
523
458
            aname = aname.upper()
524
459
            if aname[-1] in ['$', '+']:
546
481
            usage help (e.g. Purpose, Usage, Options) with a
547
482
            message explaining how to obtain full help.
548
483
        """
549
 
        if self.l10n:
550
 
            i18n.install()  # Install i18n only for get_help_text for now.
551
484
        doc = self.help()
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.")
 
485
        if doc is None:
 
486
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
487
 
562
488
        # Extract the summary (purpose) and sections out from the text
563
 
        purpose, sections, order = self._get_help_parts(doc)
 
489
        purpose,sections,order = self._get_help_parts(doc)
564
490
 
565
491
        # If a custom usage section was provided, use it
566
 
        if 'Usage' in sections:
 
492
        if sections.has_key('Usage'):
567
493
            usage = sections.pop('Usage')
568
494
        else:
569
495
            usage = self._usage()
570
496
 
571
497
        # The header is the purpose and usage
572
498
        result = ""
573
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
499
        result += ':Purpose: %s\n' % purpose
574
500
        if usage.find('\n') >= 0:
575
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
501
            result += ':Usage:\n%s\n' % usage
576
502
        else:
577
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
503
            result += ':Usage:   %s\n' % usage
578
504
        result += '\n'
579
505
 
580
506
        # Add the options
582
508
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
583
509
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
584
510
        # 20090319
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:
 
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:
594
518
            options = options.replace(' format:\n', ' format::\n\n', 1)
595
519
        if options.startswith('Options:'):
596
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
520
            result += ':' + options
 
521
        elif options.startswith('options:'):
 
522
            # Python 2.4 version of optparse
 
523
            result += ':Options:' + options[len('options:'):]
597
524
        else:
598
525
            result += options
599
526
        result += '\n'
601
528
        if verbose:
602
529
            # Add the description, indenting it 2 spaces
603
530
            # to match the indentation of the options
604
 
            if None in sections:
 
531
            if sections.has_key(None):
605
532
                text = sections.pop(None)
606
533
                text = '\n  '.join(text.splitlines())
607
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
534
                result += ':%s:\n  %s\n\n' % ('Description',text)
608
535
 
609
536
            # Add the custom sections (e.g. Examples). Note that there's no need
610
537
            # to indent these as they must be indented already in the source.
611
538
            if sections:
612
539
                for label in order:
613
 
                    if label in sections:
614
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
540
                    if sections.has_key(label):
 
541
                        result += ':%s:\n%s\n' % (label,sections[label])
615
542
                result += '\n'
616
543
        else:
617
 
            result += (gettext("See brz help %s for more details and examples.\n\n")
 
544
            result += ("See bzr help %s for more details and examples.\n\n"
618
545
                % self.name())
619
546
 
620
547
        # Add the aliases, source (plug-in) and see also links, if any
621
548
        if self.aliases:
622
 
            result += gettext(':Aliases:  ')
 
549
            result += ':Aliases:  '
623
550
            result += ', '.join(self.aliases) + '\n'
624
551
        plugin_name = self.plugin_name()
625
552
        if plugin_name is not None:
626
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
553
            result += ':From:     plugin "%s"\n' % plugin_name
627
554
        see_also = self.get_see_also(additional_see_also)
628
555
        if see_also:
629
556
            if not plain and see_also_as_links:
635
562
                        see_also_links.append(item)
636
563
                    else:
637
564
                        # Use a Sphinx link for this entry
638
 
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
639
 
                                                                    item, item)
 
565
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
640
566
                        see_also_links.append(link_text)
641
567
                see_also = see_also_links
642
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
568
            result += ':See also: '
 
569
            result += ', '.join(see_also) + '\n'
643
570
 
644
571
        # If this will be rendered as plain text, convert it
645
572
        if plain:
646
 
            import breezy.help_topics
647
 
            result = breezy.help_topics.help_as_plain_text(result)
 
573
            import bzrlib.help_topics
 
574
            result = bzrlib.help_topics.help_as_plain_text(result)
648
575
        return result
649
576
 
650
577
    @staticmethod
661
588
        """
662
589
        def save_section(sections, order, label, section):
663
590
            if len(section) > 0:
664
 
                if label in sections:
 
591
                if sections.has_key(label):
665
592
                    sections[label] += '\n' + section
666
593
                else:
667
594
                    order.append(label)
671
598
        summary = lines.pop(0)
672
599
        sections = {}
673
600
        order = []
674
 
        label, section = None, ''
 
601
        label,section = None,''
675
602
        for line in lines:
676
603
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
677
604
                save_section(sections, order, label, section)
678
 
                label, section = line[1:-1], ''
 
605
                label,section = line[1:-1],''
679
606
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
680
607
                save_section(sections, order, label, section)
681
 
                label, section = None, line
 
608
                label,section = None,line
682
609
            else:
683
610
                if len(section) > 0:
684
611
                    section += '\n' + line
709
636
 
710
637
        Maps from long option name to option object."""
711
638
        r = Option.STD_OPTIONS.copy()
712
 
        std_names = set(r)
 
639
        std_names = r.keys()
713
640
        for o in self.takes_options:
714
 
            if isinstance(o, string_types):
 
641
            if isinstance(o, basestring):
715
642
                o = option.Option.OPTIONS[o]
716
643
            r[o.name] = o
717
644
            if o.name in std_names:
726
653
    def run_argv_aliases(self, argv, alias_argv=None):
727
654
        """Parse the command line and run with extra aliases in alias_argv."""
728
655
        args, opts = parse_args(self, argv, alias_argv)
729
 
        self._setup_outf()
730
656
 
731
657
        # Process the standard options
732
 
        if 'help' in opts:  # e.g. brz add --help
733
 
            self.outf.write(self.get_help_text())
 
658
        if 'help' in opts:  # e.g. bzr add --help
 
659
            sys.stdout.write(self.get_help_text())
734
660
            return 0
735
 
        if 'usage' in opts:  # e.g. brz add --usage
736
 
            self.outf.write(self.get_help_text(verbose=False))
 
661
        if 'usage' in opts:  # e.g. bzr add --usage
 
662
            sys.stdout.write(self.get_help_text(verbose=False))
737
663
            return 0
738
664
        trace.set_verbosity_level(option._verbosity_level)
739
665
        if 'verbose' in self.supported_std_options:
740
666
            opts['verbose'] = trace.is_verbose()
741
 
        elif 'verbose' in opts:
 
667
        elif opts.has_key('verbose'):
742
668
            del opts['verbose']
743
669
        if 'quiet' in self.supported_std_options:
744
670
            opts['quiet'] = trace.is_quiet()
745
 
        elif 'quiet' in opts:
 
671
        elif opts.has_key('quiet'):
746
672
            del opts['quiet']
 
673
 
747
674
        # mix arguments and options into one dictionary
748
675
        cmdargs = _match_argform(self.name(), self.takes_args, args)
749
676
        cmdopts = {}
753
680
        all_cmd_args = cmdargs.copy()
754
681
        all_cmd_args.update(cmdopts)
755
682
 
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)
 
683
        self._setup_outf()
 
684
 
 
685
        return self.run(**all_cmd_args)
765
686
 
766
687
    def _setup_run(self):
767
688
        """Wrap the defined run method on self with a cleanup.
774
695
        """
775
696
        class_run = self.run
776
697
        def run(*args, **kwargs):
777
 
            for hook in Command.hooks['pre_command']:
778
 
                hook(self)
779
698
            self._operation = cleanup.OperationWithCleanups(class_run)
780
699
            try:
781
700
                return self._operation.run_simple(*args, **kwargs)
782
701
            finally:
783
702
                del self._operation
784
 
                for hook in Command.hooks['post_command']:
785
 
                    hook(self)
786
703
        self.run = run
787
704
 
 
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
 
788
710
    def run(self):
789
711
        """Actually run the command.
790
712
 
816
738
            return None
817
739
        return getdoc(self)
818
740
 
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
 
 
827
741
    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
 
        """
832
742
        return _unsquish_command_name(self.__class__.__name__)
833
743
 
834
744
    def plugin_name(self):
836
746
 
837
747
        :return: The name of the plugin or None if the command is builtin.
838
748
        """
839
 
        return plugin_name(self.__module__)
 
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
840
754
 
841
755
 
842
756
class CommandHooks(Hooks):
848
762
        These are all empty initially, because by default nothing should get
849
763
        notified.
850
764
        """
851
 
        Hooks.__init__(self, "breezy.commands", "Command.hooks")
852
 
        self.add_hook('extend_command',
 
765
        Hooks.__init__(self)
 
766
        self.create_hook(HookPoint('extend_command',
853
767
            "Called after creating a command object to allow modifications "
854
768
            "such as adding or removing options, docs etc. Called with the "
855
 
            "new breezy.commands.Command object.", (1, 13))
856
 
        self.add_hook('get_command',
 
769
            "new bzrlib.commands.Command object.", (1, 13), None))
 
770
        self.create_hook(HookPoint('get_command',
857
771
            "Called when creating a single command. Called with "
858
772
            "(cmd_or_None, command_name). get_command should either return "
859
773
            "the cmd_or_None parameter, or a replacement Command object that "
860
774
            "should be used for the command. Note that the Command.hooks "
861
775
            "hooks are core infrastructure. Many users will prefer to use "
862
 
            "breezy.commands.register_command or plugin_cmds.register_lazy.",
863
 
            (1, 17))
864
 
        self.add_hook('get_missing_command',
 
776
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
 
777
            (1, 17), None))
 
778
        self.create_hook(HookPoint('get_missing_command',
865
779
            "Called when creating a single command if no command could be "
866
780
            "found. Called with (command_name). get_missing_command should "
867
781
            "either return None, or a Command object to be used for the "
868
 
            "command.", (1, 17))
869
 
        self.add_hook('list_commands',
 
782
            "command.", (1, 17), None))
 
783
        self.create_hook(HookPoint('list_commands',
870
784
            "Called when enumerating commands. Called with a set of "
871
785
            "cmd_name strings for all the commands found so far. This set "
872
786
            " is safe to mutate - e.g. to remove a command. "
873
787
            "list_commands should return the updated set of command names.",
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))
 
788
            (1, 17), None))
881
789
 
882
790
Command.hooks = CommandHooks()
883
791
 
891
799
    they take, and which commands will accept them.
892
800
    """
893
801
    # TODO: make it a method of the Command?
894
 
    parser = option.get_optparser(
895
 
            [v for k, v in sorted(command.options().items())])
 
802
    parser = option.get_optparser(command.options())
896
803
    if alias_argv is not None:
897
804
        args = alias_argv + argv
898
805
    else:
899
806
        args = argv
900
807
 
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)
 
808
    options, args = parser.parse_args(args)
 
809
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
 
810
                 v is not option.OptionParser.DEFAULT_VALUE])
911
811
    return args, opts
912
812
 
913
813
 
928
828
                argdict[argname + '_list'] = None
929
829
        elif ap[-1] == '+':
930
830
            if not args:
931
 
                raise errors.BzrCommandError(gettext(
932
 
                      "command {0!r} needs one or more {1}").format(
933
 
                      cmd, argname.upper()))
 
831
                raise errors.BzrCommandError("command %r needs one or more %s"
 
832
                                             % (cmd, argname.upper()))
934
833
            else:
935
834
                argdict[argname + '_list'] = args[:]
936
835
                args = []
937
836
        elif ap[-1] == '$': # all but one
938
837
            if len(args) < 2:
939
 
                raise errors.BzrCommandError(
940
 
                      gettext("command {0!r} needs one or more {1}").format(
941
 
                                             cmd, argname.upper()))
 
838
                raise errors.BzrCommandError("command %r needs one or more %s"
 
839
                                             % (cmd, argname.upper()))
942
840
            argdict[argname + '_list'] = args[:-1]
943
841
            args[:-1] = []
944
842
        else:
945
843
            # just a plain arg
946
844
            argname = ap
947
845
            if not args:
948
 
                raise errors.BzrCommandError(
949
 
                     gettext("command {0!r} requires argument {1}").format(
950
 
                               cmd, argname.upper()))
 
846
                raise errors.BzrCommandError("command %r requires argument %s"
 
847
                               % (cmd, argname.upper()))
951
848
            else:
952
849
                argdict[argname] = args.pop(0)
953
850
 
954
851
    if args:
955
 
        raise errors.BzrCommandError( gettext(
956
 
                              "extra argument to command {0}: {1}").format(
957
 
                                       cmd, args[0]) )
 
852
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
853
                                     % (cmd, args[0]))
958
854
 
959
855
    return argdict
960
856
 
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()
 
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
 
967
866
    try:
968
867
        return exception_to_return_code(the_callable, *args, **kwargs)
969
868
    finally:
970
 
        cov.stop()
971
 
        cov.save()
 
869
        sys.settrace(None)
 
870
        results = tracer.results()
 
871
        results.write_results(show_missing=1, summary=False,
 
872
                              coverdir=dirname)
972
873
 
973
874
 
974
875
def apply_profiled(the_callable, *args, **kwargs):
1004
905
    """
1005
906
    try:
1006
907
        return the_callable(*args, **kwargs)
1007
 
    except (KeyboardInterrupt, Exception) as e:
 
908
    except (KeyboardInterrupt, Exception), e:
1008
909
        # used to handle AssertionError and KeyboardInterrupt
1009
910
        # specially here, but hopefully they're handled ok by the logger now
1010
911
        exc_info = sys.exc_info()
1011
912
        exitcode = trace.report_exception(exc_info, sys.stderr)
1012
 
        if os.environ.get('BRZ_PDB'):
1013
 
            print('**** entering debugger')
 
913
        if os.environ.get('BZR_PDB'):
 
914
            print '**** entering debugger'
 
915
            tb = exc_info[2]
1014
916
            import pdb
1015
 
            pdb.post_mortem(exc_info[2])
 
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)
1016
937
        return exitcode
1017
938
 
1018
939
 
1019
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1020
 
    from breezy.lsprof import profile
1021
 
    ret, stats = profile(exception_to_return_code, the_callable,
1022
 
                         *args, **kwargs)
 
941
    from bzrlib.lsprof import profile
 
942
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1023
943
    stats.sort()
1024
944
    if filename is None:
1025
945
        stats.pprint()
1026
946
    else:
1027
947
        stats.save(filename)
1028
 
        trace.note(gettext('Profile data written to "%s".'), filename)
 
948
        trace.note('Profile data written to "%s".', filename)
1029
949
    return ret
1030
950
 
1031
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
 
953
def shlex_split_unicode(unsplit):
 
954
    return cmdline.split(unsplit)
 
955
 
 
956
 
1032
957
def get_alias(cmd, config=None):
1033
958
    """Return an expanded alias, or None if no alias exists.
1034
959
 
1040
965
        If it is unspecified, the global config will be used.
1041
966
    """
1042
967
    if config is None:
1043
 
        import breezy.config
1044
 
        config = breezy.config.GlobalConfig()
 
968
        import bzrlib.config
 
969
        config = bzrlib.config.GlobalConfig()
1045
970
    alias = config.get_alias(cmd)
1046
971
    if (alias):
1047
972
        return cmdline.split(alias)
1084
1009
        Run under the Python lsprof profiler.
1085
1010
 
1086
1011
    --coverage
1087
 
        Generate code coverage report
 
1012
        Generate line coverage report in the specified directory.
1088
1013
 
1089
1014
    --concurrency
1090
1015
        Specify the number of processes that can be run concurrently (selftest).
1091
1016
    """
1092
 
    trace.mutter("breezy version: " + breezy.__version__)
1093
 
    argv = _specified_or_unicode_argv(argv)
1094
 
    trace.mutter("brz arguments: %r", argv)
 
1017
    trace.mutter("bazaar version: " + bzrlib.__version__)
 
1018
    argv = list(argv)
 
1019
    trace.mutter("bzr arguments: %r", argv)
1095
1020
 
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
 
1021
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1022
                opt_no_aliases = False
 
1023
    opt_lsprof_file = opt_coverage_dir = None
1099
1024
 
1100
1025
    # --no-plugins is handled specially at a very early stage. We need
1101
1026
    # to load plugins before doing other command parsing so that they
1103
1028
 
1104
1029
    argv_copy = []
1105
1030
    i = 0
1106
 
    override_config = []
1107
1031
    while i < len(argv):
1108
1032
        a = argv[i]
1109
1033
        if a == '--profile':
1118
1042
            opt_no_plugins = True
1119
1043
        elif a == '--no-aliases':
1120
1044
            opt_no_aliases = True
1121
 
        elif a == '--no-l10n':
1122
 
            opt_no_l10n = True
1123
1045
        elif a == '--builtin':
1124
1046
            opt_builtin = True
1125
1047
        elif a == '--concurrency':
1126
 
            os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
 
1048
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1127
1049
            i += 1
1128
1050
        elif a == '--coverage':
1129
 
            opt_coverage = True
1130
 
        elif a == '--profile-imports':
1131
 
            pass # already handled in startup script Bug #588277
 
1051
            opt_coverage_dir = argv[i + 1]
 
1052
            i += 1
1132
1053
        elif a.startswith('-D'):
1133
1054
            debug.debug_flags.add(a[2:])
1134
 
        elif a.startswith('-O'):
1135
 
            override_config.append(a[2:])
1136
1055
        else:
1137
1056
            argv_copy.append(a)
1138
1057
        i += 1
1139
1058
 
1140
 
    cmdline_overrides = breezy.get_global_state().cmdline_overrides
1141
 
    cmdline_overrides._from_cmdline(override_config)
1142
 
 
1143
1059
    debug.set_debug_flags_from_config()
1144
1060
 
1145
1061
    if not opt_no_plugins:
1161
1077
    if not opt_no_aliases:
1162
1078
        alias_argv = get_alias(argv[0])
1163
1079
        if alias_argv:
 
1080
            user_encoding = osutils.get_user_encoding()
 
1081
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1164
1082
            argv[0] = alias_argv.pop(0)
1165
1083
 
1166
1084
    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
 
1167
1089
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1168
 
    if opt_no_l10n:
1169
 
        cmd_obj.l10n = False
1170
1090
    run = cmd_obj.run_argv_aliases
1171
1091
    run_argv = [argv, alias_argv]
1172
1092
 
1176
1096
        saved_verbosity_level = option._verbosity_level
1177
1097
        option._verbosity_level = 0
1178
1098
        if opt_lsprof:
1179
 
            if opt_coverage:
 
1099
            if opt_coverage_dir:
1180
1100
                trace.warning(
1181
1101
                    '--coverage ignored, because --lsprof is in use.')
1182
1102
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1183
1103
        elif opt_profile:
1184
 
            if opt_coverage:
 
1104
            if opt_coverage_dir:
1185
1105
                trace.warning(
1186
1106
                    '--coverage ignored, because --profile is in use.')
1187
1107
            ret = apply_profiled(run, *run_argv)
1188
 
        elif opt_coverage:
1189
 
            ret = apply_coveraged(run, *run_argv)
 
1108
        elif opt_coverage_dir:
 
1109
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1190
1110
        else:
1191
1111
            ret = run(*run_argv)
1192
1112
        return ret or 0
1197
1117
        if 'memory' in debug.debug_flags:
1198
1118
            trace.debug_memory('Process status after command:', short=False)
1199
1119
        option._verbosity_level = saved_verbosity_level
1200
 
        # Reset the overrides 
1201
 
        cmdline_overrides._reset()
1202
1120
 
1203
1121
 
1204
1122
def display_command(func):
1208
1126
            result = func(*args, **kwargs)
1209
1127
            sys.stdout.flush()
1210
1128
            return result
1211
 
        except IOError as e:
 
1129
        except IOError, e:
1212
1130
            if getattr(e, 'errno', None) is None:
1213
1131
                raise
1214
1132
            if e.errno != errno.EPIPE:
1233
1151
        "bzr plugin commands")
1234
1152
    Command.hooks.install_named_hook("get_command", _get_external_command,
1235
1153
        "bzr external command lookup")
1236
 
    Command.hooks.install_named_hook("get_missing_command",
1237
 
                                     _try_plugin_provider,
1238
 
                                     "bzr plugin-provider-db check")
 
1154
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
 
1155
        "bzr plugin-provider-db check")
1239
1156
 
1240
1157
 
1241
1158
 
1244
1161
    # the process arguments in a unicode-safe way.
1245
1162
    if argv is None:
1246
1163
        return osutils.get_unicode_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
 
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
1176
 
1261
1177
 
1262
1178
def main(argv=None):
1263
1179
    """Main entry point of command-line interface.
1264
1180
 
1265
 
    Typically `breezy.initialize` should be called first.
 
1181
    Typically `bzrlib.initialize` should be called first.
1266
1182
 
1267
1183
    :param argv: list of unicode command-line arguments similar to sys.argv.
1268
1184
        argv[0] is script name usually, it will be ignored.
1269
1185
        Don't pass here sys.argv because this list contains plain strings
1270
1186
        and not unicode; pass None instead.
1271
1187
 
1272
 
    :return: exit code of brz command.
 
1188
    :return: exit code of bzr command.
1273
1189
    """
1274
 
    if argv is not None:
1275
 
        argv = argv[1:]
 
1190
    argv = _specified_or_unicode_argv(argv)
1276
1191
    _register_builtin_commands()
1277
1192
    ret = run_bzr_catch_errors(argv)
 
1193
    bzrlib.ui.ui_factory.log_transport_activity(
 
1194
        display=('bytes' in debug.debug_flags))
1278
1195
    trace.mutter("return code %d", ret)
1279
1196
    return ret
1280
1197
 
1291
1208
 
1292
1209
 
1293
1210
def run_bzr_catch_user_errors(argv):
1294
 
    """Run brz and report user errors, but let internal errors propagate.
 
1211
    """Run bzr and report user errors, but let internal errors propagate.
1295
1212
 
1296
1213
    This is used for the test suite, and might be useful for other programs
1297
1214
    that want to wrap the commandline interface.
1300
1217
    install_bzr_command_hooks()
1301
1218
    try:
1302
1219
        return run_bzr(argv)
1303
 
    except Exception as e:
 
1220
    except Exception, e:
1304
1221
        if (isinstance(e, (OSError, IOError))
1305
1222
            or not getattr(e, 'internal_error', True)):
1306
1223
            trace.report_exception(sys.exc_info(), sys.stderr)
1333
1250
 
1334
1251
 
1335
1252
class Provider(object):
1336
 
    """Generic class to be overriden by plugins"""
 
1253
    '''Generic class to be overriden by plugins'''
1337
1254
 
1338
1255
    def plugin_for_command(self, cmd_name):
1339
 
        """Takes a command and returns the information for that plugin
 
1256
        '''Takes a command and returns the information for that plugin
1340
1257
 
1341
1258
        :return: A dictionary with all the available information
1342
 
            for the requested plugin
1343
 
        """
 
1259
        for the requested plugin
 
1260
        '''
1344
1261
        raise NotImplementedError
1345
1262
 
1346
1263
 
1347
1264
class ProvidersRegistry(registry.Registry):
1348
 
    """This registry exists to allow other providers to exist"""
 
1265
    '''This registry exists to allow other providers to exist'''
1349
1266
 
1350
1267
    def __iter__(self):
1351
 
        for key, provider in self.items():
 
1268
        for key, provider in self.iteritems():
1352
1269
            yield provider
1353
1270
 
1354
1271
command_providers_registry = ProvidersRegistry()