django-database-task 0.2.0__tar.gz → 0.2.2__tar.gz

{django_database_task-0.2.0/django_database_task.egg-info → django_database_task-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-database-task
-Version: 0.2.0
+Version: 0.2.2
 Summary: A database-backed task queue backend for Django 6.0's built-in task framework
 Author-email: Shinya Okano <tokibito@gmail.com>
 Maintainer-email: Shinya Okano <tokibito@gmail.com>
@@ -36,6 +36,11 @@ Dynamic: license-file
 
 # django-database-task
 
+[![CI](https://github.com/tokibito/django-database-task/actions/workflows/ci.yml/badge.svg)](https://github.com/tokibito/django-database-task/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/django-database-task.svg)](https://badge.fury.io/py/django-database-task)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-database-task.svg)](https://pypi.org/project/django-database-task/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 A database-backed task queue backend for Django 6.0's built-in task framework.
 
 ## Features
@@ -607,21 +612,68 @@ pip install django-database-task[cloudtasks]
 TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
-        "OPTIONS": {
-            "CLOUD_TASKS_QUEUE": "default",  # Only required setting
-        },
+        "QUEUES": [],  # Allow all queue names
     },
 }
 ```
 
-Project ID, location, and handler URL are auto-detected from GAE/Cloud Run environment variables.
+Project ID, location, and handler URL are auto-detected from GAE/Cloud Run environment.
 
-### How It Works
+**Important**: Set `QUEUES: []` to allow any queue name, or list the queues you use:
+```python
+"QUEUES": ["default", "emails", "batch"],  # Only these queues allowed
+```
+
+The Cloud Tasks queue name is determined by the task's `queue_name` attribute:
+
+```python
+@task  # Uses "default" queue
+def normal_task():
+    pass
+
+@task(queue="batch")  # Uses "batch" queue
+def batch_task():
+    pass
 
+@task(queue="high-priority")  # Uses "high-priority" queue
+def urgent_task():
+    pass
 ```
-1. App enqueues task → Task saved to database + Cloud Task created
-2. Cloud Task triggers HTTP request → /tasks/execute/<task_id>/
-3. Handler retrieves task from database and executes it
+
+This allows you to configure different rate limits and concurrency settings per queue in Cloud Tasks.
+
+### How It Works
+
+```mermaid
+sequenceDiagram
+    participant App as Application
+    participant Backend as CloudTasksDatabaseBackend
+    participant DB as Database
+    participant CT as Cloud Tasks
+    participant Handler as /tasks/execute/
+
+    Note over App,Handler: Task Enqueue
+    App->>Backend: task.enqueue(args, kwargs)
+    Backend->>DB: INSERT task (status=READY)
+    DB-->>Backend: Task ID
+    Backend->>CT: Create Cloud Task (task_id only)
+    CT-->>Backend: OK
+    Backend-->>App: TaskResult (id, status=READY)
+
+    Note over App,Handler: Task Execution (triggered by Cloud Tasks)
+    CT->>Handler: POST /tasks/execute/<task_id>/<br/>(with OIDC token if configured)
+    Handler->>Handler: Verify OIDC token (optional)
+    Handler->>DB: SELECT task by ID
+    DB-->>Handler: Task record
+    Handler->>DB: UPDATE status=RUNNING
+    Handler->>Handler: Execute task function
+    alt Success
+        Handler->>DB: UPDATE status=SUCCESSFUL
+        Handler-->>CT: HTTP 200
+    else Failure
+        Handler->>DB: UPDATE status=FAILED
+        Handler-->>CT: HTTP 500 (triggers retry)
+    end
 ```
 
 The Cloud Task only contains the task ID. All task parameters are stored in the database, ensuring:
@@ -636,10 +688,9 @@ TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
         "OPTIONS": {
-            # Required
-            "CLOUD_TASKS_QUEUE": "default",
+            # All settings are optional - auto-detected from environment
 
-            # Auto-detected (override if needed)
+            # Override auto-detection if needed
             # "CLOUD_TASKS_PROJECT": "my-project",
             # "CLOUD_TASKS_LOCATION": "asia-northeast1",
             # "TASK_HANDLER_URL": "https://myapp.example.com/tasks/execute/{task_id}/",
@@ -655,11 +706,12 @@ TASKS = {
 
 ### Auto-Detection
 
-| Setting | Environment Variable | Description |
-|---------|---------------------|-------------|
-| Project | `GOOGLE_CLOUD_PROJECT` | GCP project ID |
-| Location | `CLOUD_RUN_REGION` / `GAE_REGION` | Cloud Tasks region |
+| Setting | Detection Method | Description |
+|---------|------------------|-------------|
+| Project | `GOOGLE_CLOUD_PROJECT` env var | GCP project ID |
+| Location | `CLOUD_RUN_REGION` env var, or metadata server | Cloud Tasks region |
 | Handler URL | Built from `K_SERVICE`, `GAE_SERVICE`, `GAE_VERSION` | Task execution endpoint |
+| Queue name | Task's `queue_name` attribute | Defaults to "default" |
 
 ### OIDC Authentication
 
@@ -670,8 +722,8 @@ When `OIDC_SERVICE_ACCOUNT_EMAIL` is configured, Cloud Tasks will send OIDC toke
 TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
+        "QUEUES": [],  # Allow all queue names
         "OPTIONS": {
-            "CLOUD_TASKS_QUEUE": "default",
             "OIDC_SERVICE_ACCOUNT_EMAIL": "my-sa@project.iam.gserviceaccount.com",
             # OIDC_AUDIENCE is auto-detected from handler URL if not set
         },

{django_database_task-0.2.0 → django_database_task-0.2.2}/README.md

@@ -1,5 +1,10 @@
 # django-database-task
 
+[![CI](https://github.com/tokibito/django-database-task/actions/workflows/ci.yml/badge.svg)](https://github.com/tokibito/django-database-task/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/django-database-task.svg)](https://badge.fury.io/py/django-database-task)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-database-task.svg)](https://pypi.org/project/django-database-task/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 A database-backed task queue backend for Django 6.0's built-in task framework.
 
 ## Features
@@ -571,21 +576,68 @@ pip install django-database-task[cloudtasks]
 TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
-        "OPTIONS": {
-            "CLOUD_TASKS_QUEUE": "default",  # Only required setting
-        },
+        "QUEUES": [],  # Allow all queue names
     },
 }
 ```
 
-Project ID, location, and handler URL are auto-detected from GAE/Cloud Run environment variables.
+Project ID, location, and handler URL are auto-detected from GAE/Cloud Run environment.
 
-### How It Works
+**Important**: Set `QUEUES: []` to allow any queue name, or list the queues you use:
+```python
+"QUEUES": ["default", "emails", "batch"],  # Only these queues allowed
+```
+
+The Cloud Tasks queue name is determined by the task's `queue_name` attribute:
+
+```python
+@task  # Uses "default" queue
+def normal_task():
+    pass
+
+@task(queue="batch")  # Uses "batch" queue
+def batch_task():
+    pass
 
+@task(queue="high-priority")  # Uses "high-priority" queue
+def urgent_task():
+    pass
 ```
-1. App enqueues task → Task saved to database + Cloud Task created
-2. Cloud Task triggers HTTP request → /tasks/execute/<task_id>/
-3. Handler retrieves task from database and executes it
+
+This allows you to configure different rate limits and concurrency settings per queue in Cloud Tasks.
+
+### How It Works
+
+```mermaid
+sequenceDiagram
+    participant App as Application
+    participant Backend as CloudTasksDatabaseBackend
+    participant DB as Database
+    participant CT as Cloud Tasks
+    participant Handler as /tasks/execute/
+
+    Note over App,Handler: Task Enqueue
+    App->>Backend: task.enqueue(args, kwargs)
+    Backend->>DB: INSERT task (status=READY)
+    DB-->>Backend: Task ID
+    Backend->>CT: Create Cloud Task (task_id only)
+    CT-->>Backend: OK
+    Backend-->>App: TaskResult (id, status=READY)
+
+    Note over App,Handler: Task Execution (triggered by Cloud Tasks)
+    CT->>Handler: POST /tasks/execute/<task_id>/<br/>(with OIDC token if configured)
+    Handler->>Handler: Verify OIDC token (optional)
+    Handler->>DB: SELECT task by ID
+    DB-->>Handler: Task record
+    Handler->>DB: UPDATE status=RUNNING
+    Handler->>Handler: Execute task function
+    alt Success
+        Handler->>DB: UPDATE status=SUCCESSFUL
+        Handler-->>CT: HTTP 200
+    else Failure
+        Handler->>DB: UPDATE status=FAILED
+        Handler-->>CT: HTTP 500 (triggers retry)
+    end
 ```
 
 The Cloud Task only contains the task ID. All task parameters are stored in the database, ensuring:
@@ -600,10 +652,9 @@ TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
         "OPTIONS": {
-            # Required
-            "CLOUD_TASKS_QUEUE": "default",
+            # All settings are optional - auto-detected from environment
 
-            # Auto-detected (override if needed)
+            # Override auto-detection if needed
             # "CLOUD_TASKS_PROJECT": "my-project",
             # "CLOUD_TASKS_LOCATION": "asia-northeast1",
             # "TASK_HANDLER_URL": "https://myapp.example.com/tasks/execute/{task_id}/",
@@ -619,11 +670,12 @@ TASKS = {
 
 ### Auto-Detection
 
-| Setting | Environment Variable | Description |
-|---------|---------------------|-------------|
-| Project | `GOOGLE_CLOUD_PROJECT` | GCP project ID |
-| Location | `CLOUD_RUN_REGION` / `GAE_REGION` | Cloud Tasks region |
+| Setting | Detection Method | Description |
+|---------|------------------|-------------|
+| Project | `GOOGLE_CLOUD_PROJECT` env var | GCP project ID |
+| Location | `CLOUD_RUN_REGION` env var, or metadata server | Cloud Tasks region |
 | Handler URL | Built from `K_SERVICE`, `GAE_SERVICE`, `GAE_VERSION` | Task execution endpoint |
+| Queue name | Task's `queue_name` attribute | Defaults to "default" |
 
 ### OIDC Authentication
 
@@ -634,8 +686,8 @@ When `OIDC_SERVICE_ACCOUNT_EMAIL` is configured, Cloud Tasks will send OIDC toke
 TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
+        "QUEUES": [],  # Allow all queue names
         "OPTIONS": {
-            "CLOUD_TASKS_QUEUE": "default",
             "OIDC_SERVICE_ACCOUNT_EMAIL": "my-sa@project.iam.gserviceaccount.com",
             # OIDC_AUDIENCE is auto-detected from handler URL if not set
         },

{django_database_task-0.2.0 → django_database_task-0.2.2}/django_database_task/__init__.py

@@ -2,7 +2,7 @@
 django-database-task: A database-backed task queue backend for Django 6.0's task framework.
 """
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 
 def __getattr__(name):

{django_database_task-0.2.0 → django_database_task-0.2.2}/django_database_task/backends.py

@@ -169,15 +169,19 @@ class DatabaseTaskBackend(BaseTaskBackend):
             args = db_task.args_json
             kwargs = db_task.kwargs_json.copy()
 
+            # Execute task
+            # If takes_context, pass TaskContext as first positional argument
             if takes_context:
                 context = TaskContext(task_result=task_result)
-                kwargs["context"] = context
-
-            # Execute task
-            if iscoroutinefunction(func):
-                return_value = asyncio.run(func(*args, **kwargs))
+                if iscoroutinefunction(func):
+                    return_value = asyncio.run(func(context, *args, **kwargs))
+                else:
+                    return_value = func(context, *args, **kwargs)
             else:
-                return_value = func(*args, **kwargs)
+                if iscoroutinefunction(func):
+                    return_value = asyncio.run(func(*args, **kwargs))
+                else:
+                    return_value = func(*args, **kwargs)
 
             # Normalize return value for JSON serialization
             # This will raise TypeError for unsupported types

{django_database_task-0.2.0 → django_database_task-0.2.2}/django_database_task/cloudtasks/backend.py

@@ -37,11 +37,17 @@ class CloudTasksDatabaseBackend(DatabaseTaskBackend):
         TASKS = {
             "default": {
                 "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
-                "OPTIONS": {
-                    "CLOUD_TASKS_QUEUE": "default",
-                },
             },
         }
+
+    The Cloud Tasks queue name is determined by the task's queue_name attribute.
+    For example:
+        @task(queue="high-priority")
+        def urgent_task():
+            ...
+    will use the "high-priority" Cloud Tasks queue.
+
+    Tasks without explicit queue use Django's DEFAULT_TASK_QUEUE_NAME ("default").
     """
 
     def __init__(self, alias, params):
@@ -49,11 +55,6 @@ class CloudTasksDatabaseBackend(DatabaseTaskBackend):
 
         options = params.get("OPTIONS", {})
 
-        # Required: Queue name
-        self.queue_name = options.get("CLOUD_TASKS_QUEUE")
-        if not self.queue_name:
-            raise ImproperlyConfigured("CLOUD_TASKS_QUEUE is required in TASKS OPTIONS")
-
         # Auto-detected or explicit: Project ID
         self.project = options.get("CLOUD_TASKS_PROJECT") or detect_gcp_project()
         if not self.project:
@@ -188,12 +189,15 @@ class CloudTasksDatabaseBackend(DatabaseTaskBackend):
 
         The Cloud Task only contains the task ID in the URL.
         Task parameters are retrieved from the database when executed.
+
+        The Cloud Tasks queue name is taken from the task's queue_name attribute.
         """
-        # Build queue path
+        # Build queue path using task's queue_name
+        queue_name = task_result.task.queue_name
         parent = self.client.queue_path(
             self.project,
             self.location,
-            self.queue_name,
+            queue_name,
         )
 
         # Build task handler URL (contains only task ID)

{django_database_task-0.2.0 → django_database_task-0.2.2}/django_database_task/cloudtasks/detection.py

@@ -31,7 +31,7 @@ def detect_gcp_project():
 
 def detect_gcp_location():
     """
-    Detect Cloud Tasks location (region) from environment variables.
+    Detect Cloud Tasks location (region) from environment variables or metadata server.
 
     Returns:
         Region string or None if not detected.
@@ -41,16 +41,53 @@ def detect_gcp_location():
     if region:
         return region
 
-    # GAE: Check for region environment variables
-    region = os.environ.get("GAE_REGION") or os.environ.get("GOOGLE_CLOUD_REGION")
+    # Explicit environment variable (works for any environment)
+    region = os.environ.get("GOOGLE_CLOUD_REGION")
+    if region:
+        return region
+
+    # GAE/GCE: Query metadata server for zone and extract region
+    region = _detect_region_from_metadata()
     if region:
         return region
 
-    # Note: GAE may not provide region via environment variables
-    # In that case, explicit configuration is required
     return None
 
 
+def _detect_region_from_metadata():
+    """
+    Detect region from GCP metadata server.
+
+    The metadata server returns zone in format:
+    projects/PROJECT_NUMBER/zones/ZONE_NAME (e.g., projects/12345/zones/us-central1-a)
+
+    We extract the region by removing the zone suffix (e.g., us-central1).
+
+    Returns:
+        Region string or None if not available.
+    """
+    import urllib.error
+    import urllib.request
+
+    metadata_url = "http://metadata.google.internal/computeMetadata/v1/instance/zone"
+    headers = {"Metadata-Flavor": "Google"}
+
+    try:
+        request = urllib.request.Request(metadata_url, headers=headers)
+        with urllib.request.urlopen(request, timeout=2) as response:
+            # Response format: projects/PROJECT_NUMBER/zones/ZONE_NAME
+            zone_path = response.read().decode("utf-8")
+            # Extract zone name (last part)
+            zone = zone_path.split("/")[-1]
+            # Extract region by removing the last part (e.g., us-central1-a -> us-central1)
+            # Zone format: {region}-{zone_letter} (e.g., us-central1-a, asia-northeast1-b)
+            region = "-".join(zone.rsplit("-", 1)[:-1])
+            return region if region else None
+    except (urllib.error.URLError, OSError):
+        # Metadata server not available (local development, etc.)
+        return None
+
+
 def detect_default_service_account():
     """
     Detect the default service account email.

{django_database_task-0.2.0 → django_database_task-0.2.2/django_database_task.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-database-task
-Version: 0.2.0
+Version: 0.2.2
 Summary: A database-backed task queue backend for Django 6.0's built-in task framework
 Author-email: Shinya Okano <tokibito@gmail.com>
 Maintainer-email: Shinya Okano <tokibito@gmail.com>
@@ -36,6 +36,11 @@ Dynamic: license-file
 
 # django-database-task
 
+[![CI](https://github.com/tokibito/django-database-task/actions/workflows/ci.yml/badge.svg)](https://github.com/tokibito/django-database-task/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/django-database-task.svg)](https://badge.fury.io/py/django-database-task)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-database-task.svg)](https://pypi.org/project/django-database-task/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 A database-backed task queue backend for Django 6.0's built-in task framework.
 
 ## Features
@@ -607,21 +612,68 @@ pip install django-database-task[cloudtasks]
 TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
-        "OPTIONS": {
-            "CLOUD_TASKS_QUEUE": "default",  # Only required setting
-        },
+        "QUEUES": [],  # Allow all queue names
     },
 }
 ```
 
-Project ID, location, and handler URL are auto-detected from GAE/Cloud Run environment variables.
+Project ID, location, and handler URL are auto-detected from GAE/Cloud Run environment.
 
-### How It Works
+**Important**: Set `QUEUES: []` to allow any queue name, or list the queues you use:
+```python
+"QUEUES": ["default", "emails", "batch"],  # Only these queues allowed
+```
+
+The Cloud Tasks queue name is determined by the task's `queue_name` attribute:
+
+```python
+@task  # Uses "default" queue
+def normal_task():
+    pass
+
+@task(queue="batch")  # Uses "batch" queue
+def batch_task():
+    pass
 
+@task(queue="high-priority")  # Uses "high-priority" queue
+def urgent_task():
+    pass
 ```
-1. App enqueues task → Task saved to database + Cloud Task created
-2. Cloud Task triggers HTTP request → /tasks/execute/<task_id>/
-3. Handler retrieves task from database and executes it
+
+This allows you to configure different rate limits and concurrency settings per queue in Cloud Tasks.
+
+### How It Works
+
+```mermaid
+sequenceDiagram
+    participant App as Application
+    participant Backend as CloudTasksDatabaseBackend
+    participant DB as Database
+    participant CT as Cloud Tasks
+    participant Handler as /tasks/execute/
+
+    Note over App,Handler: Task Enqueue
+    App->>Backend: task.enqueue(args, kwargs)
+    Backend->>DB: INSERT task (status=READY)
+    DB-->>Backend: Task ID
+    Backend->>CT: Create Cloud Task (task_id only)
+    CT-->>Backend: OK
+    Backend-->>App: TaskResult (id, status=READY)
+
+    Note over App,Handler: Task Execution (triggered by Cloud Tasks)
+    CT->>Handler: POST /tasks/execute/<task_id>/<br/>(with OIDC token if configured)
+    Handler->>Handler: Verify OIDC token (optional)
+    Handler->>DB: SELECT task by ID
+    DB-->>Handler: Task record
+    Handler->>DB: UPDATE status=RUNNING
+    Handler->>Handler: Execute task function
+    alt Success
+        Handler->>DB: UPDATE status=SUCCESSFUL
+        Handler-->>CT: HTTP 200
+    else Failure
+        Handler->>DB: UPDATE status=FAILED
+        Handler-->>CT: HTTP 500 (triggers retry)
+    end
 ```
 
 The Cloud Task only contains the task ID. All task parameters are stored in the database, ensuring:
@@ -636,10 +688,9 @@ TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
         "OPTIONS": {
-            # Required
-            "CLOUD_TASKS_QUEUE": "default",
+            # All settings are optional - auto-detected from environment
 
-            # Auto-detected (override if needed)
+            # Override auto-detection if needed
             # "CLOUD_TASKS_PROJECT": "my-project",
             # "CLOUD_TASKS_LOCATION": "asia-northeast1",
             # "TASK_HANDLER_URL": "https://myapp.example.com/tasks/execute/{task_id}/",
@@ -655,11 +706,12 @@ TASKS = {
 
 ### Auto-Detection
 
-| Setting | Environment Variable | Description |
-|---------|---------------------|-------------|
-| Project | `GOOGLE_CLOUD_PROJECT` | GCP project ID |
-| Location | `CLOUD_RUN_REGION` / `GAE_REGION` | Cloud Tasks region |
+| Setting | Detection Method | Description |
+|---------|------------------|-------------|
+| Project | `GOOGLE_CLOUD_PROJECT` env var | GCP project ID |
+| Location | `CLOUD_RUN_REGION` env var, or metadata server | Cloud Tasks region |
 | Handler URL | Built from `K_SERVICE`, `GAE_SERVICE`, `GAE_VERSION` | Task execution endpoint |
+| Queue name | Task's `queue_name` attribute | Defaults to "default" |
 
 ### OIDC Authentication
 
@@ -670,8 +722,8 @@ When `OIDC_SERVICE_ACCOUNT_EMAIL` is configured, Cloud Tasks will send OIDC toke
 TASKS = {
     "default": {
         "BACKEND": "django_database_task.cloudtasks.CloudTasksDatabaseBackend",
+        "QUEUES": [],  # Allow all queue names
         "OPTIONS": {
-            "CLOUD_TASKS_QUEUE": "default",
             "OIDC_SERVICE_ACCOUNT_EMAIL": "my-sa@project.iam.gserviceaccount.com",
             # OIDC_AUDIENCE is auto-detected from handler URL if not set
         },

{django_database_task-0.2.0 → django_database_task-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "django-database-task"
-version = "0.2.0"
+version = "0.2.2"
 description = "A database-backed task queue backend for Django 6.0's built-in task framework"
 readme = "README.md"
 license = "MIT"