Reference
CeleryTaskModel
Attributes
property
async_result: AsyncResult | None
Returns the AsyncResult object of the current instance
class-attribute
instance-attribute
celery_task_queue: str = CELERY_TASK_DEFAULT_QUEUE
Name of the queue this task connected to.
Only need to be specified if different from settings.CELERY_TASK_DEFAULT_QUEUE
class-attribute
instance-attribute
celery_task_revoked_queue: str = CELERY_TASK_REVOKED_QUEUE
Name of the queue where revoked tasks are stored.
Only need to be specified if different from settings.CELERY_TASK_REVOKED_QUEUE
class-attribute
instance-attribute
default_celery_task_name: str = ''
FQN of the task processing this Model's instances
property
queue_entry: dict[str, Any]
Returns the queue entry of the current instance
property
queue_position: int
Returns the position of the current task in the queue.
Returns:
| Type | Description |
|---|---|
int
|
int task position in queue |
property
task_info: dict[str, Any]
Returns the task meta information of the current instance
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dictionary with task information |
property
task_status: str
Returns the task status querying Celery API
Functions
classmethod
celery_queue_info() -> dict[str, int]
Returns information about the Queue
Returns:
| Type | Description |
|---|---|
dict[str, int]
|
Dictionary with size,pendig, canceled, revoked tasks |
is_queued() -> bool
Check if the job is queued
is_terminated() -> bool
Check if the job is queued
queue(use_version: bool = True) -> str | None
Queue the record processing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_version
|
bool
|
if True the task fails if the record is changed after it has been queued. |
True
|
task_handler() -> Callable[[Any], Any]
Return the task assigned to this model
terminate(wait=False, timeout=None) -> str
Revoke the task. Does not need Running workers