rewrite celery docs, add example application #4968
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing Celery docs didn't fit particularly well with the application factory, or with modern Celery configuration, or with testing patterns. I've rewritten the docs from scratch to try to focus on the topics that matter for understanding Celery's model and how it fits with Flask. I've also added a full example showing how to use Celery and run tasks with JavaScript.
In particular, use
@shared_task
instead of@celery.task
. This way, tasks objects are created for the current Flask app. A Celery app is associated with the Flask app and configured from it each time the factory is called. This relies on Celery's "default app" concept.Based on what I figured out for these docs, I think it would be able to take this further and create a Flask extension that manages it for us and doesn't require
shared_task
or the default app, but that's outside the scope of these docs.closes #4837