django-tasks-pubsub 1.3.2__py3-none-any.whl

django_tasks_pubsub/__init__.py

@@ -0,0 +1,7 @@
+from .backend import PubSubBackend
+from .pubsub_task_decorator import pubsub_task
+
+__all__ = [
+    "PubSubBackend",
+    "pubsub_task",
+]

django_tasks_pubsub/backend.py

@@ -0,0 +1,110 @@
+import dataclasses
+import json
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Optional
+
+from django.conf import settings
+from django.tasks import Task
+from django.tasks.backends.base import BaseTaskBackend
+from django.tasks.base import TaskResult as BaseTaskResult, TaskResultStatus
+from django.utils import timezone
+from django.utils.crypto import get_random_string
+
+from django_tasks_pubsub.publisher import get_publisher
+from django_tasks_pubsub.publisher import publish
+from django_tasks_pubsub.pubsub_task_decorator import PubSubMetaData
+
+
+@dataclass(frozen=True)
+class TaskPayload:
+    backend: str
+    module_path: str
+    name: str
+    priority: int
+    queue_name: str
+    takes_context: bool
+    run_after: Optional[datetime] = None
+
+
+@dataclass(frozen=True)
+class Payload:
+    task: TaskPayload
+    task_id: str
+    enqueued_at: str
+    args: list
+    kwargs: dict
+
+
+class TaskResult(BaseTaskResult):
+    pass
+
+
+class PubSubBackend(BaseTaskBackend):
+    @staticmethod
+    def get_pubsub_metadata(task: Task) -> PubSubMetaData:
+        task_func = getattr(task, "func")
+
+        return getattr(task_func, "__pubsub_metadata", PubSubMetaData())
+
+    def get_topic_id(self, task: Task):
+        return (
+            self.get_pubsub_metadata(task=task).topic_id
+            or settings.PUBSUB_DEFAULT_TOPIC_ID
+        )
+
+    def get_topic_path(self, task: Task):
+        topic_id = self.get_topic_id(task)
+
+        publisher = get_publisher()
+
+        topic_path = publisher.topic_path(
+            settings.PUBSUB_PROJECT_ID,
+            topic_id,
+        )
+
+        return topic_path
+
+    def enqueue(self, task: Task, args, kwargs):
+        enqueued_at = timezone.now()
+        task_id = get_random_string(32)
+
+        payload: Payload = Payload(
+            task=TaskPayload(
+                backend=task.backend,
+                module_path=task.module_path,
+                name=task.name,
+                priority=task.priority,
+                queue_name=task.queue_name,
+                takes_context=task.takes_context,
+            ),
+            task_id=task_id,
+            enqueued_at=enqueued_at.isoformat(),
+            args=args,
+            kwargs=kwargs,
+        )
+        # Data to send to the queue.
+        data = json.dumps(
+            dataclasses.asdict(payload),
+        ).encode("utf-8")
+
+        topic_path = self.get_topic_path(
+            task,
+        )
+
+        publish(topic=topic_path, data=data)
+
+        return TaskResult(
+            id=task_id,
+            task=task,
+            enqueued_at=enqueued_at,
+            started_at=None,
+            finished_at=None,
+            status=TaskResultStatus.READY,
+            args=args,
+            kwargs=kwargs,
+            last_attempted_at=None,
+            backend=task.backend,
+            errors=[],
+            worker_ids=[],
+        )

django_tasks_pubsub/dispatcher.py

@@ -0,0 +1,54 @@
+import importlib
+from datetime import datetime
+
+from django.tasks import TaskContext
+from django.tasks.base import TaskResultStatus
+
+from django_tasks_pubsub.backend import Payload, TaskResult
+
+
+def dispatch(payload: Payload):
+    module_path = payload.task.module_path
+    task_name = payload.task.name
+
+    try:
+        module = importlib.import_module(module_path)
+    except ModuleNotFoundError:
+        module_path, task_name_from_path = module_path.rsplit(".", 1)
+        module = importlib.import_module(module_path)
+        task_name = task_name or task_name_from_path
+
+    # This is the decorated task function, decoration makes it a Task object
+    task = getattr(module, task_name)
+
+    # Actual task function that we can call
+    task_function = getattr(task, "func", task)
+
+    if payload.task.takes_context:
+        context = TaskContext(
+            task_result=TaskResult(
+                id=payload.task_id,
+                task=task,
+                enqueued_at=datetime.fromisoformat(payload.enqueued_at),
+                started_at=None,
+                finished_at=None,
+                status=TaskResultStatus.READY,
+                args=payload.args,
+                kwargs=payload.kwargs,
+                last_attempted_at=None,
+                backend=payload.task.backend,
+                errors=[],
+                worker_ids=[],
+            ),
+        )
+        task_function(
+            context,
+            *payload.args,
+            **payload.kwargs,
+        )
+        return
+
+    task_function(
+        *payload.args,
+        **payload.kwargs,
+    )

django_tasks_pubsub/publisher.py

@@ -0,0 +1,14 @@
+from google.cloud import pubsub_v1
+
+_publisher: pubsub_v1.PublisherClient | None = None
+
+
+def get_publisher():
+    global _publisher
+    if _publisher is None:
+        _publisher = pubsub_v1.PublisherClient()
+    return _publisher
+
+
+def publish(topic: str, data: bytes):
+    get_publisher().publish(topic=topic, data=data)

django_tasks_pubsub/pubsub_task_decorator.py

@@ -0,0 +1,19 @@
+from collections.abc import Callable
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True, slots=True, kw_only=True)
+class PubSubMetaData:
+    topic_id: str | None = None
+
+
+def pubsub_task(topic_id: str | None = None):
+    def wrapper(func: Callable):
+        setattr(
+            func,
+            "__pubsub_metadata",
+            PubSubMetaData(topic_id=topic_id),
+        )
+        return func
+
+    return wrapper

django_tasks_pubsub/views.py

@@ -0,0 +1,71 @@
+import base64
+import json
+import logging
+
+from django.http import HttpResponse
+from django.utils.decorators import method_decorator
+from django.views import View
+from django.views.decorators.csrf import csrf_exempt
+
+from django_tasks_pubsub.dispatcher import dispatch
+from django_tasks_pubsub.backend import Payload, TaskPayload
+
+
+@method_decorator(csrf_exempt, name="dispatch")
+class PubSubPushView(View):
+    """
+    Receives Pub/Sub push messages and dispatches them to TASK_DISPATCH_FUNCTION.
+
+    Pub/Sub push format:
+    {
+      "message": {
+        "data": "<base64-encoded JSON payload>",
+        "messageId": "...",
+        "publishTime": "..."
+      },
+      "subscription": "projects/.../subscriptions/..."
+    }
+
+    Returns 204 on success (Pub/Sub ACKs on any 2xx).
+    Returns 500 on task failure (Pub/Sub will retry).
+    Returns 400 on malformed message (no retry).
+    """
+
+    def post(self, request):
+        try:
+            envelope = json.loads(request.body)
+        except (json.JSONDecodeError, ValueError):
+            logging.error("PubSubPushView: invalid JSON body")
+            return HttpResponse(status=400)
+
+        encoded_data = envelope.get("message", {}).get("data", "")
+        if not encoded_data:
+            logging.error("PubSubPushView: missing message.data")
+            return HttpResponse(status=400)
+
+        try:
+            payload_dict = json.loads(base64.b64decode(encoded_data))
+        except Exception as exc:
+            logging.error(f"PubSubPushView: failed to decode message: {exc}")
+            return HttpResponse(status=400)
+
+        try:
+            payload = Payload(
+                task=TaskPayload(
+                    **payload_dict.pop("task"),
+                ),
+                **payload_dict,
+            )
+        except Exception as exc:
+            logging.exception(f"PubSubPushView: failed to create payload: {exc}")
+            return HttpResponse(status=400)
+
+        logging.info(f"PubSubPushView: dispatching task_type={payload.task.name!r}")
+
+        try:
+            dispatch(payload=payload)
+        except BaseException as exc:
+            logging.exception(f"PubSubPushView: task failed: {payload!r} error={exc}")
+            return HttpResponse(status=500)
+
+        return HttpResponse(status=204)

django_tasks_pubsub-1.3.2.dist-info/METADATA

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: django-tasks-pubsub
+Version: 1.3.2
+Summary: Django tasks backend for Google Cloud Pub/Sub
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: django>=6.0.5
+Requires-Dist: google-cloud-pubsub>=2.38.0
+
+hello, world.

django_tasks_pubsub-1.3.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+django_tasks_pubsub/__init__.py,sha256=ahTeEplIae_GaOfv7P4BbOaOmvGdz6svdxhjXlA2oac,137
+django_tasks_pubsub/backend.py,sha256=y3opKnxoWDjgn9DVvvGoG9Nh7p-LuM0UpjxInhLryMI,2868
+django_tasks_pubsub/dispatcher.py,sha256=JcXR7_rHP0y0kFpv31ZNxrU7lKHl6Gb_kVr5c0zFyys,1583
+django_tasks_pubsub/publisher.py,sha256=BFRP_GLSnOanXOBTjPfiG5WQlHyIy-9W0peyYrbT73U,323
+django_tasks_pubsub/pubsub_task_decorator.py,sha256=fnaDEjcPssBkfs2AEmNyfBul5KfANn2EfQt9RrXWUwk,423
+django_tasks_pubsub/views.py,sha256=Auhz_I30RGwNAz_nv4ZMHGoC9WAraFCbpTnB44bbCmY,2283
+django_tasks_pubsub-1.3.2.dist-info/METADATA,sha256=wvc_nDJRbraFDVuttO2uxDf2csbernvbRSMEq5CluZg,269
+django_tasks_pubsub-1.3.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+django_tasks_pubsub-1.3.2.dist-info/top_level.txt,sha256=pPege62SzuwnEUOVf67AYjKqoPZJAZqDn5Q0R3DkOCM,20
+django_tasks_pubsub-1.3.2.dist-info/RECORD,,

django_tasks_pubsub-1.3.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_tasks_pubsub-1.3.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+django_tasks_pubsub