Opened 5 years ago
Closed 3 years ago
#18731 closed Cleanup/optimization (fixed)
Document how to pass additional keywords to xgettext in makemessages
Description
Hi there,
when doing translations for one of my projects, I noticed that none of the strings that I had identified as "translatable" in python files were gathered in PO files.
After some code browsing, I saw that the "makemessages" management command has a fixed set of --keyword arguments passed to xgettext.
It occurs that I don't use imports with their full name:
from django.utils.translation import ugettext
Nor with the standard "_" alias:
from django.utils.translation import ugettext as _
Because "_" is a dummy variable that I use a lot when doing tuple expansion with unused items (I do use "tr" because it does not mix with other of my stuff but that's not the point here)
It would be cool if the "makemessages" command could accept user defined keywords. I did a small patch myself that accomplishes this. Please take it in consideration :-)
Thanks in advance keep up the great work,
Robin
Attachments (3)
Change History (23)
comment:1 Changed 5 years ago by
comment:2 Changed 5 years ago by
comment:3 Changed 5 years ago by
Wrong ticket number in commit message -- reopening.
comment:4 Changed 5 years ago by
comment:5 Changed 5 years ago by
comment:6 Changed 5 years ago by
Hello,
Could this patch be integrated in the next release? It is not a big change :)
Maybe I can help with something?
Thanks,
--Robin
comment:7 Changed 5 years ago by
It looks like the patch needs tests and documentation. Uploading a new diff against master with code, docs and tests changes would help.
comment:8 Changed 5 years ago by
Hello,
I wrote docs and tests in a new patch against master. Tell me if I need to change something :)
Changed 5 years ago by
Adds --extra-keyword to the makemessages command. (with docs and tests)
comment:9 Changed 5 years ago by
Oops,
the patch I uploaded is not complete (missing sample files)
Here are 2 new patches (one for django 1.5.x and one for the master HEAD)
my bad :)
Changed 5 years ago by
Adds --extra-keyword to the makemessages command. (with docs and tests)
Changed 5 years ago by
Adds --extra-keyword to the makemessages command. (with docs and tests) [for django 1.5.x]
comment:10 Changed 5 years ago by
I made a pull request on github :)
comment:11 Changed 4 years ago by
Patch no longer applies cleanly (and docs need updating for the fact that this would go in 1.7).
comment:12 Changed 4 years ago by
The patch has been reworked on the HEAD.
Here's a new pull request:
comment:13 Changed 4 years ago by
Gentle bump.
I hope it is not too late for integration in 1.7 :-)
comment:14 Changed 4 years ago by
You need someone besides yourself to review the patch in order to mark it RFC, thanks.
comment:15 Changed 4 years ago by
oops sorry :-/
comment:16 Changed 4 years ago by
In my recent commit in
makemessages ([06efeae598c6dafbe56d2ea323a0dccdd5bf2b8e]), I added an options list for various gettext commands at the
Command level.
Therefore, the new way to solve this issue is to create a custom
makemessages command in one of your project's apps, and complete the
Command.xgettext_options list. I'm keeping this ticket open so as to add an example in the documentation.
comment:17 Changed 3 years ago by
To people who - like me lately - would land here after a google search and want to add gettext extra keywords to Django < 1.7 without having to patch Django, you may want to use this management command override which will work with Django 1.6 and earlier. Or simply use the django-extra_keywords package.
It uses an approach that differs from what is suggested above, by monkey-patching
popen_wrapper (>= 1.6) or
_popen (< 1.6) in
core.management.commands.makemessages and adding arguments to the command. A bit hackish, but it does the job.
comment:18 Changed 3 years ago by
Berker created a documentation pull request as suggested by Claude.
comment:19 Changed 3 years ago by
The patch looks okay to me, but Claude should review as well as I'm not a makemessages user.
I forgot to explain some stuff about the patch :)
Basically, if you use the i18n functions like this:
You can generate/update the .po files with this command (run into the app directory and/or from the project root)
It will take all your translatable strings into account.