- August 31, 2010
- 2 (after 2 ratings)
A quick-and-dirty, and extremely simple, decorator to turn a simple function into a management command.
This still requires you to have the management directory structure, but allows you to name your primary method whatever you want, and encapsulates the basic functionality of an argument-accepting management commmand.
The function's docstring will be used for the command's help text if the
help arg is not passed to the decorator.
from myapp.utils import command @command() def my_command(): print "Hello, world"
I'm not too familiar with the intricacies of decorators and management commands, so this could probably (most likely) be improved upon, but it's a start.
Update: I've taken this a bit farther and put my work up on bitbucket: https://bitbucket.org/eternicode/django-management-decorators/src
1 2 3 4 5 6 7 8 9 10 11 12 13 14
from django.core.management.base import BaseCommand def command(help=None, args=''): def _decorate(func): _args = args _help = help class Command(BaseCommand): help = _help if _help is not None else func.__doc__ args = _args def handle(self, *args, **kwargs): return func(*args, **kwargs) func.func_globals['Command'] = Command return func return _decorate
More like this
- Image compression before saving the new model / work with JPG, PNG by Schleidens 5 days, 5 hours ago
- Help text hyperlinks by sa2812 1 month ago
- Stuff by NixonDash 3 months, 1 week ago
- Add custom fields to the built-in Group model by jmoppel 5 months, 1 week ago
- Month / Year SelectDateWidget based on django SelectDateWidget by pierreben 8 months, 3 weeks ago
Well, some how (and I think it can be done) the decorator can introspect the function's positional arguments and keyword arguments, and then use those for the command's arguments and options, respectively. Then the only parameter needed for the decorator usage would be the help text.
gmandx, interesting idea. I've done some light reading around, and it looks like the functools module has some stuff that could do this.
Please login first before commenting.