Ticket #18731: makemessages-master.patch

django/core/management/commands/makemessages.py

@@ -42 +42 @@
             return self.file < other.file
         return self.dirpath < other.dirpath
 
-    def process(self, command, potfile, domain, keep_pot=False):
+    def process(self, command, potfile, domain, keep_pot=False, extra_keywords=None):
         """
         Extract translatable literals from self.file for :param domain:
         creating or updating the :param potfile: POT file.
@@ -73 +73 @@
                 '--keyword=gettext_lazy',
                 '--keyword=ngettext_lazy:1,2',
                 '--keyword=pgettext:1c,2',
-                '--keyword=npgettext:1c,2,3',
+                '--keyword=npgettext:1c,2,3'
+            ]
+            if extra_keywords:
+                for kw in extra_keywords:
+                    args.append('--keyword=%s' % kw)
+            args += [
                 '--from-code=UTF-8',
                 '--add-comments=Translators',
                 '--output=-'
@@ -108 +113 @@
                 '--keyword=pgettext:1c,2',
                 '--keyword=npgettext:1c,2,3',
                 '--keyword=pgettext_lazy:1c,2',
-                '--keyword=npgettext_lazy:1c,2,3',
+                '--keyword=npgettext_lazy:1c,2,3'
+            ]
+            if extra_keywords:
+                for kw in extra_keywords:
+                    args.append('--keyword=%s' % kw)
+            args += [
                 '--from-code=UTF-8',
                 '--add-comments=Translators',
                 '--output=-'
@@ -182 +192 @@
             default=False, help="Remove obsolete message strings."),
         make_option('--keep-pot', action='store_true', dest='keep_pot',
             default=False, help="Keep .pot file after making messages. Useful when debugging."),
+        make_option('--extra-keyword', dest='extra_keywords', action='append',
+            help='If you use import aliases for ugettext and its variations, '
+                 'you can specify it here to make sure that xgettext will find '
+                 'your translatable strings.'),
     )
     help = ("Runs over the entire source tree of the current directory and "
 "pulls out all strings marked for translation. It creates (or updates) a message "
@@ -207 +221 @@
         self.location = '--no-location' if options.get('no_location') else ''
         self.no_obsolete = options.get('no_obsolete')
         self.keep_pot = options.get('keep_pot')
+        self.extra_keywords = options.get('extra_keywords')
 
         if self.domain not in ('django', 'djangojs'):
             raise CommandError("currently makemessages only supports domains "
@@ -294 +309 @@
             os.unlink(potfile)
 
         for f in file_list:
-            f.process(self, potfile, self.domain, self.keep_pot)
+            f.process(self, potfile, self.domain, self.keep_pot, self.extra_keywords)
         return potfile
 
     def find_files(self, root):

docs/man/django-admin.1

@@ -60 +60 @@
 .B sqlall
 for the given app(s) in the current database.
 .TP
-.BI "makemessages [" "\-\-locale=LOCALE" "] [" "\-\-domain=DOMAIN" "] [" "\-\-extension=EXTENSION" "] [" "\-\-all" "] [" "\-\-symlinks" "] [" "\-\-ignore=PATTERN" "] [" "\-\-no\-default\-ignore" "] [" "\-\-no\-wrap" "] [" "\-\-no\-location" "]"
+.BI "makemessages [" "\-\-locale=LOCALE" "] [" "\-\-domain=DOMAIN" "] [" "\-\-extension=EXTENSION" "] [" "\-\-all" "] [" "\-\-symlinks" "] [" "\-\-ignore=PATTERN" "] [" "\-\-no\-default\-ignore" "] [" "\-\-no\-wrap" "] [" "\-\-no\-location" "] [" "\-\-extra\-keyword" "]"
 Runs over the entire source tree of the current directory and pulls out all
 strings marked for translation. It creates (or updates) a message file in the
 conf/locale (in the django tree) or locale (for project and application) directory.

docs/ref/django-admin.txt

@@ -520 +520 @@
 .pot file it generates before creating the .po file. This is useful for
 debugging errors which may prevent the final language files from being created.
 
+.. django-admin-option:: --extra-keyword
+
+.. versionadded:: 1.6
+
+When you import the ``ugettext`` and ``ugettext_lazy`` functions as aliases,
+``makemessages`` may not find translatable strings in your python source code.
+With the ``--extra-keyword`` option, you can force it to look for other aliases
+you may choose.
+
+Example usage:
+
+If you want ``makemessages`` to find translatable strings in the following
+python code.
+
+.. code-block:: python
+
+   from django.utils.translation import ugettext as tr, ugettext_lazy as tr_lazy
+
+   tr('some translatable string')
+   tr_lazy('some lazy translatable string')
+
+You will need to add the option ``--extra-keyword`` twice::
+
+    django-admin.py makemessages --locale=fr_FR --extra-keyword=tr --extra-keyword=tr_lazy
+
+.. note:: The default alias ``'_'`` will allways be detected by ``makemessages`` 
+   whether you use the ``--extra-keyword`` option or not.
+
+
 runfcgi [options]
 -----------------
 

tests/i18n/commands/extraction.py

@@ -423 +423 @@
         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))
+
+
+class UgettextAliasesTests(ExtractorTests):
+
+    def test_missing_keyword(self):
+        os.chdir(self.test_dir)
+        shutil.copyfile('./ugettext-aliases.sample', './ugettext_aliases.py')
+        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.assertNotMsgId('Should be found only with the --extra-keyword option', po_contents)
+            self.assertNotMsgId('Lazy, should be found only with the --extra-keyword option', po_contents)
+        os.remove('./ugettext_aliases.py')
+
+    def test_added_keywords(self):
+        os.chdir(self.test_dir)
+        shutil.copyfile('./ugettext-aliases.sample', './ugettext_aliases.py')
+        management.call_command('makemessages', locale=LOCALE, verbosity=0, extra_keywords=['tr', 'tr_lazy'])
+        self.assertTrue(os.path.exists(self.PO_FILE))
+        with open(self.PO_FILE, 'r') as fp:
+            po_contents = force_text(fp.read())
+            self.assertMsgId('Should be found only with the --extra-keyword option', po_contents)
+            self.assertMsgId('Lazy, should be found only with the --extra-keyword option', po_contents)
+        os.remove('./ugettext_aliases.py')

new file tests/i18n/commands/ugettext-aliases.sample

@@ +1 @@
+from django.utils.translation import ugettext as tr, ugettext_lazy as tr_lazy
+
+tr('Should be found only with the --extra-keyword option')
+tr_lazy('Lazy, should be found only with the --extra-keyword option')

tests/i18n/tests.py

@@ -38 +38 @@
         JavascriptExtractorTests, IgnoredExtractorTests, SymlinkExtractorTests,
         CopyPluralFormsExtractorTests, NoWrapExtractorTests,
         NoLocationExtractorTests, KeepPotFileExtractorTests,
-        MultipleLocaleExtractionTests)
+        MultipleLocaleExtractionTests, UgettextAliasesTests)
 if can_run_compilation_tests:
     from .commands.compilation import (PoFileTests, PoFileContentsTests,
         PercentRenderingTests, MultipleLocaleCompilationTests,