Merge lp:~jr/bzr/i18n-enable-translations-everywhere into lp:bzr

[Jonathan Riddell]

enable translations globally

Let's just go for this i18n thing

[Jelmer Vernooij (jelmer)]

Yeah, let's do it.

Rather than installing gettext every time we call out to have something translated, wouldn't it make more sense to call .install from the bzr binary or bzrlib.initialize? That way external users also can control whether or not they would like internationalization.

review: Needs Information (code)

[Jonathan Riddell (jr)]

Thanks for your support :)

This doesn't install gettext every time because install() returns immediately if it is already installed(). I think running install() within i18n.gettext() is preferable because it only does the gettext setup if it is needed, some commands won't need it so that would be a waste of process time.

Running "time bzr status" on an empty directly with gettext installed every times takes the real execution time from typically slightly below 0.1s to slightly above 0.1s so I think it's worth avoiding if possible.

[Jelmer Vernooij (jelmer)]

review: Approve

[Jelmer Vernooij (jelmer)]

I think generally we try to keep the first line of the docstring a single sentence that describes what it does.

Can you perhaps add two newlines before "Useful for ..." ?

[Jonathan Riddell (jr)]

sent to pqm by email

=== modified file 'bzrlib/i18n.py'
--- bzrlib/i18n.py	2011-09-07 14:01:16 +0000
+++ bzrlib/i18n.py	2011-09-13 15:52:33 +0000
@@ -34,6 +34,7 @@
     
     :returns: translated message as unicode.
     """
+    install()
     return _translations.ugettext(message)
 
 
@@ -46,6 +47,7 @@
 
     :returns: translated message as unicode.
     """
+    install()
     return _translations.ungettext(singular, plural, number)
 
 
@@ -66,6 +68,13 @@
     return u'\n\n'.join(ugettext(p) if p else u'' for p in paragraphs)
 
 
+def disable_i18n():
+    """Do not allow i18n to be enabled.  Useful for third party users
+    of bzrlib."""
+    global installed
+    installed = lambda: True
+
+
 def installed():
     return not isinstance(_translations, _gettext.NullTranslations)
 
 
=== modified file 'bzrlib/tests/test_i18n.py'
--- bzrlib/tests/test_i18n.py	2011-09-07 16:32:11 +0000
+++ bzrlib/tests/test_i18n.py	2011-09-13 15:52:33 +0000
@@ -109,6 +109,11 @@
         self.overrideEnv('LANG', None)
         i18n.install()
 
+    def test_disable_i18n(self):
+        i18n.disable_i18n()
+        i18n.install()
+        self.assertTrue(isinstance(i18n._translations, i18n._gettext.NullTranslations))
+
 class TestTranslate(tests.TestCaseWithTransport):
 
     def setUp(self):
 
=== modified file 'doc/en/release-notes/bzr-2.5.txt'
--- doc/en/release-notes/bzr-2.5.txt	2011-09-12 18:40:02 +0000
+++ doc/en/release-notes/bzr-2.5.txt	2011-09-13 15:52:33 +0000
@@ -93,11 +93,9 @@
   option. A value of 0 disables skipping. Named items passed to add are
   never skipped. (Shannon Weyrick, #54624)
 
-* bzr now ships with translations for command help.  (Jonathan
-  Riddell, INADA Naoki, #83941)
-
-* bzr now ships with translations for command errors. (Jonathan
-  Riddell, INADA Naoki)
+* Translations are now enabled for command help, errors and globally
+  for any message using gettext given on output.  (Jonathan Riddell,
+  INADA Naoki, #83941)
 
 Improvements
 ************