← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

add gettext to all the builtin commands outf usage

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
 
28
28
from bzrlib.lazy_import import lazy_import
29
29
lazy_import(globals(), """
30
 
import codecs
31
30
import errno
32
31
import threading
33
 
from warnings import warn
34
32
 
35
33
import bzrlib
36
34
from bzrlib import (
38
36
    cmdline,
39
37
    debug,
40
38
    errors,
 
39
    i18n,
41
40
    option,
42
41
    osutils,
43
42
    trace,
44
43
    ui,
45
 
    win32utils,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.hooks import HookPoint, Hooks
 
47
from bzrlib.hooks import Hooks
 
48
from bzrlib.i18n import gettext
50
49
# Compatibility - Option used to be in commands.
51
50
from bzrlib.option import Option
52
51
from bzrlib.plugin import disable_plugins, load_plugins
165
164
    return cmd[4:].replace('_','-')
166
165
 
167
166
 
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
167
def _register_builtin_commands():
179
168
    if builtin_command_registry.keys():
180
169
        # only load once
276
265
    # Allow plugins to extend commands
277
266
    for hook in Command.hooks['extend_command']:
278
267
        hook(cmd)
 
268
    if getattr(cmd, 'invoked_as', None) is None:
 
269
        cmd.invoked_as = cmd_name
279
270
    return cmd
280
271
 
281
272
 
358
349
    summary, then a complete description of the command.  A grammar
359
350
    description will be inserted.
360
351
 
361
 
    aliases
362
 
        Other accepted names for this command.
363
 
 
364
 
    takes_args
365
 
        List of argument forms, marked with whether they are optional,
366
 
        repeated, etc.
367
 
 
368
 
                Examples:
369
 
 
370
 
                ['to_location', 'from_branch?', 'file*']
371
 
 
372
 
                'to_location' is required
373
 
                'from_branch' is optional
374
 
                'file' can be specified 0 or more times
375
 
 
376
 
    takes_options
377
 
        List of options that may be given for this command.  These can
378
 
        be either strings, referring to globally-defined options,
379
 
        or option objects.  Retrieve through options().
380
 
 
381
 
    hidden
382
 
        If true, this command isn't advertised.  This is typically
 
352
    :cvar aliases: Other accepted names for this command.
 
353
 
 
354
    :cvar takes_args: List of argument forms, marked with whether they are
 
355
        optional, repeated, etc.  Examples::
 
356
 
 
357
            ['to_location', 'from_branch?', 'file*']
 
358
 
 
359
        * 'to_location' is required
 
360
        * 'from_branch' is optional
 
361
        * 'file' can be specified 0 or more times
 
362
 
 
363
    :cvar takes_options: List of options that may be given for this command.
 
364
        These can be either strings, referring to globally-defined options, or
 
365
        option objects.  Retrieve through options().
 
366
 
 
367
    :cvar hidden: If true, this command isn't advertised.  This is typically
383
368
        for commands intended for expert users.
384
369
 
385
 
    encoding_type
386
 
        Command objects will get a 'outf' attribute, which has been
387
 
        setup to properly handle encoding of unicode strings.
388
 
        encoding_type determines what will happen when characters cannot
389
 
        be encoded
390
 
            strict - abort if we cannot decode
391
 
            replace - put in a bogus character (typically '?')
392
 
            exact - do not encode sys.stdout
393
 
 
394
 
            NOTE: by default on Windows, sys.stdout is opened as a text
395
 
            stream, therefore LF line-endings are converted to CRLF.
396
 
            When a command uses encoding_type = 'exact', then
397
 
            sys.stdout is forced to be a binary stream, and line-endings
398
 
            will not mangled.
 
370
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
 
371
        been setup to properly handle encoding of unicode strings.
 
372
        encoding_type determines what will happen when characters cannot be
 
373
        encoded:
 
374
 
 
375
        * strict - abort if we cannot decode
 
376
        * replace - put in a bogus character (typically '?')
 
377
        * exact - do not encode sys.stdout
 
378
 
 
379
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
 
380
        therefore LF line-endings are converted to CRLF.  When a command uses
 
381
        encoding_type = 'exact', then sys.stdout is forced to be a binary
 
382
        stream, and line-endings will not mangled.
 
383
 
 
384
    :cvar invoked_as:
 
385
        A string indicating the real name under which this command was
 
386
        invoked, before expansion of aliases.
 
387
        (This may be None if the command was constructed and run in-process.)
399
388
 
400
389
    :cvar hooks: An instance of CommandHooks.
401
 
    :ivar __doc__: The help shown by 'bzr help command' for this command.
 
390
 
 
391
    :cvar __doc__: The help shown by 'bzr help command' for this command.
402
392
        This is set by assigning explicitly to __doc__ so that -OO can
403
393
        be used::
404
394
 
405
 
        class Foo(Command):
406
 
            __doc__ = "My help goes here"
 
395
            class Foo(Command):
 
396
                __doc__ = "My help goes here"
407
397
    """
408
398
    aliases = []
409
399
    takes_args = []
410
400
    takes_options = []
411
401
    encoding_type = 'strict'
 
402
    invoked_as = None
 
403
    l10n = True
412
404
 
413
405
    hidden = False
414
406
 
440
432
        """
441
433
        self._operation.cleanup_now()
442
434
 
443
 
    @deprecated_method(deprecated_in((2, 1, 0)))
444
 
    def _maybe_expand_globs(self, file_list):
445
 
        """Glob expand file_list if the platform does not do that itself.
446
 
 
447
 
        Not used anymore, now that the bzr command-line parser globs on
448
 
        Windows.
449
 
 
450
 
        :return: A possibly empty list of unicode paths.
451
 
 
452
 
        Introduced in bzrlib 0.18.
453
 
        """
454
 
        return file_list
455
 
 
456
435
    def _usage(self):
457
436
        """Return single-line grammar for this command.
458
437
 
486
465
            usage help (e.g. Purpose, Usage, Options) with a
487
466
            message explaining how to obtain full help.
488
467
        """
 
468
        if self.l10n:
 
469
            i18n.install()  # Install i18n only for get_help_text for now.
489
470
        doc = self.help()
490
 
        if not doc:
491
 
            doc = "No help for this command."
 
471
        if doc:
 
472
            # Note: If self.gettext() translates ':Usage:\n', the section will
 
473
            # be shown after "Description" section and we don't want to
 
474
            # translate the usage string.
 
475
            # Though, bzr export-pot don't exports :Usage: section and it must
 
476
            # not be translated.
 
477
            doc = self.gettext(doc)
 
478
        else:
 
479
            doc = gettext("No help for this command.")
492
480
 
493
481
        # Extract the summary (purpose) and sections out from the text
494
482
        purpose,sections,order = self._get_help_parts(doc)
501
489
 
502
490
        # The header is the purpose and usage
503
491
        result = ""
504
 
        result += ':Purpose: %s\n' % purpose
 
492
        result += gettext(':Purpose: %s\n') % (purpose,)
505
493
        if usage.find('\n') >= 0:
506
 
            result += ':Usage:\n%s\n' % usage
 
494
            result += gettext(':Usage:\n%s\n') % (usage,)
507
495
        else:
508
 
            result += ':Usage:   %s\n' % usage
 
496
            result += gettext(':Usage:   %s\n') % (usage,)
509
497
        result += '\n'
510
498
 
511
499
        # Add the options
513
501
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
514
502
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
515
503
        # 20090319
516
 
        options = option.get_optparser(self.options()).format_option_help()
517
 
        # XXX: According to the spec, ReST option lists actually don't support 
518
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
519
 
        # As that pattern always appears in the commands that break, we trap
520
 
        # on that and then format that block of 'format' options as a literal
521
 
        # block.
522
 
        if not plain and options.find('  --1.9  ') != -1:
 
504
        parser = option.get_optparser(self.options())
 
505
        options = parser.format_option_help()
 
506
        # FIXME: According to the spec, ReST option lists actually don't
 
507
        # support options like --1.14 so that causes syntax errors (in Sphinx
 
508
        # at least).  As that pattern always appears in the commands that
 
509
        # break, we trap on that and then format that block of 'format' options
 
510
        # as a literal block. We use the most recent format still listed so we
 
511
        # don't have to do that too often -- vila 20110514
 
512
        if not plain and options.find('  --1.14  ') != -1:
523
513
            options = options.replace(' format:\n', ' format::\n\n', 1)
524
514
        if options.startswith('Options:'):
525
 
            result += ':' + options
526
 
        elif options.startswith('options:'):
527
 
            # Python 2.4 version of optparse
528
 
            result += ':Options:' + options[len('options:'):]
 
515
            result += gettext(':Options:%s') % (options[len('options:'):],)
529
516
        else:
530
517
            result += options
531
518
        result += '\n'
536
523
            if sections.has_key(None):
537
524
                text = sections.pop(None)
538
525
                text = '\n  '.join(text.splitlines())
539
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
526
                result += gettext(':Description:\n  %s\n\n') % (text,)
540
527
 
541
528
            # Add the custom sections (e.g. Examples). Note that there's no need
542
529
            # to indent these as they must be indented already in the source.
543
530
            if sections:
544
531
                for label in order:
545
 
                    if sections.has_key(label):
546
 
                        result += ':%s:\n%s\n' % (label,sections[label])
 
532
                    if label in sections:
 
533
                        result += ':%s:\n%s\n' % (label, sections[label])
547
534
                result += '\n'
548
535
        else:
549
 
            result += ("See bzr help %s for more details and examples.\n\n"
 
536
            result += (gettext("See bzr help %s for more details and examples.\n\n")
550
537
                % self.name())
551
538
 
552
539
        # Add the aliases, source (plug-in) and see also links, if any
553
540
        if self.aliases:
554
 
            result += ':Aliases:  '
 
541
            result += gettext(':Aliases:  ')
555
542
            result += ', '.join(self.aliases) + '\n'
556
543
        plugin_name = self.plugin_name()
557
544
        if plugin_name is not None:
558
 
            result += ':From:     plugin "%s"\n' % plugin_name
 
545
            result += gettext(':From:     plugin "%s"\n') % plugin_name
559
546
        see_also = self.get_see_also(additional_see_also)
560
547
        if see_also:
561
548
            if not plain and see_also_as_links:
567
554
                        see_also_links.append(item)
568
555
                    else:
569
556
                        # Use a Sphinx link for this entry
570
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
557
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
571
558
                        see_also_links.append(link_text)
572
559
                see_also = see_also_links
573
 
            result += ':See also: '
574
 
            result += ', '.join(see_also) + '\n'
 
560
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
575
561
 
576
562
        # If this will be rendered as plain text, convert it
577
563
        if plain:
658
644
    def run_argv_aliases(self, argv, alias_argv=None):
659
645
        """Parse the command line and run with extra aliases in alias_argv."""
660
646
        args, opts = parse_args(self, argv, alias_argv)
 
647
        self._setup_outf()
661
648
 
662
649
        # Process the standard options
663
650
        if 'help' in opts:  # e.g. bzr add --help
664
 
            sys.stdout.write(self.get_help_text())
 
651
            self.outf.write(self.get_help_text())
665
652
            return 0
666
653
        if 'usage' in opts:  # e.g. bzr add --usage
667
 
            sys.stdout.write(self.get_help_text(verbose=False))
 
654
            self.outf.write(self.get_help_text(verbose=False))
668
655
            return 0
669
656
        trace.set_verbosity_level(option._verbosity_level)
670
657
        if 'verbose' in self.supported_std_options:
685
672
        all_cmd_args = cmdargs.copy()
686
673
        all_cmd_args.update(cmdopts)
687
674
 
688
 
        self._setup_outf()
689
 
 
690
 
        return self.run(**all_cmd_args)
 
675
        try:
 
676
            return self.run(**all_cmd_args)
 
677
        finally:
 
678
            # reset it, so that other commands run in the same process won't
 
679
            # inherit state. Before we reset it, log any activity, so that it
 
680
            # gets properly tracked.
 
681
            ui.ui_factory.log_transport_activity(
 
682
                display=('bytes' in debug.debug_flags))
 
683
            trace.set_verbosity_level(0)
691
684
 
692
685
    def _setup_run(self):
693
686
        """Wrap the defined run method on self with a cleanup.
707
700
                del self._operation
708
701
        self.run = run
709
702
 
710
 
    @deprecated_method(deprecated_in((2, 2, 0)))
711
 
    def run_direct(self, *args, **kwargs):
712
 
        """Deprecated thunk from bzrlib 2.1."""
713
 
        return self.run(*args, **kwargs)
714
 
 
715
703
    def run(self):
716
704
        """Actually run the command.
717
705
 
743
731
            return None
744
732
        return getdoc(self)
745
733
 
 
734
    def gettext(self, message):
 
735
        """Returns the gettext function used to translate this command's help.
 
736
 
 
737
        Commands provided by plugins should override this to use their
 
738
        own i18n system.
 
739
        """
 
740
        return i18n.gettext_per_paragraph(message)
 
741
 
746
742
    def name(self):
 
743
        """Return the canonical name for this command.
 
744
 
 
745
        The name under which it was actually invoked is available in invoked_as.
 
746
        """
747
747
        return _unsquish_command_name(self.__class__.__name__)
748
748
 
749
749
    def plugin_name(self):
767
767
        These are all empty initially, because by default nothing should get
768
768
        notified.
769
769
        """
770
 
        Hooks.__init__(self)
771
 
        self.create_hook(HookPoint('extend_command',
 
770
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
 
771
        self.add_hook('extend_command',
772
772
            "Called after creating a command object to allow modifications "
773
773
            "such as adding or removing options, docs etc. Called with the "
774
 
            "new bzrlib.commands.Command object.", (1, 13), None))
775
 
        self.create_hook(HookPoint('get_command',
 
774
            "new bzrlib.commands.Command object.", (1, 13))
 
775
        self.add_hook('get_command',
776
776
            "Called when creating a single command. Called with "
777
777
            "(cmd_or_None, command_name). get_command should either return "
778
778
            "the cmd_or_None parameter, or a replacement Command object that "
779
779
            "should be used for the command. Note that the Command.hooks "
780
780
            "hooks are core infrastructure. Many users will prefer to use "
781
781
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
 
            (1, 17), None))
783
 
        self.create_hook(HookPoint('get_missing_command',
 
782
            (1, 17))
 
783
        self.add_hook('get_missing_command',
784
784
            "Called when creating a single command if no command could be "
785
785
            "found. Called with (command_name). get_missing_command should "
786
786
            "either return None, or a Command object to be used for the "
787
 
            "command.", (1, 17), None))
788
 
        self.create_hook(HookPoint('list_commands',
 
787
            "command.", (1, 17))
 
788
        self.add_hook('list_commands',
789
789
            "Called when enumerating commands. Called with a set of "
790
790
            "cmd_name strings for all the commands found so far. This set "
791
791
            " is safe to mutate - e.g. to remove a command. "
792
792
            "list_commands should return the updated set of command names.",
793
 
            (1, 17), None))
 
793
            (1, 17))
794
794
 
795
795
Command.hooks = CommandHooks()
796
796
 
810
810
    else:
811
811
        args = argv
812
812
 
813
 
    options, args = parser.parse_args(args)
 
813
    # for python 2.5 and later, optparse raises this exception if a non-ascii
 
814
    # option name is given.  See http://bugs.python.org/issue2931
 
815
    try:
 
816
        options, args = parser.parse_args(args)
 
817
    except UnicodeEncodeError,e:
 
818
        raise errors.BzrCommandError('Only ASCII permitted in option names')
 
819
 
814
820
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
815
821
                 v is not option.OptionParser.DEFAULT_VALUE])
816
822
    return args, opts
944
950
 
945
951
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
946
952
    from bzrlib.lsprof import profile
947
 
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
 
953
    ret, stats = profile(exception_to_return_code, the_callable,
 
954
                         *args, **kwargs)
948
955
    stats.sort()
949
956
    if filename is None:
950
957
        stats.pprint()
954
961
    return ret
955
962
 
956
963
 
957
 
@deprecated_function(deprecated_in((2, 2, 0)))
958
 
def shlex_split_unicode(unsplit):
959
 
    return cmdline.split(unsplit)
960
 
 
961
 
 
962
964
def get_alias(cmd, config=None):
963
965
    """Return an expanded alias, or None if no alias exists.
964
966
 
1020
1022
        Specify the number of processes that can be run concurrently (selftest).
1021
1023
    """
1022
1024
    trace.mutter("bazaar version: " + bzrlib.__version__)
1023
 
    argv = list(argv)
 
1025
    argv = _specified_or_unicode_argv(argv)
1024
1026
    trace.mutter("bzr arguments: %r", argv)
1025
1027
 
1026
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
1027
 
                opt_no_aliases = False
 
1028
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
 
1029
            opt_no_l10n = opt_no_aliases = False
1028
1030
    opt_lsprof_file = opt_coverage_dir = None
1029
1031
 
1030
1032
    # --no-plugins is handled specially at a very early stage. We need
1047
1049
            opt_no_plugins = True
1048
1050
        elif a == '--no-aliases':
1049
1051
            opt_no_aliases = True
 
1052
        elif a == '--no-l10n':
 
1053
            opt_no_l10n = True
1050
1054
        elif a == '--builtin':
1051
1055
            opt_builtin = True
1052
1056
        elif a == '--concurrency':
1088
1092
 
1089
1093
    cmd = argv.pop(0)
1090
1094
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1095
    if opt_no_l10n:
 
1096
        cmd.l10n = False
1091
1097
    run = cmd_obj.run_argv_aliases
1092
1098
    run_argv = [argv, alias_argv]
1093
1099
 
1166
1172
        new_argv = []
1167
1173
        try:
1168
1174
            # ensure all arguments are unicode strings
1169
 
            for a in argv[1:]:
 
1175
            for a in argv:
1170
1176
                if isinstance(a, unicode):
1171
1177
                    new_argv.append(a)
1172
1178
                else:
1188
1194
 
1189
1195
    :return: exit code of bzr command.
1190
1196
    """
1191
 
    argv = _specified_or_unicode_argv(argv)
 
1197
    if argv is not None:
 
1198
        argv = argv[1:]
1192
1199
    _register_builtin_commands()
1193
1200
    ret = run_bzr_catch_errors(argv)
1194
 
    bzrlib.ui.ui_factory.log_transport_activity(
1195
 
        display=('bytes' in debug.debug_flags))
1196
1201
    trace.mutter("return code %d", ret)
1197
1202
    return ret
1198
1203
 
1251
1256
 
1252
1257
 
1253
1258
class Provider(object):
1254
 
    '''Generic class to be overriden by plugins'''
 
1259
    """Generic class to be overriden by plugins"""
1255
1260
 
1256
1261
    def plugin_for_command(self, cmd_name):
1257
 
        '''Takes a command and returns the information for that plugin
 
1262
        """Takes a command and returns the information for that plugin
1258
1263
 
1259
1264
        :return: A dictionary with all the available information
1260
 
        for the requested plugin
1261
 
        '''
 
1265
            for the requested plugin
 
1266
        """
1262
1267
        raise NotImplementedError
1263
1268
 
1264
1269
 
1265
1270
class ProvidersRegistry(registry.Registry):
1266
 
    '''This registry exists to allow other providers to exist'''
 
1271
    """This registry exists to allow other providers to exist"""
1267
1272
 
1268
1273
    def __iter__(self):
1269
1274
        for key, provider in self.iteritems():