Ticket #18731: makemessages-1.5.x.patch

django/core/management/commands/makemessages.py

@@ -126 +126 @@
         fp.write(msgs)
 
 def process_file(file, dirpath, potfile, domain, verbosity,
-                 extensions, wrap, location, stdout=sys.stdout):
+                 extensions, wrap, location, stdout=sys.stdout,
+                 extra_keywords=None):
     """
     Extract translatable literals from :param file: for :param domain:
     creating or updating the :param potfile: POT file.
@@ -149 +150 @@
         work_file = os.path.join(dirpath, thefile)
         with open(work_file, "w") as fp:
             fp.write(src_data)
-        cmd = (
-            'xgettext -d %s -L C %s %s --keyword=gettext_noop '
-            '--keyword=gettext_lazy --keyword=ngettext_lazy:1,2 '
-            '--keyword=pgettext:1c,2 --keyword=npgettext:1c,2,3 '
-            '--from-code UTF-8 --add-comments=Translators -o - "%s"' %
-            (domain, wrap, location, work_file))
+
+        keywords = ['gettext_noop',
+                    'gettext_lazy',
+                    'ngettext_lazy:1,2',
+                    'pgettext:1c,2',
+                    'npgettext:1c,2,3',
+                    ]
+        if extra_keywords:
+            keywords.extend(extra_keywords)
+
+        cmd = 'xgettext -d %s -L C %s %s'
+        for kw in keywords:
+            cmd += ' --keyword=%s' % kw
+        cmd += ' --from-code UTF-8 --add-comments=Translators -o - "%s"'
+        cmd %= (domain, wrap, location, work_file)
+
     elif domain == 'django' and (file_ext == '.py' or file_ext in extensions):
         thefile = file
         orig_file = os.path.join(dirpath, file)
@@ -167 +178 @@
             with open(os.path.join(dirpath, thefile), "w") as fp:
                 fp.write(content)
         work_file = os.path.join(dirpath, thefile)
-        cmd = (
-            'xgettext -d %s -L Python %s %s --keyword=gettext_noop '
-            '--keyword=gettext_lazy --keyword=ngettext_lazy:1,2 '
-            '--keyword=ugettext_noop --keyword=ugettext_lazy '
-            '--keyword=ungettext_lazy:1,2 --keyword=pgettext:1c,2 '
-            '--keyword=npgettext:1c,2,3 --keyword=pgettext_lazy:1c,2 '
-            '--keyword=npgettext_lazy:1c,2,3 --from-code UTF-8 '
-            '--add-comments=Translators -o - "%s"' %
-            (domain, wrap, location, work_file))
+
+        keywords = ['gettext_lazy',
+                    'ngettext_lazy:1,2',
+                    'ugettext_noop',
+                    'ugettext_lazy',
+                    'ungettext_lazy:1,2',
+                    'pgettext:1c,2',
+                    'npgettext:1c,2,3',
+                    'pgettext_lazy:1c,2',
+                    'npgettext_lazy:1c,2,3',
+                    ]
+        if extra_keywords:
+            keywords.extend(extra_keywords)
+
+        cmd = 'xgettext -d %s -L Python %s %s'
+        for kw in keywords:
+            cmd += ' --keyword=%s' % kw
+        cmd += ' --from-code UTF-8 --add-comments=Translators -o - "%s"'
+        cmd %= (domain, wrap, location, work_file)
     else:
         return
     msgs, errors, status = _popen(cmd)
@@ -246 +267 @@
 
 def make_messages(locale=None, domain='django', verbosity=1, all=False,
         extensions=None, symlinks=False, ignore_patterns=None, no_wrap=False,
-        no_location=False, no_obsolete=False, stdout=sys.stdout):
+        no_location=False, no_obsolete=False, stdout=sys.stdout,
+        extra_keywords=None):
     """
     Uses the ``locale/`` directory from the Django Git tree or an
     application/project to process all files with translatable literals for
@@ -325 +347 @@
         for dirpath, file in find_files(".", ignore_patterns, verbosity,
                 stdout, symlinks=symlinks):
             process_file(file, dirpath, potfile, domain, verbosity, extensions,
-                    wrap, location, stdout)
+                    wrap, location, stdout, extra_keywords)
 
         if os.path.exists(potfile):
             write_po_file(pofile, potfile, domain, locale, verbosity, stdout,
@@ -355 +377 @@
             default=False, help="Don't write '#: filename:line' lines"),
         make_option('--no-obsolete', action='store_true', dest='no_obsolete',
             default=False, help="Remove obsolete message strings"),
+        make_option('--extra-keyword', dest='extra_keywords',
+                    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.',
+                    action='append')
     )
     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 "
@@ -379 +406 @@
         no_wrap = options.get('no_wrap')
         no_location = options.get('no_location')
         no_obsolete = options.get('no_obsolete')
+        extra_keywords = options.get('extra_keywords')
         if domain == 'djangojs':
             exts = extensions if extensions else ['js']
         else:
@@ -390 +418 @@
                              % get_text_list(list(extensions), 'and'))
 
         make_messages(locale, domain, verbosity, process_all, extensions,
-            symlinks, ignore_patterns, no_wrap, no_location, no_obsolete, self.stdout)
+            symlinks, ignore_patterns, no_wrap, no_location, no_obsolete,
+            self.stdout, extra_keywords)

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=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

@@ -474 +474 @@
 comment lines in language files. Note that using this option makes it harder
 for technically skilled translators to understand each message's context.
 
+.. 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

@@ -293 +293 @@
         with open(self.PO_FILE, 'r') as fp:
             po_contents = force_text(fp.read())
             self.assertTrue('#: templates/test.html:55' in po_contents)
+
+
+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

@@ -32 +32 @@
     from .commands.extraction import (ExtractorTests, BasicExtractorTests,
         JavascriptExtractorTests, IgnoredExtractorTests, SymlinkExtractorTests,
         CopyPluralFormsExtractorTests, NoWrapExtractorTests,
-        NoLocationExtractorTests)
+        NoLocationExtractorTests, UgettextAliasesTests)
 if can_run_compilation_tests:
     from .commands.compilation import (PoFileTests, PoFileContentsTests,
         PercentRenderingTests)