/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/commands.py

Use new context stuff.

Show diffs side-by-side

added added

removed removed

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