This document describes an older version of Celery (2.1). For the latest stable version please go here.

Task Decorators - celery.decorators

Decorators

celery.decorators.periodic_task(**options)

Task decorator to create a periodic task.

Example task, scheduling a task once every day:

from datetime import timedelta

@periodic_task(run_every=timedelta(days=1))
def cronjob(**kwargs):
    logger = cronjob.get_logger(**kwargs)
    logger.warn("Task running...")

celery.decorators.task(*args, **options)

Decorator to create a task class out of any callable.

Examples:

@task()
def refresh_feed(url):
    return Feed.objects.get(url=url).refresh()

With setting extra options and using retry.

@task(exchange="feeds")
def refresh_feed(url, **kwargs):
    try:
        return Feed.objects.get(url=url).refresh()
    except socket.error, exc:
        refresh_feed.retry(args=[url], kwargs=kwargs, exc=exc)

Calling the resulting task:

>>> refresh_feed("http://example.com/rss") # Regular
<Feed: http://example.com/rss>
>>> refresh_feed.delay("http://example.com/rss") # Async
<AsyncResult: 8998d0f4-da0b-4669-ba03-d5ab5ac6ad5d>