Merge pull request #3388 from mmerickel/black

Michael Merickel

2018-10-15 bda1306749c62ef4f11cfe567ed7d56c8ad94240

 src/pyramid/i18n.py

@@ -4,9 +4,9 @@
from translationstring import (
    Translator,
    Pluralizer,
    TranslationString, # API
    TranslationStringFactory, # API
    )
    TranslationString,  # API
    TranslationStringFactory,  # API
)

from pyramid.compat import PY2
from pyramid.decorator import reify
@@ -15,7 +15,7 @@
    ILocalizer,
    ITranslationDirectories,
    ILocaleNegotiator,
    )
)

from pyramid.threadlocal import get_current_registry

@@ -24,6 +24,7 @@

DEFAULT_PLURAL = lambda n: int(n != 1)


class Localizer(object):
    """
    An object providing translation and pluralizations related to
@@ -31,6 +32,7 @@
    :class:`pyramid.i18n.Localizer` object is created using the
    :func:`pyramid.i18n.get_localizer` function.
    """

    def __init__(self, locale_name, translations):
        self.locale_name = locale_name
        self.translations = translations
@@ -80,13 +82,13 @@
        and ``plural`` objects should be unicode strings. There is no
        reason to use translation string objects as arguments as all
        metadata is ignored.
        

        ``n`` represents the number of elements. ``domain`` is the
        translation domain to use to do the pluralization, and ``mapping``
        is the interpolation mapping that should be used on the result. If
        the ``domain`` is not supplied, a default domain is used (usually
        ``messages``).
        

        Example::

           num = 1
@@ -108,12 +110,13 @@
                                            num,
                                            mapping={'num':num})

        

        """
        if self.pluralizer is None:
            self.pluralizer = Pluralizer(self.translations)
        return self.pluralizer(singular, plural, n, domain=domain,
                               mapping=mapping)
        return self.pluralizer(
            singular, plural, n, domain=domain, mapping=mapping
        )


def default_locale_negotiator(request):
@@ -124,7 +127,7 @@
      the request object (possibly set by a view or a listener for an
      :term:`event`). If the attribute exists and it is not ``None``,
      its value will be used.
  

    - Then it looks for the ``request.params['_LOCALE_']`` value.

    - Then it looks for the ``request.cookies['_LOCALE_']`` value.
@@ -142,6 +145,7 @@
            locale_name = request.cookies.get(name)
    return locale_name


def negotiate_locale_name(request):
    """ Negotiate and return the :term:`locale name` associated with
    the current request."""
@@ -149,8 +153,9 @@
        registry = request.registry
    except AttributeError:
        registry = get_current_registry()
    negotiator = registry.queryUtility(ILocaleNegotiator,
                                       default=default_locale_negotiator)
    negotiator = registry.queryUtility(
        ILocaleNegotiator, default=default_locale_negotiator
    )
    locale_name = negotiator(request)

    if locale_name is None:
@@ -158,6 +163,7 @@
        locale_name = settings.get('default_locale_name', 'en')

    return locale_name


def get_locale_name(request):
    """
@@ -167,9 +173,10 @@
    """
    return request.locale_name


def make_localizer(current_locale_name, translation_directories):
    """ Create a :class:`pyramid.i18n.Localizer` object
    corresponding to the provided locale name from the 
    corresponding to the provided locale name from the
    translations found in the list of translation directories."""
    translations = Translations()
    translations._catalog = {}
@@ -199,16 +206,17 @@
            if not os.path.isdir(os.path.realpath(messages_dir)):
                continue
            for mofile in os.listdir(messages_dir):
                mopath = os.path.realpath(os.path.join(messages_dir,
                                                       mofile))
                mopath = os.path.realpath(os.path.join(messages_dir, mofile))
                if mofile.endswith('.mo') and os.path.isfile(mopath):
                    with open(mopath, 'rb') as mofp:
                        domain = mofile[:-3]
                        dtrans = Translations(mofp, domain)
                        translations.add(dtrans)

    return Localizer(locale_name=current_locale_name,
                          translations=translations)
    return Localizer(
        locale_name=current_locale_name, translations=translations
    )


def get_localizer(request):
    """
@@ -218,6 +226,7 @@
        corresponding to the current request's locale name.
    """
    return request.localizer


class Translations(gettext.GNUTranslations, object):
    """An extended translation catalog class (ripped off from Babel) """
@@ -272,8 +281,10 @@
            return cls(fileobj=fp, domain=domain)

    def __repr__(self):
        return '<%s: "%s">' % (type(self).__name__,
                               self._info.get('project-id-version'))
        return '<%s: "%s">' % (
            type(self).__name__,
            self._info.get('project-id-version'),
        )

    def add(self, translations, merge=True):
        """Add the given translations to the catalog.
@@ -331,13 +342,13 @@
        domain.
        """
        return self._domains.get(domain, self).gettext(message)
    

    def ldgettext(self, domain, message):
        """Like ``lgettext()``, but look the message up in the specified 
        """Like ``lgettext()``, but look the message up in the specified
        domain.
        """ 
        """
        return self._domains.get(domain, self).lgettext(message)
    

    def dugettext(self, domain, message):
        """Like ``ugettext()``, but look the message up in the specified
        domain.
@@ -346,29 +357,32 @@
            return self._domains.get(domain, self).ugettext(message)
        else:
            return self._domains.get(domain, self).gettext(message)
    

    def dngettext(self, domain, singular, plural, num):
        """Like ``ngettext()``, but look the message up in the specified
        domain.
        """
        return self._domains.get(domain, self).ngettext(singular, plural, num)
    

    def ldngettext(self, domain, singular, plural, num):
        """Like ``lngettext()``, but look the message up in the specified
        domain.
        """
        return self._domains.get(domain, self).lngettext(singular, plural, num)
    

    def dungettext(self, domain, singular, plural, num):
        """Like ``ungettext()`` but look the message up in the specified
        domain.
        """
        if PY2:
            return self._domains.get(domain, self).ungettext(
                singular, plural, num)
                singular, plural, num
            )
        else:
            return self._domains.get(domain, self).ngettext(
                singular, plural, num)
                singular, plural, num
            )


class LocalizerRequestMixin(object):
    @reify
@@ -384,8 +398,9 @@
            tdirs = registry.queryUtility(ITranslationDirectories, default=[])
            localizer = make_localizer(current_locale_name, tdirs)

            registry.registerUtility(localizer, ILocalizer,
                                     name=current_locale_name)
            registry.registerUtility(
                localizer, ILocalizer, name=current_locale_name
            )

        return localizer

@@ -393,5 +408,3 @@
    def locale_name(self):
        locale_name = negotiate_locale_name(self)
        return locale_name