Ticket #16332: i18n_urls.diff

django/templatetags/i18n.py

@@ +1 @@
+from __future__ import with_statement
 import re
 
 from django.template import Node, Variable, VariableNode
@@ -6 +7 @@
 from django.template.base import _render_value_in_context
 from django.utils import translation
 from django.utils.encoding import force_unicode
-from django.template.defaulttags import token_kwargs
+from django.template.defaulttags import token_kwargs, kwarg_re, URLNode
 
 register = Library()
 
@@ -117 +118 @@
         context.pop()
         return result % data
 
+class I18NURLNode(URLNode):
+    def __init__(self, view_name, language, args, kwargs, asvar):
+        super(I18NURLNode, self).__init__(view_name, args, kwargs, asvar, False)
+        self.language = language
+
+    def render(self, context):
+        with translation.override(self.language.resolve(context)):
+            return super(I18NURLNode, self).render(context)
+
 @register.tag("get_available_languages")
 def do_get_available_languages(parser, token):
     """
@@ -366 +376 @@
 
     return BlockTranslateNode(extra_context, singular, plural, countervar,
             counter)
+
+@register.tag
+def i18n_url(parser, token):
+    bits = token.split_contents()
+    if len(bits) < 3:
+        raise TemplateSyntaxError("'%s' takes at least two arguments"
+                                  " (path to a view and the language)" % bits[0])
+    viewname = parser.compile_filter(bits[1])
+    language = parser.compile_filter(bits[2])
+    args = []
+    kwargs = {}
+    asvar = None
+    bits = bits[3:]
+    if len(bits) >= 2 and bits[-2] == 'as':
+        asvar = bits[-1]
+        bits = bits[:-2]
+
+    if len(bits):
+        for bit in bits:
+            match = kwarg_re.match(bit)
+            if not match:
+                raise TemplateSyntaxError("Malformed arguments to url tag")
+            name, value = match.groups()
+            if name:
+                kwargs[name] = parser.compile_filter(value)
+            else:
+                args.append(parser.compile_filter(value))
+
+    return I18NURLNode(viewname, language, args, kwargs, asvar)

docs/topics/http/urls.txt

@@ -28 +28 @@
 mappings. And, because it's pure Python code, it can be constructed
 dynamically.
 
+Additionally Django allows to translate URLs according to the active language.
+This process is described in the :ref:`internationalization docs <url-internationalization>`.
+
 .. _how-django-processes-a-request:
 
 How Django processes a request

docs/topics/i18n/internationalization.txt

@@ -887 +887 @@
     that a carelessly translated URL causes a collision with a non-translated
     URL pattern.
 
+.. _reversing_in_templates:
+
+Reversing in tepmlates
+----------------------
+
+If localized URLs get reversed in templates the always use the current language.
+To link to an URL in another language an extra tag got added:
+
+.. code-block:: html+django
+
+    {% load i18n %}
+    {% get_available_languages as languages %}
+    View the Homepage in:
+    {% for lang in languages %}
+        <a href="{% i18n_url 'homepage' lang.0 kwarg1=val1 kwarg2=val2 %}">{{ lang.1 }}</a> 
+    {% endfor %}
+
+The ``i18n_url`` tag expects the language after the viewname and otherwise
+like the builtin ``url`` tag.
+
 .. _set_language-redirect-view:
 
 The ``set_language`` redirect view

tests/regressiontests/i18n/patterns/tests.py

@@ -6 +6 @@
 from django.core.urlresolvers import reverse, clear_url_caches
 from django.test import TestCase
 from django.test.utils import override_settings
+from django.template import Template, Context
 from django.utils import translation
 
 
@@ -241 +242 @@
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response['content-language'], 'pt-br')
         self.assertEqual(response.context['LANGUAGE_CODE'], 'pt-br')
+
+
+class URLTagTests(URLTestCaseBase):
+    """
+    Test if the i18n_url tag works.
+    """
+    def test_strings_only(self):
+        c = Context({})
+        t = Template("""{% load i18n %}
+                {% i18n_url 'no-prefix-translated' 'nl' %}
+                {% i18n_url 'no-prefix-translated' 'pt-br' %}""")
+        self.assertEqual(t.render(c).strip().split(),
+                         [u'/vertaald/', u'/traduzidos/'])
+
+    def test_context(self):
+        c = Context({'url': 'no-prefix-translated', 'lang1':'nl',
+                     'lang2':'pt-br'})
+        t = Template("""{% load i18n %}
+                {% i18n_url url lang1 %}
+                {% i18n_url url lang2 %}""")
+        self.assertEqual(t.render(c).strip().split(),
+                         [u'/vertaald/', u'/traduzidos/'])
+
+    def test_args_and_kwargs(self):
+        c = Context({})
+        t = Template("""{% load i18n %}
+                {% i18n_url 'no-prefix-translated-slug' 'nl' 'apo' %}
+                {% i18n_url 'no-prefix-translated-slug' 'pt-br' 'apo' %}""")
+        self.assertEqual(t.render(c).strip().split(),
+                         [u'/vertaald/apo/', u'/traduzidos/apo/'])
+        t = Template("""{% load i18n %}
+                {% i18n_url 'no-prefix-translated-slug' 'nl' slug='apo' %}
+                {% i18n_url 'no-prefix-translated-slug' 'pt-br' slug='apo' %}""")
+        self.assertEqual(t.render(c).strip().split(),
+                         [u'/vertaald/apo/', u'/traduzidos/apo/'])
+