This document describes an older version of Celery (2.2). For the latest stable version please go here.
Pending task result using the default backend.
Parameters: | task_id – The tasks uuid. |
---|
Task result store backend to use.
Base class for pending result, supports custom task result backend.
Parameters: |
---|
Error raised for timeouts.
The task result backend to use.
Returns True if the task failed by exception.
Forget about (and possibly remove the result of) this task.
Wait until task is ready, and return its result.
Warning
Waiting for subtasks may lead to deadlocks. Please read Avoid launching synchronous subtasks.
Parameters: |
|
---|---|
Raises celery.exceptions.TimeoutError: | |
if timeout is not None and the result does not arrive within timeout seconds. |
If the remote call raised an exception then that exception will be re-raised.
Returns True if the task has been executed.
If the task is still running, pending, or is waiting for retry then False is returned.
When the task has been executed, this contains the return value. If the task raised an exception, this will be the exception instance.
Send revoke signal to all workers.
Any worker receiving the task, or having reserved the task, must ignore it.
The tasks current state.
Possible values includes:
PENDING
The task is waiting for execution.STARTED
The task has been started.RETRY
The task is to be retried, possibly because of failure.FAILURE
The task raised an exception, or has been retried more times than its limit. The result attribute contains the exception raised.SUCCESS
The task executed successfully. The result attribute contains the resulting value.
Returns True if the task executed successfully.
The task uuid.
Get the traceback of a failed task.
Result that we know has already been executed.
The operation timed out.
Wait until the task has been executed and return its result.
Returns True if the task has been executed.
The tasks return value
The tasks state.
Returns True if the task executed without failure.
The traceback if the task failed.
Working with TaskSet results.
An instance of this class is returned by TaskSet‘s apply_async(). It enables inspection of the subtasks state and return values as a single entity.
Parameters: |
|
---|
Task completion count.
Returns: | the number of tasks completed. |
---|
Did the taskset fail?
Returns: | True if any of the tasks in the taskset failed. (i.e., raised an exception) |
---|
Forget about (and possible remove the result of) all the tasks in this taskset.
Iterate over the return values of the tasks as they finish one by one.
Raises: | The exception if any of the tasks raised an exception. |
---|
Taskset subtask iterator.
Returns: | an iterator for iterating over the tasksets AsyncResult objects. |
---|
Gathers the results of all tasks in the taskset, and returns a list ordered by the order of the set.
Note
This can be an expensive operation for result store backends that must resort to polling (e.g. database).
You should consider using join_native() if your backend supports it.
Warning
Waiting for subtasks may lead to deadlocks. Please see Avoid launching synchronous subtasks.
Parameters: |
|
---|---|
Raises celery.exceptions.TimeoutError: | |
if timeout is not None and the operation takes longer than timeout seconds. |
Backend optimized version of join().
New in version 2.2.
Note that this does not support collecting the results for different task types using different backends.
This is currently only supported by the AMQP result backend.
Is the task ready?
Returns: | True if all of the tasks in the taskset has been executed. |
---|
Restore previously saved taskset result.
Revoke all subtasks.
Save taskset result for later retrieval using restore().
Example:
>>> result.save()
>>> result = TaskSetResult.restore(taskset_id)
A list of AsyncResult instances for all of the subtasks.
Was the taskset successful?
Returns: | True if all of the tasks in the taskset finished successfully (i.e. did not raise an exception). |
---|
The UUID of the taskset.
Total number of subtasks in the set.
Is the taskset waiting?
Returns: | True if any of the tasks in the taskset is still waiting for execution. |
---|