Move commands daily_cleanup, make-messages and compile-messages to django.core.management.commands

[Jannis Leidel]

Since having a fairly solid, pluggable django-admin command I prepared a patch which moves the heavy lifting to django.core.management and is fully backwards compatible with the standalone tools daily_cleanup.py, make-messages.py, compile-messages.py and unique-messages.py in django/bin.

This introduces four new commands:

messagesmake, messagescompile, messagesunique, cleanup

where the latter is the new name for daily_cleanup.py. Docs included.

[Jannis Leidel]

patch to move utilities in django/bin to django.core.management

[Malcolm Tredinnick]

Possibly worth it for make-messages and compile-messages (the reason in favour of it is that we need to rename those two programs anyway so that they can be installed in /usr/bin/ and using django-admin.py as the controller means we can handle settings more easily). Not needed for daily_cleanup, since that's very lightweight and this makes it less so. unique-messages.py isn't meant to be called directly, so that shouldn't be exposed.

[Jannis Leidel]

Ok, fair enough.. I'd like to point out, that the creation of command line programs can be automated during installation with setuptools' "console_scripts" entry_point. I described a simple example at ​http://jannisleidel.com/2007/11/using-django-with-setuptools/ if you are interested. Though I know that there is more about setuptools which should be discussed :)

I'd like to provide a patch during the sprint (later today) which adds app-loading from eggs using pkg_resources. I would be glad if this would be added, since my GSoC approach (#5465) isn't very satisfying.

[Malcolm Tredinnick]

At no point here have you explained why all this moving is needed. Setuptool has nothing to do with it; it's a completely orthogonal issue and not relevant here.

[Jannis Leidel]

Indeed, setuptools is not an issue here. Moving the code might be a good way to go on with the refactoring of command.core.management. I thought this could be another step towards a future "django" command line programm.

[Jacob]

Let's do this, but only for make-messages, compile-messages, and daily_cleanup (but I'd rename that to "django-admin cleanup"). unique-messages is an internal tool, and shouldn't be exposed in django-admin.

Make sure to document the new commands!

[Jannis Leidel]

Yeah, I'll work on it later today.

[Jannis Leidel]

second patch to move utilities in django/bin to django.core.management

[Jannis Leidel]

Ok, new patch (from mercurial clone) without unique-messages and docs (docs, manpage, bash_completion).

[Jannis Leidel]

Replying to jezdez:

Ok, new patch (from mercurial clone) without unique-messages and docs (docs, manpage, bash_completion).

I mean *with* documentation

[Chris Beaven]

Can someone do a normal patch on a fresh Django SVN and confirm each command works as expected?

[Jannis Leidel]

Already working on it :)

[Jannis Leidel]

normal patch with SVN on fresh checkout (r7140)

[Malcolm Tredinnick]

This doesn't seem to work. I applied the patch and tried to run bin/make-messages.py -l en and it complains about missing settings file. Similarly for django/bin/make-messages.py -l en and various places running django-admin.py messagesmake -l en.

Since there is no concept of a settings file for the subversion tree, this isn't really a replacement for existing functionality.

Also, can you rename messagesmake to makemessages and messagescompile to compilemessages for consistency with the existing names, please.

[Jannis Leidel]

makemessages and compileessages should now work in the svn root either by running django-admin.py * or bin/*.py without asking for DJANGO_SETTINGS_MODULE

[Jannis Leidel]

As with Jacob discussed this patch moves the i18n helper functions to their appropriate subcommands and also includes [7473].

[Jannis Leidel]

Added New in Django development version flags and notes about the old tools make-messages.py and compile-messages.py.

[Ramiro Morales]

Shouldn't (for consistency with the rest of the management infrastructure) all the sys.exit() calls from the django/core/management/commands/makemessages.py:make_messages() function be replaced by raising the [source:django/trunk/django/core/management/base.py CommandError exception]?

If so, this means that the backwards-compatibility make-messages script would also need to be be modified accordingly.

[Jannis Leidel]

Raising CommandError instead of hard sys.exit in django.core.management.commands.makemessages:make_messages()

[Jannis Leidel]

FYI, I changed it to "Ready for checkin" after the definite word by Jacob in IRC

[Marc Garcia]

According to ticket organization defined in ​http://code.djangoproject.com/wiki/VersionOneRoadmap#how-you-can-help 1.0 alpha tickets should be just features in the Must have (​http://code.djangoproject.com/wiki/VersionOneRoadmap#must-have-features) list.

Change to 1.0 beta if you can make this feature be added to May be features (​http://code.djangoproject.com/wiki/VersionOneRoadmap#maybe-features).

[Jannis Leidel]

I appreciate your care but this was already discussed in IRC with Jacob and others to be included in Django 1.0.

[Malcolm Tredinnick]

Good work. I've decided to actually remove the dual functionality from make-messages.py and compile-messages.py. Otherwise we'll be carrying around two ways to do the same thing forever. Instead both those executables now print an error message pointing the caller to the right command to run. I've updated the docs patch accordingly.

[Malcolm Tredinnick]

(In [7844]) Fixed #5522 -- Moved make-messages, compile-messages and daily-cleanup into django-admin.py.

They are now called "makemessages", "compilemessages" and "cleanup". This is
backwards incompatible for make-messages.py and compile-messages.py, although
the old executables still exist for now and print an error pointing the caller
to the right command to call.

This reduces the number of binaries and man pages Django needs to install.

Patch from Janis Leidel.

[Malcolm Tredinnick]

Community Announcement: if anybody notices errors in this change, please do not reopen this ticket. This ticket is about making the move, which has been done. Errors in the resulting code should have their own tickets so that we can track things easily.

[Jacob]

Milestone 1.0 beta deleted