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