sphinx / sphinx / locale /

# -*- coding: utf-8 -*-

    Locale utilities.

    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
import gettext
import UserString

class _TranslationProxy(UserString.UserString, object):
    """Class for proxy strings from gettext translations.  This is a helper
    for the lazy_* functions from this module.

    The proxy implementation attempts to be as complete as possible, so that
    the lazy objects should mostly work as expected, for example for sorting.

    This inherits from UserString because some docutils versions use UserString
    for their Text nodes, which then checks its argument for being either a
    basestring or UserString, otherwise calls str() -- not unicode() -- on it.
    This also inherits from object to make the __new__ method work.
    __slots__ = ('_func', '_args')

    def __new__(cls, func, *args):
        if not args:
            # not called with "function" and "arguments", but a plain string
            return unicode(func)
        return object.__new__(cls)

    def __getnewargs__(self):
        return (self._func,) + self._args

    def __init__(self, func, *args):
        self._func = func
        self._args = args

    data = property(lambda x: x._func(*x._args))

    # replace function from UserString; it instantiates a self.__class__
    # for the encoding result

    def encode(self, encoding=None, errors=None):
        if encoding:
            if errors:
                return, errors)

    def __contains__(self, key):
        return key in

    def __nonzero__(self):
        return bool(

    def __dir__(self):
        return dir(unicode)

    def __iter__(self):
        return iter(

    def __len__(self):
        return len(

    def __str__(self):
        return str(

    def __unicode__(self):
        return unicode(

    def __add__(self, other):
        return + other

    def __radd__(self, other):
        return other +

    def __mod__(self, other):
        return % other

    def __rmod__(self, other):
        return other %

    def __mul__(self, other):
        return * other

    def __rmul__(self, other):
        return other *

    def __lt__(self, other):
        return < other

    def __le__(self, other):
        return <= other

    def __eq__(self, other):
        return == other

    def __ne__(self, other):
        return != other

    def __gt__(self, other):
        return > other

    def __ge__(self, other):
        return >= other

    def __getattr__(self, name):
        if name == '__members__':
            return self.__dir__()
        return getattr(, name)

    def __getstate__(self):
        return self._func, self._args

    def __setstate__(self, tup):
        self._func, self._args = tup

    def __getitem__(self, key):

    def __copy__(self):
        return self

    def __repr__(self):
            return 'i' + repr(unicode(
            return '<%s broken>' % self.__class__.__name__

def mygettext(string):
    """Used instead of _ when creating TranslationProxies, because _ is
    not bound yet at that time."""
    return _(string)

def lazy_gettext(string):
    """A lazy version of `gettext`."""
    #if isinstance(string, _TranslationProxy):
    #    return string
    return _TranslationProxy(mygettext, string)

l_ = lazy_gettext

admonitionlabels = {
    'attention': l_('Attention'),
    'caution':   l_('Caution'),
    'danger':    l_('Danger'),
    'error':     l_('Error'),
    'hint':      l_('Hint'),
    'important': l_('Important'),
    'note':      l_('Note'),
    'seealso':   l_('See Also'),
    'tip':       l_('Tip'),
    'warning':   l_('Warning'),

versionlabels = {
    'versionadded':   l_('New in version %s'),
    'versionchanged': l_('Changed in version %s'),
    'deprecated':     l_('Deprecated since version %s'),

pairindextypes = {
    'module':    l_('module'),
    'keyword':   l_('keyword'),
    'operator':  l_('operator'),
    'object':    l_('object'),
    'exception': l_('exception'),
    'statement': l_('statement'),
    'builtin':   l_('built-in function'),

translator = None

def _(message):
    return translator.ugettext(message)

def init(locale_dirs, language):
    global translator
    # the None entry is the system's default locale path
    has_translation = True
    for dir_ in locale_dirs:
            trans = gettext.translation('sphinx', localedir=dir_,
            if translator is None:
                translator = trans
        except Exception:
            # Language couldn't be found in the specified path
    if translator is None:
        translator = gettext.NullTranslations()
        has_translation = False
    return translator, has_translation