Merge lp:~jr/bzr/i18n-options into lp:bzr

[Jonathan Riddell]

Translate command options help text (e.g. the "Show help message." in "-h, --help Show help message.")

This copies and replaces the normal optparse format_options with a local version that adds gettext()

optparse normally expects gettext() to be called when adding the option but that can't be done with our i18n classes because running our i18n.install() imports config which imports commands which initialises the global Options classes so they exist before i18n can be installed.

Not very elegant :(

[Vincent Ladeuil (vila)]

Some of the problems you're encountering were already mentioned in https://code.launchpad.net/~songofacandy/bzr/i18n-command/+merge/62752

Some of the proposed solutions (which couldn't be applied at that time) may also apply here.

Mainly, OptionParser use HelpFormatter and using our own derived class (instead of overriding lower level methods) should address the import issues by delaying the help formatting until our i18n framework is installed.

As said in the review above, this may require a bit more work upfront but should result in less code in the end and simplify the maintenance in the long term.

Also if "imports config which imports commands" is probably fixable.

I can help on both points if you want.

review: Needs Information

[Vincent Ladeuil (vila)]

@jr: ping, needs any help ?

[Jonathan Riddell (jr)]

better proposal at https://code.launchpad.net/~jr/bzr/i18n-options-3/+merge/73684

Unmerged revisions

6101. By Jonathan Riddell on 2011-08-25

replace format_option with our version which adds gettext() call

=== modified file 'bzrlib/commands.py'
--- bzrlib/commands.py	2011-07-15 14:27:20 +0000
+++ bzrlib/commands.py	2011-08-25 15:27:13 +0000
@@ -22,6 +22,37 @@
 
 # TODO: Specific "examples" property on commands for consistent formatting.
 
+# format_options from optparse.py, 
+# Copyright (c) 2001-2006 Gregory P. Ward
+# Copyright (c) 2002-2006 Python Software Foundation
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+# 
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+# 
+#   * Neither the name of the author nor the names of its
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
 import os
 import sys
 
@@ -330,6 +361,32 @@
             return plugin_cmds.get(key)()
     return cmd_or_None
 
+# taken from Python library's optparse.py
+# to override method from that module's HelpFormatter.format_option method
+# adding a call to gettext for translations
+# See optparse.py for copyright
+def format_option(self, option):
+        result = []
+        opts = self.option_strings[option]
+        opt_width = self.help_position - self.current_indent - 2
+        if len(opts) > opt_width:
+            opts = "%*s%s\n" % (self.current_indent, "", opts)
+            indent_first = self.help_position
+        else:                       # start help on same line as opts
+            opts = "%*s%-*s  " % (self.current_indent, "", opt_width, opts)
+            indent_first = 0
+        result.append(opts)
+        if option.help:
+            help_text = gettext(self.expand_default(option))
+            import textwrap
+            help_lines = textwrap.wrap(help_text, self.help_width)
+            result.append("%*s%s\n" % (indent_first, "", help_lines[0]))
+            result.extend(["%*s%s\n" % (self.help_position, "", line)
+                           for line in help_lines[1:]])
+        elif opts[-1] != "\n":
+            result.append("\n")
+        return "".join(result)
+
 
 class Command(object):
     """Base class for commands.
@@ -502,6 +559,10 @@
         # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
         # 20090319
         parser = option.get_optparser(self.options())
+        # replace format_option with our version above which adds gettext() call.
+        import optparse
+        optparse._ = gettext
+        optparse.HelpFormatter.format_option = format_option
         options = parser.format_option_help()
         # FIXME: According to the spec, ReST option lists actually don't
         # support options like --1.14 so that causes syntax errors (in Sphinx