mirror of
https://github.com/django/django.git
synced 2024-12-27 11:35:53 +00:00
47ddd6a408
They are simply ignored now. This allows for a more correct behavior when
they are placed before translatable constructs on the same line.
Previously, the latter were wrongly ignored because the former were
preserved when converting template code to the internal Python-syntax
form later fed to xgettext but Python has no ``/* ... */``-style
comments.
Also, special comments directed to translators are now only taken in
account when they are located at the end of a line. e.g.::
{# Translators: ignored #}{% trans "Literal A" %}{# Translators: valid, associated with "Literal B" below #}
{% trans "Literal B" %}
Behavior of ``{% comment %}...{% endcomment %}``tags remains unchanged.
Thanks juneih at redpill-linpro dot com for the report and Claude for
his work on the issue.
416 lines
19 KiB
Python
416 lines
19 KiB
Python
# -*- encoding: utf-8 -*-
|
|
from __future__ import unicode_literals
|
|
|
|
import os
|
|
import re
|
|
import shutil
|
|
import warnings
|
|
|
|
from django.core import management
|
|
from django.test import SimpleTestCase
|
|
from django.utils.encoding import force_text
|
|
from django.utils._os import upath
|
|
from django.utils import six
|
|
from django.utils.six import StringIO
|
|
from django.utils.translation import TranslatorCommentWarning
|
|
|
|
|
|
LOCALE='de'
|
|
|
|
class ExtractorTests(SimpleTestCase):
|
|
|
|
PO_FILE='locale/%s/LC_MESSAGES/django.po' % LOCALE
|
|
|
|
def setUp(self):
|
|
self._cwd = os.getcwd()
|
|
self.test_dir = os.path.abspath(os.path.dirname(upath(__file__)))
|
|
|
|
def _rmrf(self, dname):
|
|
if os.path.commonprefix([self.test_dir, os.path.abspath(dname)]) != self.test_dir:
|
|
return
|
|
shutil.rmtree(dname)
|
|
|
|
def tearDown(self):
|
|
os.chdir(self.test_dir)
|
|
try:
|
|
self._rmrf('locale/%s' % LOCALE)
|
|
except OSError:
|
|
pass
|
|
os.chdir(self._cwd)
|
|
|
|
def assertMsgId(self, msgid, s, use_quotes=True):
|
|
q = '"'
|
|
if use_quotes:
|
|
msgid = '"%s"' % msgid
|
|
q = "'"
|
|
needle = 'msgid %s' % msgid
|
|
msgid = re.escape(msgid)
|
|
return self.assertTrue(re.search('^msgid %s' % msgid, s, re.MULTILINE), 'Could not find %(q)s%(n)s%(q)s in generated PO file' % {'n':needle, 'q':q})
|
|
|
|
def assertNotMsgId(self, msgid, s, use_quotes=True):
|
|
if use_quotes:
|
|
msgid = '"%s"' % msgid
|
|
msgid = re.escape(msgid)
|
|
return self.assertTrue(not re.search('^msgid %s' % msgid, s, re.MULTILINE))
|
|
|
|
|
|
class BasicExtractorTests(ExtractorTests):
|
|
|
|
def test_comments_extractor(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertTrue('#. Translators: This comment should be extracted' in po_contents)
|
|
self.assertTrue('This comment should not be extracted' not in po_contents)
|
|
# Comments in templates
|
|
self.assertTrue('#. Translators: Django template comment for translators' in po_contents)
|
|
self.assertTrue("#. Translators: Django comment block for translators\n#. string's meaning unveiled" in po_contents)
|
|
|
|
self.assertTrue('#. Translators: One-line translator comment #1' in po_contents)
|
|
self.assertTrue('#. Translators: Two-line translator comment #1\n#. continued here.' in po_contents)
|
|
|
|
self.assertTrue('#. Translators: One-line translator comment #2' in po_contents)
|
|
self.assertTrue('#. Translators: Two-line translator comment #2\n#. continued here.' in po_contents)
|
|
|
|
self.assertTrue('#. Translators: One-line translator comment #3' in po_contents)
|
|
self.assertTrue('#. Translators: Two-line translator comment #3\n#. continued here.' in po_contents)
|
|
|
|
self.assertTrue('#. Translators: One-line translator comment #4' in po_contents)
|
|
self.assertTrue('#. Translators: Two-line translator comment #4\n#. continued here.' in po_contents)
|
|
|
|
self.assertTrue('#. Translators: One-line translator comment #5 -- with non ASCII characters: áéíóúö' in po_contents)
|
|
self.assertTrue('#. Translators: Two-line translator comment #5 -- with non ASCII characters: áéíóúö\n#. continued here.' in po_contents)
|
|
|
|
def test_templatize_trans_tag(self):
|
|
# ticket #11240
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertMsgId('Literal with a percent symbol at the end %%', po_contents)
|
|
self.assertMsgId('Literal with a percent %% symbol in the middle', po_contents)
|
|
self.assertMsgId('Completed 50%% of all the tasks', po_contents)
|
|
self.assertMsgId('Completed 99%% of all the tasks', po_contents)
|
|
self.assertMsgId("Shouldn't double escape this sequence: %% (two percent signs)", po_contents)
|
|
self.assertMsgId("Shouldn't double escape this sequence %% either", po_contents)
|
|
self.assertMsgId("Looks like a str fmt spec %%s but shouldn't be interpreted as such", po_contents)
|
|
self.assertMsgId("Looks like a str fmt spec %% o but shouldn't be interpreted as such", po_contents)
|
|
|
|
def test_templatize_blocktrans_tag(self):
|
|
# ticket #11966
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertMsgId('I think that 100%% is more that 50%% of anything.', po_contents)
|
|
self.assertMsgId('I think that 100%% is more that 50%% of %(obj)s.', po_contents)
|
|
self.assertMsgId("Blocktrans extraction shouldn't double escape this: %%, a=%(a)s", po_contents)
|
|
|
|
def test_extraction_error(self):
|
|
os.chdir(self.test_dir)
|
|
self.assertRaises(SyntaxError, management.call_command, 'makemessages', locale=LOCALE, extensions=['tpl'], verbosity=0)
|
|
with self.assertRaises(SyntaxError) as context_manager:
|
|
management.call_command('makemessages', locale=LOCALE, extensions=['tpl'], verbosity=0)
|
|
six.assertRegex(self, str(context_manager.exception),
|
|
r'Translation blocks must not include other block tags: blocktrans \(file templates[/\\]template_with_error\.tpl, line 3\)'
|
|
)
|
|
# Check that the temporary file was cleaned up
|
|
self.assertFalse(os.path.exists('./templates/template_with_error.tpl.py'))
|
|
|
|
def test_extraction_warning(self):
|
|
"""test xgettext warning about multiple bare interpolation placeholders"""
|
|
os.chdir(self.test_dir)
|
|
shutil.copyfile('./code.sample', './code_sample.py')
|
|
stdout = StringIO()
|
|
management.call_command('makemessages', locale=LOCALE, stdout=stdout)
|
|
os.remove('./code_sample.py')
|
|
self.assertIn("code_sample.py:4", force_text(stdout.getvalue()))
|
|
|
|
def test_template_message_context_extractor(self):
|
|
"""
|
|
Ensure that message contexts are correctly extracted for the
|
|
{% trans %} and {% blocktrans %} template tags.
|
|
Refs #14806.
|
|
"""
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
# {% trans %}
|
|
self.assertTrue('msgctxt "Special trans context #1"' in po_contents)
|
|
self.assertMsgId("Translatable literal #7a", po_contents)
|
|
self.assertTrue('msgctxt "Special trans context #2"' in po_contents)
|
|
self.assertMsgId("Translatable literal #7b", po_contents)
|
|
self.assertTrue('msgctxt "Special trans context #3"' in po_contents)
|
|
self.assertMsgId("Translatable literal #7c", po_contents)
|
|
|
|
# {% blocktrans %}
|
|
self.assertTrue('msgctxt "Special blocktrans context #1"' in po_contents)
|
|
self.assertMsgId("Translatable literal #8a", po_contents)
|
|
self.assertTrue('msgctxt "Special blocktrans context #2"' in po_contents)
|
|
self.assertMsgId("Translatable literal #8b-singular", po_contents)
|
|
self.assertTrue("Translatable literal #8b-plural" in po_contents)
|
|
self.assertTrue('msgctxt "Special blocktrans context #3"' in po_contents)
|
|
self.assertMsgId("Translatable literal #8c-singular", po_contents)
|
|
self.assertTrue("Translatable literal #8c-plural" in po_contents)
|
|
self.assertTrue('msgctxt "Special blocktrans context #4"' in po_contents)
|
|
self.assertMsgId("Translatable literal #8d %(a)s", po_contents)
|
|
|
|
def test_context_in_single_quotes(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
# {% trans %}
|
|
self.assertTrue('msgctxt "Context wrapped in double quotes"' in po_contents)
|
|
self.assertTrue('msgctxt "Context wrapped in single quotes"' in po_contents)
|
|
|
|
# {% blocktrans %}
|
|
self.assertTrue('msgctxt "Special blocktrans context wrapped in double quotes"' in po_contents)
|
|
self.assertTrue('msgctxt "Special blocktrans context wrapped in single quotes"' in po_contents)
|
|
|
|
def test_template_comments(self):
|
|
"""Template comment tags on the same line of other constructs (#19552)"""
|
|
os.chdir(self.test_dir)
|
|
# Test detection/end user reporting of old, incorrect templates
|
|
# translator comments syntax
|
|
with warnings.catch_warnings(record=True) as ws:
|
|
warnings.simplefilter('always')
|
|
management.call_command('makemessages', locale=LOCALE, extensions=['thtml'], verbosity=0)
|
|
self.assertEqual(len(ws), 3)
|
|
for w in ws:
|
|
self.assertTrue(issubclass(w.category, TranslatorCommentWarning))
|
|
six.assertRegex(self, str(ws[0].message),
|
|
r"The translator-targeted comment 'Translators: ignored i18n comment #1' \(file templates/comments.thtml, line 4\) was ignored, because it wasn't the last item on the line\."
|
|
)
|
|
six.assertRegex(self, str(ws[1].message),
|
|
r"The translator-targeted comment 'Translators: ignored i18n comment #3' \(file templates/comments.thtml, line 6\) was ignored, because it wasn't the last item on the line\."
|
|
)
|
|
six.assertRegex(self, str(ws[2].message),
|
|
r"The translator-targeted comment 'Translators: ignored i18n comment #4' \(file templates/comments.thtml, line 8\) was ignored, because it wasn't the last item on the line\."
|
|
)
|
|
# Now test .po file contents
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
|
|
self.assertMsgId('Translatable literal #9a', po_contents)
|
|
self.assertFalse('ignored comment #1' in po_contents)
|
|
|
|
self.assertFalse('Translators: ignored i18n comment #1' in po_contents)
|
|
self.assertMsgId("Translatable literal #9b", po_contents)
|
|
|
|
self.assertFalse('ignored i18n comment #2' in po_contents)
|
|
self.assertFalse('ignored comment #2' in po_contents)
|
|
self.assertMsgId('Translatable literal #9c', po_contents)
|
|
|
|
self.assertFalse('ignored comment #3' in po_contents)
|
|
self.assertFalse('ignored i18n comment #3' in po_contents)
|
|
self.assertMsgId('Translatable literal #9d', po_contents)
|
|
|
|
self.assertFalse('ignored comment #4' in po_contents)
|
|
self.assertMsgId('Translatable literal #9e', po_contents)
|
|
self.assertFalse('ignored comment #5' in po_contents)
|
|
|
|
self.assertFalse('ignored i18n comment #4' in po_contents)
|
|
self.assertMsgId('Translatable literal #9f', po_contents)
|
|
self.assertTrue('#. Translators: valid i18n comment #5' in po_contents)
|
|
|
|
self.assertMsgId('Translatable literal #9g', po_contents)
|
|
self.assertTrue('#. Translators: valid i18n comment #6' in po_contents)
|
|
self.assertMsgId('Translatable literal #9h', po_contents)
|
|
self.assertTrue('#. Translators: valid i18n comment #7' in po_contents)
|
|
self.assertMsgId('Translatable literal #9i', po_contents)
|
|
|
|
six.assertRegex(self, po_contents, r'#\..+Translators: valid i18n comment #8')
|
|
six.assertRegex(self, po_contents, r'#\..+Translators: valid i18n comment #9')
|
|
self.assertMsgId("Translatable literal #9j", po_contents)
|
|
|
|
|
|
class JavascriptExtractorTests(ExtractorTests):
|
|
|
|
PO_FILE='locale/%s/LC_MESSAGES/djangojs.po' % LOCALE
|
|
|
|
def test_javascript_literals(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', domain='djangojs', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = fp.read()
|
|
self.assertMsgId('This literal should be included.', po_contents)
|
|
self.assertMsgId('This one as well.', po_contents)
|
|
self.assertMsgId(r'He said, \"hello\".', po_contents)
|
|
self.assertMsgId("okkkk", po_contents)
|
|
self.assertMsgId("TEXT", po_contents)
|
|
self.assertMsgId("It's at http://example.com", po_contents)
|
|
self.assertMsgId("String", po_contents)
|
|
self.assertMsgId("/* but this one will be too */ 'cause there is no way of telling...", po_contents)
|
|
self.assertMsgId("foo", po_contents)
|
|
self.assertMsgId("bar", po_contents)
|
|
self.assertMsgId("baz", po_contents)
|
|
self.assertMsgId("quz", po_contents)
|
|
self.assertMsgId("foobar", po_contents)
|
|
|
|
class IgnoredExtractorTests(ExtractorTests):
|
|
|
|
def test_ignore_option(self):
|
|
os.chdir(self.test_dir)
|
|
pattern1 = os.path.join('ignore_dir', '*')
|
|
stdout = StringIO()
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=2,
|
|
ignore_patterns=[pattern1], stdout=stdout)
|
|
data = stdout.getvalue()
|
|
self.assertTrue("ignoring directory ignore_dir" in data)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = fp.read()
|
|
self.assertMsgId('This literal should be included.', po_contents)
|
|
self.assertNotMsgId('This should be ignored.', po_contents)
|
|
|
|
|
|
class SymlinkExtractorTests(ExtractorTests):
|
|
|
|
def setUp(self):
|
|
self._cwd = os.getcwd()
|
|
self.test_dir = os.path.abspath(os.path.dirname(upath(__file__)))
|
|
self.symlinked_dir = os.path.join(self.test_dir, 'templates_symlinked')
|
|
|
|
def tearDown(self):
|
|
super(SymlinkExtractorTests, self).tearDown()
|
|
os.chdir(self.test_dir)
|
|
try:
|
|
os.remove(self.symlinked_dir)
|
|
except OSError:
|
|
pass
|
|
os.chdir(self._cwd)
|
|
|
|
def test_symlink(self):
|
|
if hasattr(os, 'symlink'):
|
|
if os.path.exists(self.symlinked_dir):
|
|
self.assertTrue(os.path.islink(self.symlinked_dir))
|
|
else:
|
|
os.symlink(os.path.join(self.test_dir, 'templates'), self.symlinked_dir)
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0, symlinks=True)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertMsgId('This literal should be included.', po_contents)
|
|
self.assertTrue('templates_symlinked/test.html' in po_contents)
|
|
|
|
|
|
class CopyPluralFormsExtractorTests(ExtractorTests):
|
|
|
|
def test_copy_plural_forms(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertTrue('Plural-Forms: nplurals=2; plural=(n != 1)' in po_contents)
|
|
|
|
|
|
class NoWrapExtractorTests(ExtractorTests):
|
|
|
|
def test_no_wrap_enabled(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0, no_wrap=True)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertMsgId('This literal should also be included wrapped or not wrapped depending on the use of the --no-wrap option.', po_contents)
|
|
|
|
def test_no_wrap_disabled(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0, no_wrap=False)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertMsgId('""\n"This literal should also be included wrapped or not wrapped depending on the "\n"use of the --no-wrap option."', po_contents, use_quotes=False)
|
|
|
|
|
|
class NoLocationExtractorTests(ExtractorTests):
|
|
|
|
def test_no_location_enabled(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0, no_location=True)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertFalse('#: templates/test.html:55' in po_contents)
|
|
|
|
def test_no_location_disabled(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0, no_location=False)
|
|
self.assertTrue(os.path.exists(self.PO_FILE))
|
|
with open(self.PO_FILE, 'r') as fp:
|
|
po_contents = force_text(fp.read())
|
|
self.assertTrue('#: templates/test.html:55' in po_contents)
|
|
|
|
|
|
class KeepPotFileExtractorTests(ExtractorTests):
|
|
|
|
POT_FILE='locale/django.pot'
|
|
|
|
def setUp(self):
|
|
super(KeepPotFileExtractorTests, self).setUp()
|
|
|
|
def tearDown(self):
|
|
super(KeepPotFileExtractorTests, self).tearDown()
|
|
os.chdir(self.test_dir)
|
|
try:
|
|
os.unlink(self.POT_FILE)
|
|
except OSError:
|
|
pass
|
|
os.chdir(self._cwd)
|
|
|
|
def test_keep_pot_disabled_by_default(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0)
|
|
self.assertFalse(os.path.exists(self.POT_FILE))
|
|
|
|
def test_keep_pot_explicitly_disabled(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0,
|
|
keep_pot=False)
|
|
self.assertFalse(os.path.exists(self.POT_FILE))
|
|
|
|
def test_keep_pot_enabled(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=LOCALE, verbosity=0,
|
|
keep_pot=True)
|
|
self.assertTrue(os.path.exists(self.POT_FILE))
|
|
|
|
|
|
class MultipleLocaleExtractionTests(ExtractorTests):
|
|
PO_FILE_PT = 'locale/pt/LC_MESSAGES/django.po'
|
|
PO_FILE_DE = 'locale/de/LC_MESSAGES/django.po'
|
|
LOCALES = ['pt', 'de', 'ch']
|
|
|
|
def tearDown(self):
|
|
os.chdir(self.test_dir)
|
|
for locale in self.LOCALES:
|
|
try:
|
|
self._rmrf('locale/%s' % locale)
|
|
except OSError:
|
|
pass
|
|
os.chdir(self._cwd)
|
|
|
|
def test_multiple_locales(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale=['pt','de'], verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE_PT))
|
|
self.assertTrue(os.path.exists(self.PO_FILE_DE))
|
|
|
|
def test_comma_separated_locales(self):
|
|
os.chdir(self.test_dir)
|
|
management.call_command('makemessages', locale='pt,de,ch', verbosity=0)
|
|
self.assertTrue(os.path.exists(self.PO_FILE_PT))
|
|
self.assertTrue(os.path.exists(self.PO_FILE_DE))
|