Skip to main content

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

Project description

https://circleci.com/gh/mozilla/django-post-request-task.svg?style=svg

A celery 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 decorator directly:

from post_request_task.task import shared_task

@shared_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

By default, tests are run with whatever django version is installed. If you want to run tests for other versions use tox:

$ make testenv
$ tox -e 3.7-2.0.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.5.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

django_post_request_task-0.5-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-post-request-task-0.5.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.5

File hashes

Hashes for django-post-request-task-0.5.tar.gz
Algorithm Hash digest
SHA256 26c03b5d06eb1705b2438bb719575fac4aae7f34c32837480202acad556edb3c
MD5 8676643d4fff402273994eeb12687de2
BLAKE2b-256 9d5b460cca16a4cfaa2068a823fad46577b725211d30356827a83d3566f35cb9

See more details on using hashes here.

File details

Details for the file django_post_request_task-0.5-py3-none-any.whl.

File metadata

  • Download URL: django_post_request_task-0.5-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.5

File hashes

Hashes for django_post_request_task-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 91df3893c9551851cd10568ef3b2cf358bd87e8c65dce728c37196a8de34247c
MD5 40595affb8a89ef2549e9b5ab7382a4d
BLAKE2b-256 76d7fdc4123b55edb6cc86f4d8d132d5f10b69bad31b999c6ee9d94a8562f6f3

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