94

I'm using celery and django-celery. I have defined a periodic task that I'd like to test. Is it possible to run the periodic task from the shell manually so that I view the console output?

Mridang Agarwalla
  • 43,201
  • 71
  • 221
  • 382

3 Answers3

135

Have you tried just running the task from the Django shell? You can use the .apply method of a task to ensure that it is run eagerly and locally.

Assuming the task is called my_task in Django app myapp in a tasks submodule:

$ python manage.py shell
>>> from myapp.tasks import my_task
>>> eager_result = my_task.apply()

The result instance has the same API as the usual AsyncResult type, except that the result is always evaluated eagerly and locally and the .apply() method will block until the task is run to completion.

Platinum Azure
  • 45,269
  • 12
  • 110
  • 134
  • How can I do the same for pyramid project? The directory structure will be like: /myproject=> celeryconfig.py, setup.py, development.py, /views/celerytasks=> mycelerytask.py .Now here I want to run 'mycelerytask.py'(which is periodic task) manually from command line. Can you help? – Workonphp Nov 18 '13 at 14:30
  • @Workonphp I'm not familiar with Pyramid, unfortunately, so I don't know how Celery integrates with Pyramid at all. (Note that my solution above is Django-specific, requiring the `manage.py` script Django generates in all Django project directories.) Sorry. – Platinum Azure Nov 18 '13 at 16:12
40

If you means just trigger a task when the condition is not satisfied, for example, the periodic time not meet. You can do it in two steps.

1.Get your task id.

You can do it by typing.

celery inspect registered

You will see something like app.tasks.update_something. If nothing, it is probably that celery was not started. Just run it.

2.Run the task with celery call

celery call app.tasks.update_something

For more details, just type 

celery --help
celery inspect --help
celery call --help
W.Perrin
  • 4,217
  • 32
  • 31
  • 2
    it also supports args and kwargs $ celery -A yourapp call app.tasks.update_something --kwargs='{"key": value,...} – AlonS Jul 15 '19 at 09:37
  • 5
    This is very helpful, but missing a parenthesis at the end. Corrected: `celery -A yourapp call app.tasks.update_something --kwargs='{"key": value,...}'` – Erik Kalkoken Sep 13 '19 at 12:09
  • 3
    Although `inspect` is great, unfortunately it is only available for "RabbitMQ (AMQP) and Redis transports." (not others like `filesystem` for instance) – ‌‌R‌‌‌. Apr 27 '20 at 01:41
11

I think you'll need to open two shells: one for executing tasks from the Python/Django shell, and one for running celery worker (python manage.py celery worker). And as the previous answer said, you can run tasks using apply() or apply_async()

I've edited the answer so you're not using a deprecated command.

darkphoenix
  • 2,147
  • 3
  • 13
  • 14