Celery: use an internal namespace to store build task's data #8874
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.
Use a
Task.data
(readthedocs.projects.task.builds.TaskData
object) to storeall the data the task needs to work instead of storing it directly using
self.
.This is to allow us a simpler way to perform a clean before (and/or after)
starting the execution of a new task and avoid potentially sharing state with a
previous task executed that may not be able to perform the cleanup.
The only thing we need to keep in mind is that when modifying these Celery
tasks, we always have to add any new value inside the
self.data.<my-new-attribute>
and not directlyself.<my-new-attribute>
toavoid this problem. In the future, we could implement this protection at a code
level if we want to avoid this mistake.
See #8815 (comment)
See https://docs.celeryproject.org/en/master/userguide/tasks.html#instantiation