1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
|
from collections.abc import Callable
from dataclasses import dataclass, field, replace
from datetime import datetime
from inspect import isclass, iscoroutinefunction
from typing import (
TYPE_CHECKING,
Any,
Concatenate,
Generic,
Literal,
TypeVar,
cast,
overload,
)
from asgiref.sync import async_to_sync, sync_to_async
from django.db.models.enums import TextChoices
from django.utils.module_loading import import_string
from django.utils.translation import pgettext_lazy
from django.utils.version import PY311
from typing_extensions import ParamSpec, Self
from .exceptions import TaskResultMismatch
from .utils import (
get_module_path,
normalize_json,
)
if TYPE_CHECKING:
from .backends.base import BaseTaskBackend
DEFAULT_TASK_BACKEND_ALIAS = "default"
DEFAULT_TASK_QUEUE_NAME = "default"
TASK_MIN_PRIORITY = -100
TASK_MAX_PRIORITY = 100
DEFAULT_TASK_PRIORITY = 0
TASK_REFRESH_ATTRS = {
"errors",
"_return_value",
"finished_at",
"started_at",
"last_attempted_at",
"status",
"enqueued_at",
"worker_ids",
}
class TaskResultStatus(TextChoices):
READY = ("READY", pgettext_lazy("Task", "Ready"))
"""The Task has just been enqueued, or is ready to be executed again."""
RUNNING = ("RUNNING", pgettext_lazy("Task", "Running"))
"""The Task is currently running."""
FAILED = ("FAILED", pgettext_lazy("Task", "Failed"))
"""The Task raised an exception during execution, or was unable to start."""
SUCCESSFUL = ("SUCCESSFUL", pgettext_lazy("Task", "Successful"))
"""The Task has finished running successfully."""
T = TypeVar("T")
P = ParamSpec("P")
@dataclass(frozen=True, slots=PY311, kw_only=True) # type: ignore[literal-required]
class Task(Generic[P, T]):
func: Callable[P, T]
"""The Task function"""
priority: int = DEFAULT_TASK_PRIORITY
"""The Task's priority"""
backend: str = DEFAULT_TASK_BACKEND_ALIAS
"""The name of the backend the Task will run on"""
queue_name: str = DEFAULT_TASK_QUEUE_NAME
"""The name of the queue the Task will run on"""
run_after: datetime | None = None
"""The earliest this Task will run"""
takes_context: bool = False
"""
Whether the Task receives the Task context when executed.
"""
def __post_init__(self) -> None:
self.get_backend().validate_task(self)
@property
def name(self) -> str:
"""
An identifier for the task
"""
return self.func.__name__
def using(
self,
*,
priority: int | None = None,
queue_name: str | None = None,
run_after: datetime | None = None,
backend: str | None = None,
) -> Self:
"""
Create a new Task with modified defaults.
"""
changes: dict[str, Any] = {}
if priority is not None:
changes["priority"] = priority
if queue_name is not None:
changes["queue_name"] = queue_name
if run_after is not None:
changes["run_after"] = run_after
if backend is not None:
changes["backend"] = backend
return replace(self, **changes)
def enqueue(self, *args: P.args, **kwargs: P.kwargs) -> "TaskResult[T]":
"""
Queue up the Task to be executed.
"""
return self.get_backend().enqueue(self, args, kwargs)
async def aenqueue(self, *args: P.args, **kwargs: P.kwargs) -> "TaskResult[T]":
"""
Queue up the Task to be executed.
"""
return await self.get_backend().aenqueue(self, args, kwargs)
def get_result(self, result_id: str) -> "TaskResult[T]":
"""
Retrieve the result for a Task of this type by id if it exists,
otherwise raise ResultDoesNotExist.
"""
result = self.get_backend().get_result(result_id)
if result.task.func != self.func:
raise TaskResultMismatch(
f"Task does not match (received {result.task.module_path!r})"
)
return result
async def aget_result(self, result_id: str) -> "TaskResult[T]":
"""See get_result()."""
result = await self.get_backend().aget_result(result_id)
if result.task.func != self.func:
raise TaskResultMismatch(
f"Task does not match (received {result.task.module_path!r})"
)
return result
def call(self, *args: P.args, **kwargs: P.kwargs) -> T:
if iscoroutinefunction(self.func):
return async_to_sync(self.func)(*args, **kwargs) # type:ignore[no-any-return]
return self.func(*args, **kwargs)
async def acall(self, *args: P.args, **kwargs: P.kwargs) -> T:
if iscoroutinefunction(self.func):
return await self.func(*args, **kwargs) # type:ignore[no-any-return]
return await sync_to_async(self.func)(*args, **kwargs)
def get_backend(self) -> "BaseTaskBackend":
from . import task_backends
return task_backends[self.backend]
@property
def module_path(self) -> str:
return get_module_path(self.func)
# Bare decorator usage
# e.g. @task
@overload
def task(function: Callable[P, T], **kwargs: Any) -> Task[P, T]: ...
# Decorator with arguments
# e.g. @task() or @task(priority=1, ...)
@overload
def task(
*,
priority: int = DEFAULT_TASK_PRIORITY,
queue_name: str = DEFAULT_TASK_QUEUE_NAME,
backend: str = DEFAULT_TASK_BACKEND_ALIAS,
takes_context: Literal[False] = False,
**kwargs: Any,
) -> Callable[[Callable[P, T]], Task[P, T]]: ...
# Decorator with context and arguments
# e.g. @task(takes_context=True, ...)
@overload
def task(
*,
priority: int = DEFAULT_TASK_PRIORITY,
queue_name: str = DEFAULT_TASK_QUEUE_NAME,
backend: str = DEFAULT_TASK_BACKEND_ALIAS,
takes_context: Literal[True],
**kwargs: Any,
) -> Callable[[Callable[Concatenate["TaskContext", P], T]], Task[P, T]]: ...
# Implementation
def task(
function: Callable[P, T] | None = None,
*,
priority: int = DEFAULT_TASK_PRIORITY,
queue_name: str = DEFAULT_TASK_QUEUE_NAME,
backend: str = DEFAULT_TASK_BACKEND_ALIAS,
takes_context: bool = False,
**kwargs: Any,
) -> (
Task[P, T]
| Callable[[Callable[P, T]], Task[P, T]]
| Callable[[Callable[Concatenate["TaskContext", P], T]], Task[P, T]]
):
"""
A decorator used to create a task.
"""
from . import task_backends
def wrapper(f: Callable[P, T]) -> Task[P, T]:
return task_backends[backend].task_class(
priority=priority,
func=f,
queue_name=queue_name,
backend=backend,
takes_context=takes_context,
run_after=None,
**kwargs,
)
if function:
return wrapper(function)
return wrapper
@dataclass(frozen=True, slots=PY311, kw_only=True) # type: ignore[literal-required]
class TaskError:
exception_class_path: str
traceback: str
@property
def exception_class(self) -> type[BaseException]:
# Lazy resolve the exception class
exception_class = import_string(self.exception_class_path)
if not isclass(exception_class) or not issubclass(
exception_class, BaseException
):
raise ValueError(
f"{self.exception_class_path!r} does not reference a valid exception."
)
return exception_class
@dataclass(frozen=True, slots=PY311, kw_only=True) # type: ignore[literal-required]
class TaskResult(Generic[T]):
task: Task
"""Task for which this is a result"""
id: str
"""A unique identifier for the task result"""
status: TaskResultStatus
"""Status of the running Task"""
enqueued_at: datetime | None
"""Time this Task was enqueued"""
started_at: datetime | None
"""Time this Task was started"""
finished_at: datetime | None
"""Time this Task was finished"""
last_attempted_at: datetime | None
"""Time this Task was last attempted to be run"""
args: list
"""The arguments to pass to the task function"""
kwargs: dict[str, Any]
"""The keyword arguments to pass to the task function"""
backend: str
"""The name of the backend the task is run with"""
errors: list[TaskError]
"""Errors raised when running the task"""
worker_ids: list[str]
"""The workers which have processed the task"""
_return_value: T | None = field(init=False, default=None)
def __post_init__(self) -> None:
object.__setattr__(self, "args", normalize_json(self.args))
object.__setattr__(self, "kwargs", normalize_json(self.kwargs))
@property
def return_value(self) -> T | None:
"""
The return value of the task.
If the task didn't succeed, an exception is raised.
This is to distinguish against the task returning None.
"""
if self.status == TaskResultStatus.SUCCESSFUL:
return cast(T, self._return_value)
elif self.status == TaskResultStatus.FAILED:
raise ValueError("Task failed")
else:
raise ValueError("Task has not finished yet")
@property
def is_finished(self) -> bool:
"""Has the task finished?"""
return self.status in {TaskResultStatus.FAILED, TaskResultStatus.SUCCESSFUL}
@property
def attempts(self) -> int:
return len(self.worker_ids)
def refresh(self) -> None:
"""
Reload the cached task data from the task store
"""
refreshed_task = self.task.get_backend().get_result(self.id)
for attr in TASK_REFRESH_ATTRS:
object.__setattr__(self, attr, getattr(refreshed_task, attr))
async def arefresh(self) -> None:
"""
Reload the cached task data from the task store
"""
refreshed_task = await self.task.get_backend().aget_result(self.id)
for attr in TASK_REFRESH_ATTRS:
object.__setattr__(self, attr, getattr(refreshed_task, attr))
@dataclass(frozen=True, slots=PY311, kw_only=True) # type: ignore[literal-required]
class TaskContext:
task_result: TaskResult
@property
def attempt(self) -> int:
return self.task_result.attempts
|