i:Oc @ sv d Z d d l m Z d d d f f Z e e Z d d l Z d d l m Z d d l Z d d l Z d d l
Z
d d l Z d d l Z y d d l m
Z Wn, e k
r e j j e j d d Z n Xd d
l m Z m Z d d l m Z i Z d e e j f d
YZ d e e j f d YZ e e e e e d Z! e e d Z" d d d d f Z# d S( s
:term:`I18N` is an important piece of any modern program. Unfortunately,
setting up :term:`i18n` in your program is often a confusing process. The
functions provided here aim to make the programming side of that a little
easier.
Most projects will be able to do something like this when they startup::
# myprogram/__init__.py:
import os
import sys
from kitchen.i18n import easy_gettext_setup
_, N_ = easy_gettext_setup('myprogram', localedirs=(
os.path.join(os.path.realpath(os.path.dirname(__file__)), 'locale'),
os.path.join(sys.prefix, 'lib', 'locale')
))
Then, in other files that have strings that need translating::
# myprogram/commands.py:
from myprogram import _, N_
def print_usage():
print _(u"""available commands are:
--help Display help
--version Display version of this program
--bake-me-a-cake as fast as you can
""")
def print_invitations(age):
print _('Please come to my party.')
print N_('I will be turning %(age)s year old',
'I will be turning %(age)s years old', age) % {'age': age}
See the documentation of :func:`easy_gettext_setup` and
:func:`get_translation_object` for more details.
.. seealso::
:mod:`gettext`
for details of how the python gettext facilities work
`babel <http://babel.edgewall.org>`_
The babel module for in depth information on gettext, :term:`message
catalogs`, and translating your app. babel provides some nice
features for :term:`i18n` on top of :mod:`gettext`
i( t version_tuple_to_stringi i N( t ENOENT( t _default_localedirt sharet locale( t to_bytest
to_unicode( t byte_string_valid_encodingt DummyTranslationsc B s e Z d Z d d Z d Z d Z e e e Z d Z e
e j d s` d Z
n d Z d Z d Z d
Z d Z d Z d
Z RS( s Safer version of :class:`gettext.NullTranslations`
This Translations class doesn't translate the strings and is intended to
be used as a fallback when there were errors setting up a real
Translations object. It's safer than :class:`gettext.NullTranslations` in
its handling of byte :class:`str` vs :class:`unicode` strings.
Unlike :class:`~gettext.NullTranslations`, this Translation class will
never throw a :exc:`~exceptions.UnicodeError`. The code that you have
around a call to :class:`DummyTranslations` might throw
a :exc:`~exceptions.UnicodeError` but at least that will be in code you
control and can fix. Also, unlike :class:`~gettext.NullTranslations` all
of this Translation object's methods guarantee to return byte :class:`str`
except for :meth:`ugettext` and :meth:`ungettext` which guarantee to
return :class:`unicode` strings.
When byte :class:`str` are returned, the strings will be encoded according
to this algorithm:
1) If a fallback has been added, the fallback will be called first.
You'll need to consult the fallback to see whether it performs any
encoding changes.
2) If a byte :class:`str` was given, the same byte :class:`str` will
be returned.
3) If a :class:`unicode` string was given and :meth:`set_output_charset`
has been called then we encode the string using the
:attr:`output_charset`
4) If a :class:`unicode` string was given and this is :meth:`gettext` or
:meth:`ngettext` and :attr:`_charset` was set output in that charset.
5) If a :class:`unicode` string was given and this is :meth:`gettext`
or :meth:`ngettext` we encode it using 'utf-8'.
6) If a :class:`unicode` string was given and this is :meth:`lgettext`
or :meth:`lngettext` we encode using the value of
:func:`locale.getpreferredencoding`
For :meth:`ugettext` and :meth:`ungettext`, we go through the same set of
steps with the following differences:
* We transform byte :class:`str` into :class:`unicode` strings for
these methods.
* The encoding used to decode the byte :class:`str` is taken from
:attr:`input_charset` if it's set, otherwise we decode using
:term:`UTF-8`.
.. attribute:: input_charset
is an extension to the |stdlib|_ :mod:`gettext` that specifies what
charset a message is encoded in when decoding a message to
:class:`unicode`. This is used for two purposes:
1) If the message string is a byte :class:`str`, this is used to decode
the string to a :class:`unicode` string before looking it up in the
:term:`message catalog`.
2) In :meth:`~kitchen.i18n.DummyTranslations.ugettext` and
:meth:`~kitchen.i18n.DummyTranslations.ungettext` methods, if a byte
:class:`str` is given as the message and is untranslated this is used
as the encoding when decoding to :class:`unicode`. This is different
from :attr:`_charset` which may be set when a :term:`message catalog`
is loaded because :attr:`input_charset` is used to describe an encoding
used in a python source file while :attr:`_charset` describes the
encoding used in the :term:`message catalog` file.
Any characters that aren't able to be transformed from a byte :class:`str`
to :class:`unicode` string or vice versa will be replaced with
a replacement character (ie: ``u'�'`` in unicode based encodings, ``'?'`` in other
:term:`ASCII` compatible encodings).
.. seealso::
:class:`gettext.NullTranslations`
For information about what methods are available and what they do.
.. versionchanged:: kitchen-1.1.0 ; API kitchen.i18n 2.1.0
* Although we had adapted :meth:`gettext`, :meth:`ngettext`,
:meth:`lgettext`, and :meth:`lngettext` to always return byte
:class:`str`, we hadn't forced those byte :class:`str` to always be
in a specified charset. We now make sure that :meth:`gettext` and
:meth:`ngettext` return byte :class:`str` encoded using
:attr:`output_charset` if set, otherwise :attr:`charset` and if
neither of those, :term:`UTF-8`. With :meth:`lgettext` and
:meth:`lngettext` :attr:`output_charset` if set, otherwise
:func:`locale.getpreferredencoding`.
* Make setting :attr:`input_charset` and :attr:`output_charset` also
set those attributes on any fallback translation objects.
c C s; t j j | | t | d s. d | _ n d | _ d S( Nt _output_charsets utf-8( t gettextt NullTranslationst __init__t hasattrt NoneR t _input_charset( t selft fp( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR s c C s= | j r0 y | | j _ Wq0 t k
r, q0 Xn | | _ d S( N( t _fallbackt
input_charsett AttributeErrorR ( R t charset( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyt _set_input_charset s
c C s | j S( N( R ( R ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyt _get_input_charset s c C sl | j r4 y | j j | Wq4 t k
r0 q4 Xn y t j j | | Wn t k
rg | | _ n Xd S( s Set the output charset
This serves two purposes. The normal
:meth:`gettext.NullTranslations.set_output_charset` does not set the
output on fallback objects. On python-2.3,
:class:`gettext.NullTranslations` objects don't contain this method.
N( R t set_output_charsetR R
R R ( R R ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR s
t output_charsetc C s | j S( s= Compatibility for python2.3 which doesn't have output_charset( R ( R ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR s c C s t } d } y t | | } Wn t k
r2 n X| r= | Sy t | d | j d d } Wn t k
rp d SXt | d | S( s Return a byte string that's valid in a specific charset.
.. warning:: This method may mangle the message if the inpput encoding
is not known or the message isn't represntable in the chosen
output encoding.
t encodingt nonstringt strictt N( t FalseR R t TypeErrorR R R ( R t messaget output_encodingt validt msg( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyt _reencode_if_necessary s
c C sg | j r< y | j j | } Wq< t t f k
r8 q< Xn | j pT | j pT | j } | j | | S( N( R R
R t UnicodeErrorR t _charsetR R$ ( R R R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR
s c C s | d k r | } n | } | j r] y | j j | | | } Wq] t t f k
rY q] Xn | j pu | j pu | j } | j | | S( Ni ( R t ngettextR R% R R& R R$ ( R t msgid1t msgid2t nR R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR' ' s c C sa | j r< y | j j | } Wq< t t f k
r8 q< Xn | j pN t j } | j | | S( N( R t lgettextR R% R R t getpreferredencodingR$ ( R R R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR+ < s c C s | d k r | } n | } | j r] y | j j | | | } Wq] t t f k
rY q] Xn | j po t j } | j | | S( Ni ( R t lngettextR R% R R R, R$ ( R R( R) R* R R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR- L s c C sw t | t s d S| j rd t | d | j } y | j j | } Wqd t t f k
r` qd Xn t | d | j S( Nu R ( t
isinstancet
basestringR R R t ugettextR R% ( R R R# ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR0 b s c C s | d k r | } n | } | j r t | d | j } t | d | j } y | j j | | | } Wq t t f k
r q Xn t | d | j d d S( Ni R R t empty( R R R t ungettextR R% ( R R( R) R* R ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR2 p s N( t __name__t
__module__t __doc__R R R R t propertyR R R
R
R R R$ R' R+ R- R0 R2 ( ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR u s U t NewGNUTranslationsc B sM e Z d Z d Z d Z d Z d Z d Z d Z d Z RS( sh Safer version of :class:`gettext.GNUTranslations`
:class:`gettext.GNUTranslations` suffers from two problems that this
class fixes.
1) :class:`gettext.GNUTranslations` can throw a
:exc:`~exceptions.UnicodeError` in
:meth:`gettext.GNUTranslations.ugettext` if the message being
translated has non-:term:`ASCII` characters and there is no translation
for it.
2) :class:`gettext.GNUTranslations` can return byte :class:`str` from
:meth:`gettext.GNUTranslations.ugettext` and :class:`unicode`
strings from the other :meth:`~gettext.GNUTranslations.gettext`
methods if the message being translated is the wrong type
When byte :class:`str` are returned, the strings will be encoded
according to this algorithm:
1) If a fallback has been added, the fallback will be called first.
You'll need to consult the fallback to see whether it performs any
encoding changes.
2) If a byte :class:`str` was given, the same byte :class:`str` will
be returned.
3) If a :class:`unicode` string was given and
:meth:`set_output_charset` has been called then we encode the
string using the :attr:`output_charset`
4) If a :class:`unicode` string was given and this is :meth:`gettext`
or :meth:`ngettext` and a charset was detected when parsing the
:term:`message catalog`, output in that charset.
5) If a :class:`unicode` string was given and this is :meth:`gettext`
or :meth:`ngettext` we encode it using :term:`UTF-8`.
6) If a :class:`unicode` string was given and this is :meth:`lgettext`
or :meth:`lngettext` we encode using the value of
:func:`locale.getpreferredencoding`
For :meth:`ugettext` and :meth:`ungettext`, we go through the same set of
steps with the following differences:
* We transform byte :class:`str` into :class:`unicode` strings for these
methods.
* The encoding used to decode the byte :class:`str` is taken from
:attr:`input_charset` if it's set, otherwise we decode using
:term:`UTF-8`
.. attribute:: input_charset
an extension to the |stdlib|_ :mod:`gettext` that specifies what
charset a message is encoded in when decoding a message to
:class:`unicode`. This is used for two purposes:
1) If the message string is a byte :class:`str`, this is used to decode
the string to a :class:`unicode` string before looking it up in the
:term:`message catalog`.
2) In :meth:`~kitchen.i18n.DummyTranslations.ugettext` and
:meth:`~kitchen.i18n.DummyTranslations.ungettext` methods, if a byte
:class:`str` is given as the message and is untranslated his is used as
the encoding when decoding to :class:`unicode`. This is different from
the :attr:`_charset` parameter that may be set when a :term:`message
catalog` is loaded because :attr:`input_charset` is used to describe an
encoding used in a python source file while :attr:`_charset` describes
the encoding used in the :term:`message catalog` file.
Any characters that aren't able to be transformed from a byte
:class:`str` to :class:`unicode` string or vice versa will be replaced
with a replacement character (ie: ``u'�'`` in unicode based encodings,
``'?'`` in other :term:`ASCII` compatible encodings).
.. seealso::
:class:`gettext.GNUTranslations.gettext`
For information about what methods this class has and what they do
.. versionchanged:: kitchen-1.1.0 ; API kitchen.i18n 2.1.0
Although we had adapted :meth:`gettext`, :meth:`ngettext`,
:meth:`lgettext`, and :meth:`lngettext` to always return
byte :class:`str`, we hadn't forced those byte :class:`str` to always
be in a specified charset. We now make sure that :meth:`gettext` and
:meth:`ngettext` return byte :class:`str` encoded using
:attr:`output_charset` if set, otherwise :attr:`charset` and if
neither of those, :term:`UTF-8`. With :meth:`lgettext` and
:meth:`lngettext` :attr:`output_charset` if set, otherwise
:func:`locale.getpreferredencoding`.
c C s t j j | | d S( N( R
t GNUTranslationst _parse( R R ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR9 s c C s t | t s d S| } t | d | j } y | j | } WnM t k
r | j r y | j j | } Wq t t f k
r q Xq n X| j
p | j p | j } | j | | S( NR R (
R. R/ R R t _catalogt KeyErrorR R
R R% R R& R$ ( R R t tmsgt u_messageR! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR
s
c C s | d k r | } n | } t | t s. d St | d | j } y | j | | j | f } WnS t k
r | j r y | j j | | | } Wq t t
f k
r q Xq n X| j p | j p | j } | j
| | S( Ni R R ( R. R/ R R R: t pluralR; R R' R R% R R& R$ ( R R( R) R* R< t u_msgid1R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR' s"
c C s t | t s d S| } t | d | j } y | j | } WnM t k
r | j r y | j j | } Wq t t f k
r q Xq n X| j
p t j } | j
| | S( NR R ( R. R/ R R R: R; R R+ R R% R R R, R$ ( R R R< R= R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR+ s
c C s | d k r | } n | } t | t s. d St | d | j } y | j | | j | f } WnS t k
r | j r y | j j | | | } Wq t t
f k
r q Xq n X| j p t j
} | j | | S( Ni R R ( R. R/ R R R: R> R; R R' R R% R R R, R$ ( R R( R) R* R< R? R! ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR- ! s"
c C s t | t s d St | d | j } y | j | } WnM t k
r | j r y | j j | } Wq t t f k
r q Xq n Xt | d | j S( Nu R (
R. R/ R R R: R; R R0 R R% ( R R ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR0 < s
c C s | d k r | } n | } t | t s. d St | d | j } y | j | | j | f } WnS t k
r | j r y | j j | | | } Wq t t
f k
r q Xq n Xt | d | j d d S( Ni u R R R1 ( R. R/ R R R: R> R; R R2 R R% ( R R( R) R* R< R? ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR2 M s
(
R3 R4 R5 R9 R
R' R+ R- R0 R2 ( ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyR7 s S c
C s> | s t } n g } x? t j | t f D]( } | j t j | | | d d q+ W| s | rj t St t d | n d } x | D] } t j j
| }
t j |
} | s t |
d } z t j |
| | } Wd | j Xn t j | } | r| j | n | s)| } q | j | q W| S( s Get a translation object bound to the :term:`message catalogs`
:arg domain: Name of the message domain. This should be a unique name
that can be used to lookup the :term:`message catalog` for this app or
library.
:kwarg localedirs: Iterator of directories to look for
:term:`message catalogs` under. The directories are searched in order
for :term:`message catalogs`. For each of the directories searched,
we check for message catalogs in any language specified
in:attr:`languages`. The :term:`message catalogs` are used to create
the Translation object that we return. The Translation object will
attempt to lookup the msgid in the first catalog that we found. If
it's not in there, it will go through each subsequent catalog looking
for a match. For this reason, the order in which you specify the
:attr:`localedirs` may be important. If no :term:`message catalogs`
are found, either return a :class:`DummyTranslations` object or raise
an :exc:`IOError` depending on the value of :attr:`fallback`.
Rhe default localedir from :mod:`gettext` which is
:file:`os.path.join(sys.prefix, 'share', 'locale')` on Unix is
implicitly appended to the :attr:`localedirs`, making it the last
directory searched.
:kwarg languages: Iterator of language codes to check for
:term:`message catalogs`. If unspecified, the user's locale settings
will be used.
.. seealso:: :func:`gettext.find` for information on what environment
variables are used.
:kwarg class_: The class to use to extract translations from the
:term:`message catalogs`. Defaults to :class:`NewGNUTranslations`.
:kwarg fallback: If set to data:`False`, raise an :exc:`IOError` if no
:term:`message catalogs` are found. If :data:`True`, the default,
return a :class:`DummyTranslations` object.
:kwarg codeset: Set the character encoding to use when returning byte
:class:`str` objects. This is equivalent to calling
:meth:`~gettext.GNUTranslations.output_charset` on the Translations
object that is returned from this function.
:return: Translation object to get :mod:`gettext` methods from
If you need more flexibility than :func:`easy_gettext_setup`, use this
function. It sets up a :mod:`gettext` Translation object and returns it
to you. Then you can access any of the methods of the object that you
need directly. For instance, if you specifically need to access
:func:`~gettext.GNUTranslations.lgettext`::
translations = get_translation_object('foo')
translations.lgettext('My Message')
This function is similar to the |stdlib|_ :func:`gettext.translation` but
makes it better in two ways
1. It returns :class:`NewGNUTranslations` or :class:`DummyTranslations`
objects by default. These are superior to the
:class:`gettext.GNUTranslations` and :class:`gettext.NullTranslations`
objects because they are consistent in the string type they return and
they fix several issues that can causethe |stdlib|_ objects to throw
:exc:`UnicodeError`.
2. This function takes multiple directories to search for
:term:`message catalogs`.
The latter is important when setting up :mod:`gettext` in a portable
manner. There is not a common directory for translations across operating
systems so one needs to look in multiple directories for the translations.
:func:`get_translation_object` is able to handle that if you give it
a list of directories to search for catalogs::
translations = get_translation_object('foo', localedirs=(
os.path.join(os.path.realpath(os.path.dirname(__file__)), 'locale'),
os.path.join(sys.prefix, 'lib', 'locale')))
This will search for several different directories:
1. A directory named :file:`locale` in the same directory as the module
that called :func:`get_translation_object`,
2. In :file:`/usr/lib/locale`
3. In :file:`/usr/share/locale` (the fallback directory)
This allows :mod:`gettext` to work on Windows and in development (where the
:term:`message catalogs` are typically in the toplevel module directory)
and also when installed under Linux (where the :term:`message catalogs`
are installed in :file:`/usr/share/locale`). You (or the system packager)
just need to install the :term:`message catalogs` in
:file:`/usr/share/locale` and remove the :file:`locale` directory from the
module to make this work. ie::
In development:
~/foo # Toplevel module directory
~/foo/__init__.py
~/foo/locale # With message catalogs below here:
~/foo/locale/es/LC_MESSAGES/foo.mo
Installed on Linux:
/usr/lib/python2.7/site-packages/foo
/usr/lib/python2.7/site-packages/foo/__init__.py
/usr/share/locale/ # With message catalogs below here:
/usr/share/locale/es/LC_MESSAGES/foo.mo
.. note::
This function will setup Translation objects that attempt to lookup
msgids in all of the found :term:`message catalogs`. This means if
you have several versions of the :term:`message catalogs` installed
in different directories that the function searches, you need to make
sure that :attr:`localedirs` specifies the directories so that newer
:term:`message catalogs` are searched first. It also means that if
a newer catalog does not contain a translation for a msgid but an
older one that's in :attr:`localedirs` does, the translation from that
older catalog will be returned.
.. versionchanged:: kitchen-1.1.0 ; API kitchen.i18n 2.1.0
Add more parameters to :func:`~kitchen.i18n.get_translation_object` so
it can more easily be used as a replacement for
:func:`gettext.translation`. Also change the way we use localedirs.
We cycle through them until we find a suitable locale file rather
than simply cycling through until we find a directory that exists.
The new code is based heavily on the |stdlib|_
:func:`gettext.translation` function.
t alli s$ No translation file found for domaint rbN( R7 t itertoolst chaint _DEFAULT_LOCALEDIRt extendR
t findR t IOErrorR R t ost patht abspatht
_translationst gett opent
setdefaultt closet copyR t add_fallback(
t domaint
localedirst languagest class_t fallbackt codesett mofilest localedirt stacked_translationst mofilet full_patht translationt mofile_fh( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyt get_translation_objectf s4 x &
c C s8 t | d | } | r( | j | j f S| j | j f S( s Setup translation functions for an application
:arg domain: Name of the message domain. This should be a unique name
that can be used to lookup the :term:`message catalog` for this app.
:kwarg localedirs: Iterator of directories to look for :term:`message
catalogs` under. The first directory to exist is used regardless of
whether messages for this domain are present. If none of the
directories exist, fallback on ``sys.prefix`` + :file:`/share/locale`
Default: No directories to search so we just use the fallback.
:kwarg use_unicode: If :data:`True` return the :mod:`gettext` functions
for :class:`unicode` strings else return the functions for byte
:class:`str` for the translations. Default is :data:`True`.
:return: tuple of the :mod:`gettext` function and :mod:`gettext` function
for plurals
Setting up :mod:`gettext` can be a little tricky because of lack of
documentation. This function will setup :mod:`gettext` using the
`Class-based API
<http://docs.python.org/library/gettext.html#class-based-api>`_ for you.
For the simple case, you can use the default arguments and call it like
this::
_, N_ = easy_gettext_setup()
This will get you two functions, :func:`_` and :func:`N_` that you can use
to mark strings in your code for translation. :func:`_` is used to mark
strings that don't need to worry about plural forms no matter what the
value of the variable is. :func:`N_` is used to mark strings that do need
to have a different form if a variable in the string is plural.
.. seealso::
:doc:`api-i18n`
This module's documentation has examples of using :func:`_` and :func:`N_`
:func:`get_translation_object`
for information on how to use :attr:`localedirs` to get the
proper :term:`message catalogs` both when in development and when
installed to FHS compliant directories on Linux.
.. note::
The gettext functions returned from this function should be superior
to the ones returned from :mod:`gettext`. The traits that make them
better are described in the :class:`DummyTranslations` and
:class:`NewGNUTranslations` documentation.
.. versionchanged:: kitchen-0.2.4 ; API kitchen.i18n 2.0.0
Changed :func:`~kitchen.i18n.easy_gettext_setup` to return the lgettext
functions instead of gettext functions when use_unicode=False.
RS ( R_ R0 R2 R+ R- ( RR RS t use_unicodet translations( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyt easy_gettext_setup s 3Rb R_ ($ R5 t kitchen.versioningR t __version_info__t __version__RP t errnoR R
RB R RH t sysR RD t ImportErrorRI t joint prefixt kitchen.text.convertersR R t kitchen.text.miscR RK t objectR R R8 R7 t tupleR t TrueR_ Rb t __all__( ( ( s9 /usr/lib/python2.7/site-packages/kitchen/i18n/__init__.pyt <module>N s2
8