Started work on per-request gettext setup

ipa_server/context.py

@@ -24,6 +24,9 @@
 #  from ipa_server.context import context
 #  context.foo = "bar"
 
+# FIXME: This module is depreciated and code should switch to using
+# ipalib.request instead
+
 import threading
 
 context = threading.local()

ipalib/constants.py

@@ -25,12 +25,14 @@ All constants centralised in one file.
 # The parameter system treats all these values as None:
 NULLS = (None, '', u'', tuple(), [])
 
-
+# Standard format for TypeError message:
 TYPE_ERROR = '%s: need a %r; got %r (which is a %r)'
 
-
+# Stardard format for TypeError message when a callable is expected:
 CALLABLE_ERROR = '%s: need a callable; got %r (which is a %r)'
 
+# Standard format for StandardError message when overriding an attribute:
+OVERRIDE_ERROR = 'cannot override %s existing value %r with %r'
 
 # Used for a tab (or indentation level) when formatting for CLI:
 CLI_TAB = '  '  # Two spaces

ipalib/request.py

@@ -0,0 +1,48 @@
+# Authors:
+#   Rob Crittenden <rcritten@redhat.com>
+#   Jason Gerard DeRose <jderose@redhat.com>
+#
+# Copyright (C) 2008  Red Hat
+# see file 'COPYING' for use and warranty contextrmation
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2 only
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+"""
+Per-request thread-local data.
+"""
+
+import threading
+import locale
+import gettext
+from constants import OVERRIDE_ERROR
+
+
+# Thread-local storage of most per-request contextrmation
+context = threading.local()
+
+
+# Thread-local storage of gettext.Translations instances (one per gettext
+# domain):
+translations = threading.local()
+
+
+def set_languages(*languages):
+    if hasattr(context, 'languages'):
+        raise StandardError(
+            OVERRIDE_ERROR % ('context.languages', context.languages, languages)
+        )
+    if len(languages) == 0:
+        languages = locale.getdefaultlocale()[:1]
+    context.languages = languages
+    assert type(context.languages) is tuple

tests/test_ipalib/test_request.py

@@ -0,0 +1,56 @@
+# Authors:
+#   Jason Gerard DeRose <jderose@redhat.com>
+#
+# Copyright (C) 2008  Red Hat
+# see file 'COPYING' for use and warranty contextrmation
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2 only
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+"""
+Test the `ipalib.request` module.
+"""
+
+import locale
+from tests.util import raises
+from ipalib.constants import OVERRIDE_ERROR
+from ipalib import request
+
+
+def test_set_languages():
+    """
+    Test the `ipalib.request.set_languages` function.
+    """
+    f = request.set_languages
+    c = request.context
+    langs = ('ru', 'en')
+
+    # Test that StandardError is raised if languages has already been set:
+    assert not hasattr(c, 'languages')
+    c.languages = None
+    e = raises(StandardError, f, *langs)
+    assert str(e) == OVERRIDE_ERROR % ('context.languages', None, langs)
+    del c.languages
+
+    # Test setting the languages:
+    assert not hasattr(c, 'languages')
+    f(*langs)
+    assert c.languages == langs
+    del c.languages
+
+    # Test setting language from locale.getdefaultlocale()
+    assert not hasattr(c, 'languages')
+    f()
+    assert c.languages == locale.getdefaultlocale()[:1]
+    del c.languages
+    assert not hasattr(c, 'languages')