Fixed #5494, #10765, #14924 -- Modified the order in which translations are read when composing the final translation to offer at runtime.
This is slightly backward-incompatible (could result in changed final translations for literals appearing multiple times in different .po files but with different translations). Translations are now read in the following order (from lower to higher priority): For the 'django' gettext domain: * Django translations * INSTALLED_APPS apps translations (with the ones listed first having higher priority) * settings/project path translations (deprecated, see below) * LOCALE_PATHS translations (with the ones listed first having higher priority) For the 'djangojs' gettext domain: * Python modules whose names are passed to the javascript_catalog view * LOCALE_PATHS translations (with the ones listed first having higher priority, previously they weren't included) Also, automatic loading of translations from the 'locale' subdir of the settings/project path is now deprecated. Thanks to vanschelven, vbmendes and an anonymous user for reporting issues, to vanschelven, Claude Paroz and an anonymous contributor for their initial work on fixes and to Jannis Leidel and Claude for review and discussion. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15441 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
5718a678e5
commit
f6e38f3800
|
@ -1,8 +1,11 @@
|
||||||
"""
|
"""
|
||||||
Internationalization support.
|
Internationalization support.
|
||||||
"""
|
"""
|
||||||
|
from os import path
|
||||||
|
|
||||||
from django.utils.encoding import force_unicode
|
from django.utils.encoding import force_unicode
|
||||||
from django.utils.functional import lazy, curry
|
from django.utils.functional import lazy
|
||||||
|
from django.utils.importlib import import_module
|
||||||
|
|
||||||
|
|
||||||
__all__ = ['gettext', 'gettext_noop', 'gettext_lazy', 'ngettext',
|
__all__ = ['gettext', 'gettext_noop', 'gettext_lazy', 'ngettext',
|
||||||
|
@ -33,10 +36,22 @@ class Trans(object):
|
||||||
performance effect, as access to the function goes the normal path,
|
performance effect, as access to the function goes the normal path,
|
||||||
instead of using __getattr__.
|
instead of using __getattr__.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __getattr__(self, real_name):
|
def __getattr__(self, real_name):
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
if settings.USE_I18N:
|
if settings.USE_I18N:
|
||||||
from django.utils.translation import trans_real as trans
|
from django.utils.translation import trans_real as trans
|
||||||
|
|
||||||
|
if settings.SETTINGS_MODULE is not None:
|
||||||
|
import warnings
|
||||||
|
parts = settings.SETTINGS_MODULE.split('.')
|
||||||
|
project = import_module(parts[0])
|
||||||
|
if path.isdir(path.join(path.dirname(project.__file__), 'locale')):
|
||||||
|
warnings.warn(
|
||||||
|
"Translations in the project directory aren't supported anymore. Use the LOCALE_PATHS setting instead.",
|
||||||
|
PendingDeprecationWarning
|
||||||
|
)
|
||||||
|
|
||||||
else:
|
else:
|
||||||
from django.utils.translation import trans_null as trans
|
from django.utils.translation import trans_null as trans
|
||||||
setattr(self, real_name, getattr(trans, real_name))
|
setattr(self, real_name, getattr(trans, real_name))
|
||||||
|
|
|
@ -125,12 +125,12 @@ def translation(language):
|
||||||
|
|
||||||
global _translations
|
global _translations
|
||||||
|
|
||||||
loc = to_locale(lang)
|
|
||||||
|
|
||||||
res = _translations.get(lang, None)
|
res = _translations.get(lang, None)
|
||||||
if res is not None:
|
if res is not None:
|
||||||
return res
|
return res
|
||||||
|
|
||||||
|
loc = to_locale(lang)
|
||||||
|
|
||||||
def _translation(path):
|
def _translation(path):
|
||||||
try:
|
try:
|
||||||
t = gettext_module.translation('django', path, [loc], DjangoTranslation)
|
t = gettext_module.translation('django', path, [loc], DjangoTranslation)
|
||||||
|
@ -159,11 +159,7 @@ def translation(language):
|
||||||
res.merge(t)
|
res.merge(t)
|
||||||
return res
|
return res
|
||||||
|
|
||||||
for localepath in settings.LOCALE_PATHS:
|
for appname in reversed(settings.INSTALLED_APPS):
|
||||||
if os.path.isdir(localepath):
|
|
||||||
res = _merge(localepath)
|
|
||||||
|
|
||||||
for appname in settings.INSTALLED_APPS:
|
|
||||||
app = import_module(appname)
|
app = import_module(appname)
|
||||||
apppath = os.path.join(os.path.dirname(app.__file__), 'locale')
|
apppath = os.path.join(os.path.dirname(app.__file__), 'locale')
|
||||||
|
|
||||||
|
@ -173,6 +169,10 @@ def translation(language):
|
||||||
if projectpath and os.path.isdir(projectpath):
|
if projectpath and os.path.isdir(projectpath):
|
||||||
res = _merge(projectpath)
|
res = _merge(projectpath)
|
||||||
|
|
||||||
|
for localepath in reversed(settings.LOCALE_PATHS):
|
||||||
|
if os.path.isdir(localepath):
|
||||||
|
res = _merge(localepath)
|
||||||
|
|
||||||
if res is None:
|
if res is None:
|
||||||
if fallback is not None:
|
if fallback is not None:
|
||||||
res = fallback
|
res = fallback
|
||||||
|
|
|
@ -193,11 +193,15 @@ def javascript_catalog(request, domain='djangojs', packages=None):
|
||||||
paths = []
|
paths = []
|
||||||
en_selected = locale.startswith('en')
|
en_selected = locale.startswith('en')
|
||||||
en_catalog_missing = True
|
en_catalog_missing = True
|
||||||
# first load all english languages files for defaults
|
# paths of requested packages
|
||||||
for package in packages:
|
for package in packages:
|
||||||
p = importlib.import_module(package)
|
p = importlib.import_module(package)
|
||||||
path = os.path.join(os.path.dirname(p.__file__), 'locale')
|
path = os.path.join(os.path.dirname(p.__file__), 'locale')
|
||||||
paths.append(path)
|
paths.append(path)
|
||||||
|
# add the filesystem paths listed in the LOCALE_PATHS setting
|
||||||
|
paths.extend(list(reversed(settings.LOCALE_PATHS)))
|
||||||
|
# first load all english languages files for defaults
|
||||||
|
for path in paths:
|
||||||
try:
|
try:
|
||||||
catalog = gettext_module.translation(domain, path, ['en'])
|
catalog = gettext_module.translation(domain, path, ['en'])
|
||||||
t.update(catalog._catalog)
|
t.update(catalog._catalog)
|
||||||
|
@ -275,4 +279,3 @@ def javascript_catalog(request, domain='djangojs', packages=None):
|
||||||
src.append(LibFormatFoot)
|
src.append(LibFormatFoot)
|
||||||
src = ''.join(src)
|
src = ''.join(src)
|
||||||
return http.HttpResponse(src, 'text/javascript')
|
return http.HttpResponse(src, 'text/javascript')
|
||||||
|
|
||||||
|
|
|
@ -4,15 +4,36 @@
|
||||||
Using internationalization in your own projects
|
Using internationalization in your own projects
|
||||||
===============================================
|
===============================================
|
||||||
|
|
||||||
At runtime, Django looks for translations by following this algorithm:
|
At runtime, Django builds an in-memory unified catalog of literals-translations.
|
||||||
|
To achieve this it looks for translations by following this algorithm regarding
|
||||||
|
the order in which it examines the different file paths to load the compiled
|
||||||
|
:term:`message files <message file>` (``.mo``) and the precedence of multiple
|
||||||
|
translations for the same literal:
|
||||||
|
|
||||||
* First, it looks for a ``locale`` directory in the directory containing
|
1. The directories listed in :setting:`LOCALE_PATHS` have the highest
|
||||||
your settings file.
|
precedence, with the ones appearing first having higher precedence than
|
||||||
* Second, it looks for a ``locale`` directory in the project directory.
|
the ones appearing later.
|
||||||
* Third, it looks for a ``locale`` directory in each of the installed apps.
|
2. Then, it looks for and uses if it exists a ``locale`` directory in each
|
||||||
It does this in the reverse order of INSTALLED_APPS
|
of the installed apps listed in :setting:`INSTALLED_APPS`. The ones
|
||||||
* Finally, it checks the Django-provided base translation in
|
appearing first have higher precedence than the ones appearing later.
|
||||||
``django/conf/locale``.
|
3. Then, it looks for a ``locale`` directory in the project directory, or
|
||||||
|
more accurately, in the directory containing your settings file.
|
||||||
|
4. Finally, the Django-provided base translation in ``django/conf/locale``
|
||||||
|
is used as a fallback.
|
||||||
|
|
||||||
|
.. deprecated:: 1.3
|
||||||
|
Lookup in the ``locale`` subdirectory of the directory containing your
|
||||||
|
settings file (item 3 above) is deprecated since the 1.3 release and will be
|
||||||
|
removed in Django 1.5. You can use the :setting:`LOCALE_PATHS` setting
|
||||||
|
instead, by listing the absolute filesystem path of such ``locale``
|
||||||
|
directory in the setting value.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
The translations for literals included in JavaScript assets are looked up
|
||||||
|
following a similar but not identical algorithm. See the
|
||||||
|
:ref:`javascript_catalog view documentation <javascript_catalog-view>` for
|
||||||
|
more details.
|
||||||
|
|
||||||
In all cases the name of the directory containing the translation is expected to
|
In all cases the name of the directory containing the translation is expected to
|
||||||
be named using :term:`locale name` notation. E.g. ``de``, ``pt_BR``, ``es_AR``,
|
be named using :term:`locale name` notation. E.g. ``de``, ``pt_BR``, ``es_AR``,
|
||||||
|
@ -20,8 +41,8 @@ etc.
|
||||||
|
|
||||||
This way, you can write applications that include their own translations, and
|
This way, you can write applications that include their own translations, and
|
||||||
you can override base translations in your project path. Or, you can just build
|
you can override base translations in your project path. Or, you can just build
|
||||||
a big project out of several apps and put all translations into one big project
|
a big project out of several apps and put all translations into one big common
|
||||||
message file. The choice is yours.
|
message file specific to the project you are composing. The choice is yours.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
@ -34,10 +55,11 @@ message file. The choice is yours.
|
||||||
|
|
||||||
All message file repositories are structured the same way. They are:
|
All message file repositories are structured the same way. They are:
|
||||||
|
|
||||||
* ``$APPPATH/locale/<language>/LC_MESSAGES/django.(po|mo)``
|
|
||||||
* ``$PROJECTPATH/locale/<language>/LC_MESSAGES/django.(po|mo)``
|
|
||||||
* All paths listed in ``LOCALE_PATHS`` in your settings file are
|
* All paths listed in ``LOCALE_PATHS`` in your settings file are
|
||||||
searched in that order for ``<language>/LC_MESSAGES/django.(po|mo)``
|
searched for ``<language>/LC_MESSAGES/django.(po|mo)``
|
||||||
|
* ``$PROJECTPATH/locale/<language>/LC_MESSAGES/django.(po|mo)`` --
|
||||||
|
deprecated, see above.
|
||||||
|
* ``$APPPATH/locale/<language>/LC_MESSAGES/django.(po|mo)``
|
||||||
* ``$PYTHONPATH/django/conf/locale/<language>/LC_MESSAGES/django.(po|mo)``
|
* ``$PYTHONPATH/django/conf/locale/<language>/LC_MESSAGES/django.(po|mo)``
|
||||||
|
|
||||||
To create message files, you use the :djadmin:`django-admin.py makemessages <makemessages>`
|
To create message files, you use the :djadmin:`django-admin.py makemessages <makemessages>`
|
||||||
|
@ -50,22 +72,18 @@ You can also run ``django-admin.py compilemessages --settings=path.to.settings``
|
||||||
to make the compiler process all the directories in your :setting:`LOCALE_PATHS`
|
to make the compiler process all the directories in your :setting:`LOCALE_PATHS`
|
||||||
setting.
|
setting.
|
||||||
|
|
||||||
Application message files are a bit complicated to discover -- they need the
|
|
||||||
:class:`~django.middleware.locale.LocaleMiddleware`. If you don't use the
|
|
||||||
middleware, only the Django message files and project message files will be
|
|
||||||
installed and available at runtime.
|
|
||||||
|
|
||||||
Finally, you should give some thought to the structure of your translation
|
Finally, you should give some thought to the structure of your translation
|
||||||
files. If your applications need to be delivered to other users and will
|
files. If your applications need to be delivered to other users and will
|
||||||
be used in other projects, you might want to use app-specific translations.
|
be used in other projects, you might want to use app-specific translations.
|
||||||
But using app-specific translations and project translations could produce
|
But using app-specific translations and project-specific translations could
|
||||||
weird problems with ``makemessages``: It will traverse all directories below
|
produce weird problems with ``makemessages``: It will traverse all directories
|
||||||
the current path and so might put message IDs into the project message file
|
below the current path and so might put message IDs into a unified, common
|
||||||
that are already in application message files.
|
message file for the current project that are already in application message
|
||||||
|
files.
|
||||||
|
|
||||||
The easiest way out is to store applications that are not part of the project
|
The easiest way out is to store applications that are not part of the project
|
||||||
(and so carry their own translations) outside the project tree. That way,
|
(and so carry their own translations) outside the project tree. That way,
|
||||||
``django-admin.py makemessages`` on the project level will only translate
|
``django-admin.py makemessages``, when ran on a project level will only extract
|
||||||
strings that are connected to your explicit project and not strings that are
|
strings that are connected to your explicit project and not strings that are
|
||||||
distributed independently.
|
distributed independently.
|
||||||
|
|
||||||
|
|
|
@ -1149,6 +1149,17 @@ Default: ``()`` (Empty tuple)
|
||||||
A tuple of directories where Django looks for translation files.
|
A tuple of directories where Django looks for translation files.
|
||||||
See :ref:`using-translations-in-your-own-projects`.
|
See :ref:`using-translations-in-your-own-projects`.
|
||||||
|
|
||||||
|
Example::
|
||||||
|
|
||||||
|
LOCALE_PATHS = (
|
||||||
|
'/home/www/project/common_files/locale',
|
||||||
|
'/var/local/translations/locale'
|
||||||
|
)
|
||||||
|
|
||||||
|
Note that in the paths you add to the value of this setting, if you have the
|
||||||
|
typical ``/path/to/locale/xx/LC_MESSAGES`` hierarchy, you should use the path to
|
||||||
|
the ``locale`` directory (i.e. ``'/path/to/locale'``).
|
||||||
|
|
||||||
.. setting:: LOGGING
|
.. setting:: LOGGING
|
||||||
|
|
||||||
LOGGING
|
LOGGING
|
||||||
|
|
|
@ -454,6 +454,52 @@ should either insert it using :ref:`test fixtures
|
||||||
<topics-testing-fixtures>`, or using the ``setUp()`` method of your
|
<topics-testing-fixtures>`, or using the ``setUp()`` method of your
|
||||||
test case.
|
test case.
|
||||||
|
|
||||||
|
Changed priority of translation loading
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Work has been done to homogeneize, simplify, rationalize and properly document
|
||||||
|
the algorithm used by Django at runtime to build translations from the
|
||||||
|
differents translations found on disk, namely:
|
||||||
|
|
||||||
|
For translatable literals found in Python code and templates (``'django'``
|
||||||
|
gettext domain):
|
||||||
|
|
||||||
|
* Priorities of translations included with applications listed in the
|
||||||
|
:setting:`INSTALLED_APPS` setting were changed. To provide a behavior
|
||||||
|
consistent with other parts of Django that also use such setting (templates,
|
||||||
|
etc.) now, when building the translation that will be made available, the
|
||||||
|
apps listed first have higher precedence than the ones listed later.
|
||||||
|
|
||||||
|
* Now it is possible to override the translations shipped with applications by
|
||||||
|
using the :setting:`LOCALE_PATHS` setting whose translations have now higher
|
||||||
|
precedence than the translations of ``INSTALLED_APPS`` applications.
|
||||||
|
The relative priority among the values listed in this setting has also been
|
||||||
|
modified so the paths listed first have higher precedence than the
|
||||||
|
ones listed later.
|
||||||
|
|
||||||
|
* The ``locale`` subdirectory of the directory containing the settings, that
|
||||||
|
usually coincides with and is know as the *project directory* is being
|
||||||
|
deprecated in this release as a source of translations. (the precedence of
|
||||||
|
these translations is intermediate between applications and ``LOCALE_PATHS``
|
||||||
|
translations). See the `corresponding deprecated features section`_
|
||||||
|
of this document.
|
||||||
|
|
||||||
|
For translatable literals found in Javascript code (``'djangojs'`` gettext
|
||||||
|
domain):
|
||||||
|
|
||||||
|
* Similarly to the ``'django'`` domain translations: Overriding of
|
||||||
|
translations shipped with applications by using the :setting:`LOCALE_PATHS`
|
||||||
|
setting is now possible for this domain too. These translations have higher
|
||||||
|
precedence than the translations of Python packages passed to the
|
||||||
|
:ref:`javascript_catalog view <javascript_catalog-view>`. Paths listed first
|
||||||
|
have higher precedence than the ones listed later.
|
||||||
|
|
||||||
|
* Translations under the ``locale`` sbdirectory of the *project directory* have
|
||||||
|
never been taken in account for JavaScript translations and remain in the
|
||||||
|
same situation considering the deprecation of such location.
|
||||||
|
|
||||||
|
.. _corresponding deprecated features section: loading_of_translations_from_the_project_directory_
|
||||||
|
|
||||||
.. _deprecated-features-1.3:
|
.. _deprecated-features-1.3:
|
||||||
|
|
||||||
Features deprecated in 1.3
|
Features deprecated in 1.3
|
||||||
|
@ -631,3 +677,38 @@ Previously, ``django.http`` exposed an undocumented ``CompatCookie`` class,
|
||||||
which was a bug-fix wrapper around the standard library ``SimpleCookie``. As the
|
which was a bug-fix wrapper around the standard library ``SimpleCookie``. As the
|
||||||
fixes are moving upstream, this is now deprecated - you should use ``from
|
fixes are moving upstream, this is now deprecated - you should use ``from
|
||||||
django.http import SimpleCookie`` instead.
|
django.http import SimpleCookie`` instead.
|
||||||
|
|
||||||
|
.. _loading_of_translations_from_the_project_directory:
|
||||||
|
|
||||||
|
Loading of translations from the project directory
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
This release of Django starts the deprecation process for inclusion of
|
||||||
|
translations located under the *project path* in the translation building
|
||||||
|
process performed at runtime. The :setting:`LOCALE_PATHS` setting can be used
|
||||||
|
for the same task by including in it the filesystem path to the ``locale``
|
||||||
|
directory containing project-level translations.
|
||||||
|
|
||||||
|
Rationale for this decision:
|
||||||
|
|
||||||
|
* The *project path* has always been a loosely defined concept (actually, the
|
||||||
|
directory used for locating project-level translations is the directory
|
||||||
|
containing the settings module) and there has been a shift in other parts
|
||||||
|
of the framework to stop using it as a reference for location of assets at
|
||||||
|
runtime.
|
||||||
|
|
||||||
|
* Detection of the ``locale`` subdirectory tends to fail when the deployment
|
||||||
|
scenario is more complex than the basic one. e.g. it fails when the settings
|
||||||
|
module is a directory (ticket #10765).
|
||||||
|
|
||||||
|
* Potential for strange development- and deployment-time problems like the
|
||||||
|
fact that the ``project_dir/locale/`` subdir can generate spurious error
|
||||||
|
messages when the project directory is included in the Python path (default
|
||||||
|
behavior of ``manage.py runserver``) and then it clashes with the equally
|
||||||
|
named standard library module, this is a typical warming message::
|
||||||
|
|
||||||
|
/usr/lib/python2.6/gettext.py:49: ImportWarning: Not importing directory '/path/to/project/dir/locale': missing __init__.py.
|
||||||
|
import locale, copy, os, re, struct, sys
|
||||||
|
|
||||||
|
* This location wasn't included in the translation building process for
|
||||||
|
JavaScript literals.
|
||||||
|
|
|
@ -171,16 +171,36 @@ in ``request.LANGUAGE_CODE``.
|
||||||
How Django discovers translations
|
How Django discovers translations
|
||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
As described in :ref:`using-translations-in-your-own-projects`,
|
As described in :ref:`using-translations-in-your-own-projects`, Django looks for
|
||||||
at runtime, Django looks for translations by following this algorithm:
|
translations by following this algorithm regarding the order in which it
|
||||||
|
examines the different file paths to load the compiled :term:`message files
|
||||||
|
<message file>` (``.mo``) and the precedence of multiple translations for the
|
||||||
|
same literal:
|
||||||
|
|
||||||
* First, it looks for a ``locale`` directory in the directory containing
|
1. The directories listed in :setting:`LOCALE_PATHS` have the highest
|
||||||
your settings file.
|
precedence, with the ones appearing first having higher precedence than
|
||||||
* Second, it looks for a ``locale`` directory in the project directory.
|
the ones appearing later.
|
||||||
* Third, it looks for a ``locale`` directory in each of the installed apps.
|
2. Then, it looks for and uses if it exists a ``locale`` directory in each
|
||||||
It does this in the reverse order of INSTALLED_APPS
|
of the installed apps listed in :setting:`INSTALLED_APPS`. The ones
|
||||||
* Finally, it checks the Django-provided base translation in
|
appearing first have higher precedence than the ones appearing later.
|
||||||
``django/conf/locale``.
|
3. Then, it looks for a ``locale`` directory in the project directory, or
|
||||||
|
more accurately, in the directory containing your settings file.
|
||||||
|
4. Finally, the Django-provided base translation in ``django/conf/locale``
|
||||||
|
is used as a fallback.
|
||||||
|
|
||||||
|
.. deprecated:: 1.3
|
||||||
|
Lookup in the ``locale`` subdirectory of the directory containing your
|
||||||
|
settings file (item 3 above) is deprecated since the 1.3 release and will be
|
||||||
|
removed in Django 1.5. You can use the :setting:`LOCALE_PATHS` setting
|
||||||
|
instead, by listing the absolute filesystem path of such ``locale``
|
||||||
|
directory in the setting value.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
The translations for literals included in JavaScript assets are looked up
|
||||||
|
following a similar but not identical algorithm. See the
|
||||||
|
:ref:`javascript_catalog view documentation <javascript_catalog-view>` for
|
||||||
|
more details.
|
||||||
|
|
||||||
In all cases the name of the directory containing the translation is expected to
|
In all cases the name of the directory containing the translation is expected to
|
||||||
be named using :term:`locale name` notation. E.g. ``de``, ``pt_BR``, ``es_AR``,
|
be named using :term:`locale name` notation. E.g. ``de``, ``pt_BR``, ``es_AR``,
|
||||||
|
|
|
@ -348,8 +348,6 @@ translation method!
|
||||||
Working with lazy translation objects
|
Working with lazy translation objects
|
||||||
-------------------------------------
|
-------------------------------------
|
||||||
|
|
||||||
.. highlightlang:: python
|
|
||||||
|
|
||||||
Using ``ugettext_lazy()`` and ``ungettext_lazy()`` to mark strings in models
|
Using ``ugettext_lazy()`` and ``ungettext_lazy()`` to mark strings in models
|
||||||
and utility functions is a common operation. When you're working with these
|
and utility functions is a common operation. When you're working with these
|
||||||
objects elsewhere in your code, you should ensure that you don't accidentally
|
objects elsewhere in your code, you should ensure that you don't accidentally
|
||||||
|
@ -633,6 +631,8 @@ There are also simple filters available for convenience:
|
||||||
Specifying translation strings: In JavaScript code
|
Specifying translation strings: In JavaScript code
|
||||||
==================================================
|
==================================================
|
||||||
|
|
||||||
|
.. highlightlang:: python
|
||||||
|
|
||||||
Adding translations to JavaScript poses some problems:
|
Adding translations to JavaScript poses some problems:
|
||||||
|
|
||||||
* JavaScript code doesn't have access to a ``gettext`` implementation.
|
* JavaScript code doesn't have access to a ``gettext`` implementation.
|
||||||
|
@ -647,6 +647,8 @@ Django provides an integrated solution for these problems: It passes the
|
||||||
translations into JavaScript, so you can call ``gettext``, etc., from within
|
translations into JavaScript, so you can call ``gettext``, etc., from within
|
||||||
JavaScript.
|
JavaScript.
|
||||||
|
|
||||||
|
.. _javascript_catalog-view:
|
||||||
|
|
||||||
The ``javascript_catalog`` view
|
The ``javascript_catalog`` view
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
|
||||||
|
@ -657,8 +659,9 @@ The ``javascript_catalog`` view
|
||||||
The main solution to these problems is the :meth:`django.views.i18n.javascript_catalog`
|
The main solution to these problems is the :meth:`django.views.i18n.javascript_catalog`
|
||||||
view, which sends out a JavaScript code library with functions that mimic the
|
view, which sends out a JavaScript code library with functions that mimic the
|
||||||
``gettext`` interface, plus an array of translation strings. Those translation
|
``gettext`` interface, plus an array of translation strings. Those translation
|
||||||
strings are taken from the application, project or Django core, according to what
|
strings are taken from applications or Django core, according to what you
|
||||||
you specify in either the info_dict or the URL.
|
specify in either the info_dict or the URL. Paths listed in
|
||||||
|
:setting:`LOCALE_PATHS` are also included.
|
||||||
|
|
||||||
You hook it up like this::
|
You hook it up like this::
|
||||||
|
|
||||||
|
@ -676,6 +679,11 @@ that contains a ``locale`` directory. If you specify multiple packages, all
|
||||||
those catalogs are merged into one catalog. This is useful if you have
|
those catalogs are merged into one catalog. This is useful if you have
|
||||||
JavaScript that uses strings from different applications.
|
JavaScript that uses strings from different applications.
|
||||||
|
|
||||||
|
The precedence of translations is such that the packages appearing later in the
|
||||||
|
``packages`` argument have higher precedence than the ones appearing at the
|
||||||
|
beginning, this is important in the case of clashing translations for the same
|
||||||
|
literal.
|
||||||
|
|
||||||
By default, the view uses the ``djangojs`` gettext domain. This can be
|
By default, the view uses the ``djangojs`` gettext domain. This can be
|
||||||
changed by altering the ``domain`` argument.
|
changed by altering the ``domain`` argument.
|
||||||
|
|
||||||
|
@ -691,10 +699,25 @@ different apps and this changes often and you don't want to pull in one big
|
||||||
catalog file. As a security measure, these values can only be either
|
catalog file. As a security measure, these values can only be either
|
||||||
``django.conf`` or any package from the :setting:`INSTALLED_APPS` setting.
|
``django.conf`` or any package from the :setting:`INSTALLED_APPS` setting.
|
||||||
|
|
||||||
|
The JavaScript translations found in the paths listed in the
|
||||||
|
:setting:`LOCALE_PATHS` setting are also always included. To keep consistency
|
||||||
|
with the translations lookup order algorithm used for Python and templates, the
|
||||||
|
directories listed in :setting:`LOCALE_PATHS` have the highest precedence with
|
||||||
|
the ones appearing first having higher precedence than the ones appearing
|
||||||
|
later.
|
||||||
|
|
||||||
|
.. versionchanged:: 1.3
|
||||||
|
Directories listed in ``LOCALE_PATHS`` weren't included in the lookup
|
||||||
|
algorithm until version 1.3.
|
||||||
|
|
||||||
Using the JavaScript translation catalog
|
Using the JavaScript translation catalog
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
To use the catalog, just pull in the dynamically generated script like this::
|
.. highlightlang:: javascript
|
||||||
|
|
||||||
|
To use the catalog, just pull in the dynamically generated script like this:
|
||||||
|
|
||||||
|
.. code-block:: html+django
|
||||||
|
|
||||||
<script type="text/javascript" src="{% url django.views.i18n.javascript_catalog %}"></script>
|
<script type="text/javascript" src="{% url django.views.i18n.javascript_catalog %}"></script>
|
||||||
|
|
||||||
|
@ -751,6 +774,8 @@ to produce proper pluralizations).
|
||||||
The ``set_language`` redirect view
|
The ``set_language`` redirect view
|
||||||
==================================
|
==================================
|
||||||
|
|
||||||
|
.. highlightlang:: python
|
||||||
|
|
||||||
.. function:: set_language(request)
|
.. function:: set_language(request)
|
||||||
|
|
||||||
As a convenience, Django comes with a view, :meth:`django.views.i18n.set_language`,
|
As a convenience, Django comes with a view, :meth:`django.views.i18n.set_language`,
|
||||||
|
|
Binary file not shown.
|
@ -8,7 +8,7 @@ msgstr ""
|
||||||
"Project-Id-Version: django tests\n"
|
"Project-Id-Version: django tests\n"
|
||||||
"Report-Msgid-Bugs-To: \n"
|
"Report-Msgid-Bugs-To: \n"
|
||||||
"POT-Creation-Date: 2010-02-14 17:33+0100\n"
|
"POT-Creation-Date: 2010-02-14 17:33+0100\n"
|
||||||
"PO-Revision-Date: 2011-01-16 17:14+0100\n"
|
"PO-Revision-Date: 2011-01-21 21:37-0300\n"
|
||||||
"Last-Translator: Jannis Leidel <jannis@leidel.info>\n"
|
"Last-Translator: Jannis Leidel <jannis@leidel.info>\n"
|
||||||
"Language-Team: de <de@li.org>\n"
|
"Language-Team: de <de@li.org>\n"
|
||||||
"MIME-Version: 1.0\n"
|
"MIME-Version: 1.0\n"
|
||||||
|
@ -18,22 +18,25 @@ msgstr ""
|
||||||
|
|
||||||
#: models.py:3
|
#: models.py:3
|
||||||
msgid "Time"
|
msgid "Time"
|
||||||
msgstr "Time (LOCALE_PATHS)"
|
msgstr "Zeit (LOCALE_PATHS)"
|
||||||
|
|
||||||
#: models.py:5
|
#: models.py:5
|
||||||
|
msgid "Date/time"
|
||||||
|
msgstr "Datum/Zeit (LOCALE_PATHS)"
|
||||||
|
|
||||||
|
#: models.py:7
|
||||||
msgctxt "month name"
|
msgctxt "month name"
|
||||||
msgid "May"
|
msgid "May"
|
||||||
msgstr "Mai"
|
msgstr "Mai"
|
||||||
|
|
||||||
#: models.py:7
|
#: models.py:9
|
||||||
msgctxt "verb"
|
msgctxt "verb"
|
||||||
msgid "May"
|
msgid "May"
|
||||||
msgstr "Kann"
|
msgstr "Kann"
|
||||||
|
|
||||||
#: models.py:9
|
#: models.py:11
|
||||||
msgctxt "search"
|
msgctxt "search"
|
||||||
msgid "%d result"
|
msgid "%d result"
|
||||||
msgid_plural "%d results"
|
msgid_plural "%d results"
|
||||||
msgstr[0] "%d Resultat"
|
msgstr[0] "%d Resultat"
|
||||||
msgstr[1] "%d Resultate"
|
msgstr[1] "%d Resultate"
|
||||||
|
|
||||||
|
|
Binary file not shown.
|
@ -3,13 +3,12 @@
|
||||||
# This file is distributed under the same license as the PACKAGE package.
|
# This file is distributed under the same license as the PACKAGE package.
|
||||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||||
#
|
#
|
||||||
#, fuzzy
|
|
||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: PACKAGE VERSION\n"
|
"Project-Id-Version: django tests\n"
|
||||||
"Report-Msgid-Bugs-To: \n"
|
"Report-Msgid-Bugs-To: \n"
|
||||||
"POT-Creation-Date: 2010-02-14 17:33+0100\n"
|
"POT-Creation-Date: 2010-02-14 17:33+0100\n"
|
||||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
"PO-Revision-Date: 2011-02-07 13:12-0300\n"
|
||||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||||
"MIME-Version: 1.0\n"
|
"MIME-Version: 1.0\n"
|
||||||
|
@ -18,5 +17,9 @@ msgstr ""
|
||||||
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
||||||
|
|
||||||
#: models.py:3
|
#: models.py:3
|
||||||
|
msgid "Time"
|
||||||
|
msgstr "Zeit (APP)"
|
||||||
|
|
||||||
|
#: models.py:5
|
||||||
msgid "Date/time"
|
msgid "Date/time"
|
||||||
msgstr "Datum/Zeit (APP)"
|
msgstr "Datum/Zeit (APP)"
|
||||||
|
|
|
@ -668,14 +668,14 @@ class ResolutionOrderI18NTests(TestCase):
|
||||||
|
|
||||||
def assertUgettext(self, msgid, msgstr):
|
def assertUgettext(self, msgid, msgstr):
|
||||||
result = ugettext(msgid)
|
result = ugettext(msgid)
|
||||||
self.assert_(msgstr in result, ("The string '%s' isn't in the "
|
self.assertTrue(msgstr in result, ("The string '%s' isn't in the "
|
||||||
"translation of '%s'; the actual result is '%s'." % (msgstr, msgid, result)))
|
"translation of '%s'; the actual result is '%s'." % (msgstr, msgid, result)))
|
||||||
|
|
||||||
class AppResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
class AppResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
||||||
|
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
self.old_installed_apps = settings.INSTALLED_APPS
|
self.old_installed_apps = settings.INSTALLED_APPS
|
||||||
settings.INSTALLED_APPS = list(settings.INSTALLED_APPS) + ['regressiontests.i18n.resolution']
|
settings.INSTALLED_APPS = ['regressiontests.i18n.resolution'] + list(settings.INSTALLED_APPS)
|
||||||
super(AppResolutionOrderI18NTests, self).setUp()
|
super(AppResolutionOrderI18NTests, self).setUp()
|
||||||
|
|
||||||
def tearDown(self):
|
def tearDown(self):
|
||||||
|
@ -699,6 +699,22 @@ class LocalePathsResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
||||||
def test_locale_paths_translation(self):
|
def test_locale_paths_translation(self):
|
||||||
self.assertUgettext('Time', 'LOCALE_PATHS')
|
self.assertUgettext('Time', 'LOCALE_PATHS')
|
||||||
|
|
||||||
|
def test_locale_paths_override_app_translation(self):
|
||||||
|
old_installed_apps = settings.INSTALLED_APPS
|
||||||
|
settings.INSTALLED_APPS = list(settings.INSTALLED_APPS) + ['regressiontests.i18n.resolution']
|
||||||
|
try:
|
||||||
|
self.assertUgettext('Time', 'LOCALE_PATHS')
|
||||||
|
finally:
|
||||||
|
settings.INSTALLED_APPS = old_installed_apps
|
||||||
|
|
||||||
|
def test_locale_paths_override_project_translation(self):
|
||||||
|
old_settings_module = settings.SETTINGS_MODULE
|
||||||
|
settings.SETTINGS_MODULE = 'regressiontests'
|
||||||
|
try:
|
||||||
|
self.assertUgettext('Date/time', 'LOCALE_PATHS')
|
||||||
|
finally:
|
||||||
|
settings.SETTINGS_MODULE = old_settings_module
|
||||||
|
|
||||||
class ProjectResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
class ProjectResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
||||||
|
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
|
@ -716,19 +732,15 @@ class ProjectResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
||||||
def test_project_override_app_translation(self):
|
def test_project_override_app_translation(self):
|
||||||
old_installed_apps = settings.INSTALLED_APPS
|
old_installed_apps = settings.INSTALLED_APPS
|
||||||
settings.INSTALLED_APPS = list(settings.INSTALLED_APPS) + ['regressiontests.i18n.resolution']
|
settings.INSTALLED_APPS = list(settings.INSTALLED_APPS) + ['regressiontests.i18n.resolution']
|
||||||
self.assertUgettext('Date/time', 'PROJECT')
|
try:
|
||||||
settings.INSTALLED_APPS = old_installed_apps
|
self.assertUgettext('Date/time', 'PROJECT')
|
||||||
|
finally:
|
||||||
def test_project_override_locale_paths_translation(self):
|
settings.INSTALLED_APPS = old_installed_apps
|
||||||
old_locale_paths = settings.LOCALE_PATHS
|
|
||||||
settings.LOCALE_PATHS += (os.path.join(os.path.dirname(os.path.abspath(__file__)), 'other', 'locale'),)
|
|
||||||
self.assertUgettext('Date/time', 'PROJECT')
|
|
||||||
settings.LOCALE_PATHS = old_locale_paths
|
|
||||||
|
|
||||||
class DjangoFallbackResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
class DjangoFallbackResolutionOrderI18NTests(ResolutionOrderI18NTests):
|
||||||
|
|
||||||
def test_django_fallback(self):
|
def test_django_fallback(self):
|
||||||
self.assertUgettext('Date/time', 'Datum/Zeit')
|
self.assertEqual(ugettext('Date/time'), 'Datum/Zeit')
|
||||||
|
|
||||||
|
|
||||||
class TestModels(TestCase):
|
class TestModels(TestCase):
|
||||||
|
|
Binary file not shown.
|
@ -3,13 +3,12 @@
|
||||||
# This file is distributed under the same license as the PACKAGE package.
|
# This file is distributed under the same license as the PACKAGE package.
|
||||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||||
#
|
#
|
||||||
#, fuzzy
|
|
||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: PACKAGE VERSION\n"
|
"Project-Id-Version: django tests\n"
|
||||||
"Report-Msgid-Bugs-To: \n"
|
"Report-Msgid-Bugs-To: \n"
|
||||||
"POT-Creation-Date: 2010-02-14 17:33+0100\n"
|
"POT-Creation-Date: 2010-02-14 17:33+0100\n"
|
||||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
"PO-Revision-Date: 2011-02-07 13:13-0300\n"
|
||||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||||
"MIME-Version: 1.0\n"
|
"MIME-Version: 1.0\n"
|
||||||
|
@ -18,5 +17,9 @@ msgstr ""
|
||||||
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
||||||
|
|
||||||
#: models.py:3
|
#: models.py:3
|
||||||
|
msgid "Time"
|
||||||
|
msgstr "Zeit (PROJECT)"
|
||||||
|
|
||||||
|
#: models.py:5
|
||||||
msgid "Date/time"
|
msgid "Date/time"
|
||||||
msgstr "Datum/Zeit (PROJECT)"
|
msgstr "Datum/Zeit (PROJECT)"
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
# -*- coding:utf-8 -*-
|
# -*- coding:utf-8 -*-
|
||||||
import gettext
|
import gettext
|
||||||
|
from os import path
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.test import TestCase
|
from django.test import TestCase
|
||||||
|
@ -150,3 +151,11 @@ class JsI18NTestsMultiPackage(TestCase):
|
||||||
response = self.client.get('/views/jsi18n_multi_packages2/')
|
response = self.client.get('/views/jsi18n_multi_packages2/')
|
||||||
self.assertContains(response, javascript_quote('este texto de app3 debe ser traducido'))
|
self.assertContains(response, javascript_quote('este texto de app3 debe ser traducido'))
|
||||||
deactivate()
|
deactivate()
|
||||||
|
|
||||||
|
def testI18NWithLocalePaths(self):
|
||||||
|
settings.LANGUAGE_CODE = 'es-ar'
|
||||||
|
self.old_locale_paths = settings.LOCALE_PATHS
|
||||||
|
settings.LOCALE_PATHS += (path.join(path.dirname(path.dirname(path.abspath(__file__))), 'app3', 'locale'),)
|
||||||
|
response = self.client.get('/views/jsi18n/')
|
||||||
|
self.assertContains(response, javascript_quote('este texto de app3 debe ser traducido'))
|
||||||
|
settings.LOCALE_PATHS = self.old_locale_paths
|
||||||
|
|
Loading…
Reference in New Issue