Skip to main content

A celery task class whose execution is delayed until after the request finishes

Project description

https://travis-ci.org/mozilla/django-post-request-task.svg?branch=master

A celery 3.x task class whose execution is delayed until after the request finishes, using request_started and request_finished signals from django and thread locals.

This is useful if your views are wrapped in transactions (as they should if you’re making database modifications in them), as you can end up triggering a celery task too soon before the transaction has been committed (or even trigger a task when the corresponding transaction has been rolled back).

By listening to the request_started and request_finished django signals, we can safely trigger a task after all transactions created from @atomic or ATOMIC_REQUESTS have been committed.

Usage

from celery import Celery
from post_request_task.task import PostRequestTask


app = Celery('myapp', task_cls=PostRequestTask)

@app.task
def my_task():
    # If .delay() is called on this task inside a django request-response
    # cycle it will be called once the request is finished, and not before.
    pass

Or, if you are using the task decorator directly:

from post_request_task.task import task

@task
def my_task():
    pass

That’s it. If the task is called from outside the django request-response cycle, then it will be triggered normally.

As a bonus feature, if the same task is called with the same argument several times during a request-response cycle, it will only be queued up once.

Running tests

$ make testenv
$ make test

Tests are run with Django 1.8.x by default. If you want to run tests for other versions use tox:

$ make testenv
$ tox -e 2.7-1.9.x # or any other environment defined in our tox.ini

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-post-request-task-0.2.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django-post-request-task-0.2.0.tar.gz.

File metadata

File hashes

Hashes for django-post-request-task-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7afe4c7418db8592a7b56391cbfe56a86008bc1b4622dd923573b6981ba1562c
MD5 818dec81b7eaa9f46ee04277cb9b47e9
BLAKE2b-256 fe10c06ec47af020b4ca3d8d340a5f93c50aaed5f27b6e2c15a203193be11ea3

See more details on using hashes here.

File details

Details for the file django_post_request_task-0.2.0-py2-none-any.whl.

File metadata

File hashes

Hashes for django_post_request_task-0.2.0-py2-none-any.whl
Algorithm Hash digest
SHA256 b761beed705c18d6ee85642049d07ca9d7f936e3392c6d56a58c36a39e5e9803
MD5 25f944938a0ef0fbcb44981f17e7ade5
BLAKE2b-256 82235f44e07dba8b4ec8293de2f6f881a4ec024bf529e2c9b95bbd60d186ce6f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page