~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-28 11:39:48 UTC
mfrom: (5993.1.2 trunk)
Revision ID: pqm@pqm.ubuntu.com-20110628113948-nrljydmsqi6kf01c

(vila) Start implementing command help text localization (Inada Naoki)

files modified:
bzrlib/annotate.py

bzrlib/commands.py

bzrlib/export_pot.py

bzrlib/help.py

bzrlib/help_topics/__init__.py

bzrlib/i18n.py

bzrlib/tests/test_export_pot.py

bzrlib/tests/test_help.py

bzrlib/tests/test_i18n.py

doc/en/release-notes/bzr-2.4.txt

Show diffs side-by-side

added added

removed removed

bzrlib/commands.py

cmdline,

debug,

errors,

i18n,

option,

osutils,

trace,

""")

from bzrlib.hooks import Hooks

from bzrlib.i18n import gettext

# Compatibility - Option used to be in commands.

from bzrlib.option import Option

from bzrlib.plugin import disable_plugins, load_plugins

408

410

takes_options = []

409

411

encoding_type = 'strict'

410

412

invoked_as = None

413

l10n = True

411

414

412

415

hidden = False

413

416

485

488

usage help (e.g. Purpose, Usage, Options) with a

486

489

message explaining how to obtain full help.

487

490

"""

491

if self.l10n and not i18n.installed():

492

i18n.install() # Install i18n only for get_help_text for now.

488

493

doc = self.help()

489

if not doc:

490

doc = "No help for this command."

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.")

491

503

492

504

# Extract the summary (purpose) and sections out from the text

493

505

purpose,sections,order = self._get_help_parts(doc)

500

512

501

513

# The header is the purpose and usage

502

514

result = ""

503

result += ':Purpose: %s\n' % purpose

515

result += gettext(':Purpose: %s\n') % (purpose,)

504

516

if usage.find('\n') >= 0:

505

result += ':Usage:\n%s\n' % usage

517

result += gettext(':Usage:\n%s\n') % (usage,)

506

518

else:

507

result += ':Usage: %s\n' % usage

519

result += gettext(':Usage: %s\n') % (usage,)

508

520

result += '\n'

509

521

510

522

# Add the options

512

524

# XXX: optparse implicitly rewraps the help, and not always perfectly,

513

525

# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp

514

526

# 20090319

515

options = option.get_optparser(self.options()).format_option_help()

527

parser = option.get_optparser(self.options())

528

options = parser.format_option_help()

516

529

# FIXME: According to the spec, ReST option lists actually don't

517

530

# support options like --1.14 so that causes syntax errors (in Sphinx

518

531

# at least). As that pattern always appears in the commands that

522

535

if not plain and options.find(' --1.14 ') != -1:

523

536

options = options.replace(' format:\n', ' format::\n\n', 1)

524

537

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:'):]

538

result += gettext(':Options:%s') % (options[len('options:'):],)

529

539

else:

530

540

result += options

531

541

result += '\n'

536

546

if sections.has_key(None):

537

547

text = sections.pop(None)

538

548

text = '\n '.join(text.splitlines())

539

result += ':%s:\n %s\n\n' % ('Description',text)

549

result += gettext(':Description:\n %s\n\n') % (text,)

540

550

541

551

# Add the custom sections (e.g. Examples). Note that there's no need

542

552

# to indent these as they must be indented already in the source.

543

553

if sections:

544

554

for label in order:

545

if sections.has_key(label):

546

result += ':%s:\n%s\n' % (label,sections[label])

555

if label in sections:

556

result += ':%s:\n%s\n' % (label, sections[label])

547

557

result += '\n'

548

558

else:

549

result += ("See bzr help %s for more details and examples.\n\n"

559

result += (gettext("See bzr help %s for more details and examples.\n\n")

550

560

% self.name())

551

561

552

562

# Add the aliases, source (plug-in) and see also links, if any

553

563

if self.aliases:

554

result += ':Aliases: '

564

result += gettext(':Aliases: ')

555

565

result += ', '.join(self.aliases) + '\n'

556

566

plugin_name = self.plugin_name()

557

567

if plugin_name is not None:

558

result += ':From: plugin "%s"\n' % plugin_name

568

result += gettext(':From: plugin "%s"\n') % plugin_name

559

569

see_also = self.get_see_also(additional_see_also)

560

570

if see_also:

561

571

if not plain and see_also_as_links:

567

577

see_also_links.append(item)

568

578

else:

569

579

# Use a Sphinx link for this entry

570

link_text = ":doc:`%s <%s-help>`" % (item, item)

580

link_text = gettext(":doc:`%s <%s-help>`") % (item, item)

571

581

see_also_links.append(link_text)

572

582

see_also = see_also_links

573

result += ':See also: '

574

result += ', '.join(see_also) + '\n'

583

result += gettext(':See also: %s') % ', '.join(see_also) + '\n'

575

584

576

585

# If this will be rendered as plain text, convert it

577

586

if plain:

658

667

def run_argv_aliases(self, argv, alias_argv=None):

659

668

"""Parse the command line and run with extra aliases in alias_argv."""

660

669

args, opts = parse_args(self, argv, alias_argv)

670

self._setup_outf()

661

671

662

672

# Process the standard options

663

673

if 'help' in opts: # e.g. bzr add --help

664

sys.stdout.write(self.get_help_text())

674

self.outf.write(self.get_help_text())

665

675

return 0

666

676

if 'usage' in opts: # e.g. bzr add --usage

667

sys.stdout.write(self.get_help_text(verbose=False))

677

self.outf.write(self.get_help_text(verbose=False))

668

678

return 0

669

679

trace.set_verbosity_level(option._verbosity_level)

670

680

if 'verbose' in self.supported_std_options:

685

695

all_cmd_args = cmdargs.copy()

686

696

all_cmd_args.update(cmdopts)

687

697

688

self._setup_outf()

689

690

698

try:

691

699

return self.run(**all_cmd_args)

692

700

finally:

751

759

return None

752

760

return getdoc(self)

753

761

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

754

770

def name(self):

755

771

"""Return the canonical name for this command.

756

772

1041

1057

argv = _specified_or_unicode_argv(argv)

1042

1058

trace.mutter("bzr arguments: %r", argv)

1043

1059

1044

opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \

1045

opt_no_aliases = False

1060

opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \

1061

opt_no_l10n = opt_no_aliases = False

1046

1062

opt_lsprof_file = opt_coverage_dir = None

1047

1063

1048

1064

# --no-plugins is handled specially at a very early stage. We need

1065

1081

opt_no_plugins = True

1066

1082

elif a == '--no-aliases':

1067

1083

opt_no_aliases = True

1084

elif a == '--no-l10n':

1085

opt_no_l10n = True

1068

1086

elif a == '--builtin':

1069

1087

opt_builtin = True

1070

1088

elif a == '--concurrency':

1106

1124

1107

1125

cmd = argv.pop(0)

1108

1126

cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)

1127

if opt_no_l10n:

1128

cmd.l10n = False

1109

1129

run = cmd_obj.run_argv_aliases

1110

1130

run_argv = [argv, alias_argv]

1111

1131

Older »