← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-06-23 09:17:43 UTC
  • mfrom: (5987.2.1 dupe-test-method-name)
  • Revision ID: pqm@pqm.ubuntu.com-20110623091743-rt1rp0jt21gxexlo
(jelmer) Fix copy-and-pasted test method name in test_chk_map that was
 masking a test. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
36
36
    cmdline,
37
37
    debug,
38
38
    errors,
39
 
    i18n,
40
39
    option,
41
40
    osutils,
42
41
    trace,
45
44
""")
46
45
 
47
46
from bzrlib.hooks import Hooks
48
 
from bzrlib.i18n import gettext
49
47
# Compatibility - Option used to be in commands.
50
48
from bzrlib.option import Option
51
49
from bzrlib.plugin import disable_plugins, load_plugins
410
408
    takes_options = []
411
409
    encoding_type = 'strict'
412
410
    invoked_as = None
413
 
    l10n = True
414
411
 
415
412
    hidden = False
416
413
 
488
485
            usage help (e.g. Purpose, Usage, Options) with a
489
486
            message explaining how to obtain full help.
490
487
        """
491
 
        if self.l10n and not i18n.installed():
492
 
            i18n.install()  # Install i18n only for get_help_text for now.
493
488
        doc = self.help()
494
 
        if doc:
495
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
496
 
            # be shown after "Description" section and we don't want to
497
 
            # translate the usage string.
498
 
            # Though, bzr export-pot don't exports :Usage: section and it must
499
 
            # not be translated.
500
 
            doc = self.gettext(doc)
501
 
        else:
502
 
            doc = gettext("No help for this command.")
 
489
        if not doc:
 
490
            doc = "No help for this command."
503
491
 
504
492
        # Extract the summary (purpose) and sections out from the text
505
493
        purpose,sections,order = self._get_help_parts(doc)
512
500
 
513
501
        # The header is the purpose and usage
514
502
        result = ""
515
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
503
        result += ':Purpose: %s\n' % purpose
516
504
        if usage.find('\n') >= 0:
517
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
505
            result += ':Usage:\n%s\n' % usage
518
506
        else:
519
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
507
            result += ':Usage:   %s\n' % usage
520
508
        result += '\n'
521
509
 
522
510
        # Add the options
524
512
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
525
513
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
526
514
        # 20090319
527
 
        parser = option.get_optparser(self.options())
528
 
        options = parser.format_option_help()
 
515
        options = option.get_optparser(self.options()).format_option_help()
529
516
        # FIXME: According to the spec, ReST option lists actually don't
530
517
        # support options like --1.14 so that causes syntax errors (in Sphinx
531
518
        # at least).  As that pattern always appears in the commands that
535
522
        if not plain and options.find('  --1.14  ') != -1:
536
523
            options = options.replace(' format:\n', ' format::\n\n', 1)
537
524
        if options.startswith('Options:'):
538
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
525
            result += ':' + options
 
526
        elif options.startswith('options:'):
 
527
            # Python 2.4 version of optparse
 
528
            result += ':Options:' + options[len('options:'):]
539
529
        else:
540
530
            result += options
541
531
        result += '\n'
546
536
            if sections.has_key(None):
547
537
                text = sections.pop(None)
548
538
                text = '\n  '.join(text.splitlines())
549
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
539
                result += ':%s:\n  %s\n\n' % ('Description',text)
550
540
 
551
541
            # Add the custom sections (e.g. Examples). Note that there's no need
552
542
            # to indent these as they must be indented already in the source.
553
543
            if sections:
554
544
                for label in order:
555
 
                    if label in sections:
556
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
545
                    if sections.has_key(label):
 
546
                        result += ':%s:\n%s\n' % (label,sections[label])
557
547
                result += '\n'
558
548
        else:
559
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
549
            result += ("See bzr help %s for more details and examples.\n\n"
560
550
                % self.name())
561
551
 
562
552
        # Add the aliases, source (plug-in) and see also links, if any
563
553
        if self.aliases:
564
 
            result += gettext(':Aliases:  ')
 
554
            result += ':Aliases:  '
565
555
            result += ', '.join(self.aliases) + '\n'
566
556
        plugin_name = self.plugin_name()
567
557
        if plugin_name is not None:
568
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
558
            result += ':From:     plugin "%s"\n' % plugin_name
569
559
        see_also = self.get_see_also(additional_see_also)
570
560
        if see_also:
571
561
            if not plain and see_also_as_links:
577
567
                        see_also_links.append(item)
578
568
                    else:
579
569
                        # Use a Sphinx link for this entry
580
 
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
 
570
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
581
571
                        see_also_links.append(link_text)
582
572
                see_also = see_also_links
583
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
573
            result += ':See also: '
 
574
            result += ', '.join(see_also) + '\n'
584
575
 
585
576
        # If this will be rendered as plain text, convert it
586
577
        if plain:
667
658
    def run_argv_aliases(self, argv, alias_argv=None):
668
659
        """Parse the command line and run with extra aliases in alias_argv."""
669
660
        args, opts = parse_args(self, argv, alias_argv)
670
 
        self._setup_outf()
671
661
 
672
662
        # Process the standard options
673
663
        if 'help' in opts:  # e.g. bzr add --help
674
 
            self.outf.write(self.get_help_text())
 
664
            sys.stdout.write(self.get_help_text())
675
665
            return 0
676
666
        if 'usage' in opts:  # e.g. bzr add --usage
677
 
            self.outf.write(self.get_help_text(verbose=False))
 
667
            sys.stdout.write(self.get_help_text(verbose=False))
678
668
            return 0
679
669
        trace.set_verbosity_level(option._verbosity_level)
680
670
        if 'verbose' in self.supported_std_options:
695
685
        all_cmd_args = cmdargs.copy()
696
686
        all_cmd_args.update(cmdopts)
697
687
 
 
688
        self._setup_outf()
 
689
 
698
690
        try:
699
691
            return self.run(**all_cmd_args)
700
692
        finally:
759
751
            return None
760
752
        return getdoc(self)
761
753
 
762
 
    def gettext(self, message):
763
 
        """Returns the gettext function used to translate this command's help.
764
 
 
765
 
        Commands provided by plugins should override this to use their
766
 
        own i18n system.
767
 
        """
768
 
        return i18n.gettext_per_paragraph(message)
769
 
 
770
754
    def name(self):
771
755
        """Return the canonical name for this command.
772
756
 
1057
1041
    argv = _specified_or_unicode_argv(argv)
1058
1042
    trace.mutter("bzr arguments: %r", argv)
1059
1043
 
1060
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1061
 
            opt_no_l10n = opt_no_aliases = False
 
1044
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1045
                opt_no_aliases = False
1062
1046
    opt_lsprof_file = opt_coverage_dir = None
1063
1047
 
1064
1048
    # --no-plugins is handled specially at a very early stage. We need
1081
1065
            opt_no_plugins = True
1082
1066
        elif a == '--no-aliases':
1083
1067
            opt_no_aliases = True
1084
 
        elif a == '--no-l10n':
1085
 
            opt_no_l10n = True
1086
1068
        elif a == '--builtin':
1087
1069
            opt_builtin = True
1088
1070
        elif a == '--concurrency':
1124
1106
 
1125
1107
    cmd = argv.pop(0)
1126
1108
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1127
 
    if opt_no_l10n:
1128
 
        cmd.l10n = False
1129
1109
    run = cmd_obj.run_argv_aliases
1130
1110
    run_argv = [argv, alias_argv]
1131
1111