django-qstash 0.0.6__tar.gz → 0.0.8__tar.gz

{django_qstash-0.0.6 → django_qstash-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-qstash
-Version: 0.0.6
+Version: 0.0.8
 Summary: A drop-in replacement for Celery's shared_task with Upstash QStash.
 Author-email: Justin Mitchel <justin@codingforentrepreneurs.com>
 Project-URL: Changelog, https://github.com/jmitchel3/django-qstash

{django_qstash-0.0.6 → django_qstash-0.0.8}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "django-qstash"
-version = "0.0.6"
+version = "0.0.8"
 description = "A drop-in replacement for Celery's shared_task with Upstash QStash."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -70,7 +70,6 @@ branch = true
 parallel = true
 source = [
   "django_qstash",
-  "tests",
 ]
 omit = [
   "*/migrations/*",
@@ -80,8 +79,8 @@ omit = [
 
 [tool.coverage.paths]
 source = [
-  "src",
-  ".tox/**/site-packages",
+  "src/django_qstash",
+  ".tox/*/lib/python*/site-packages/django_qstash",
 ]
 
 [tool.coverage.report]

{django_qstash-0.0.6 → django_qstash-0.0.8}/src/django_qstash/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
-__version__ = "0.0.6"
+__version__ = "0.0.8"
 
-from .tasks import shared_task
+from django_qstash.app import shared_task
 
 __all__ = ["shared_task"]

django_qstash-0.0.8/src/django_qstash/app/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from .base import AsyncResult
+from .base import QStashTask
+from .decorators import shared_task
+
+__all__ = ["AsyncResult", "QStashTask", "shared_task"]

django_qstash-0.0.6/src/django_qstash/tasks.py → django_qstash-0.0.8/src/django_qstash/app/base.py

@@ -118,26 +118,3 @@ class AsyncResult:
     @property
     def id(self) -> str:
         return self.task_id
-
-
-def shared_task(
-    func: Callable | None = None,
-    name: str | None = None,
-    deduplicated: bool = False,
-    **options: dict[str, Any],
-) -> QStashTask:
-    """
-    Decorator that mimics Celery's shared_task
-
-    Can be used as:
-        @shared_task
-        def my_task():
-            pass
-
-        @shared_task(name="custom_name", deduplicated=True)
-        def my_task():
-            pass
-    """
-    if func is not None:
-        return QStashTask(func, name=name, deduplicated=deduplicated, **options)
-    return lambda f: QStashTask(f, name=name, deduplicated=deduplicated, **options)

django_qstash-0.0.8/src/django_qstash/app/decorators.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from typing import Any
+from typing import Callable
+
+from django_qstash.app.base import QStashTask
+
+
+def shared_task(
+    func: Callable | None = None,
+    name: str | None = None,
+    deduplicated: bool = False,
+    **options: dict[str, Any],
+) -> QStashTask:
+    """
+    Decorator that mimics Celery's shared_task
+
+    Can be used as:
+        @shared_task
+        def my_task():
+            pass
+
+        @shared_task(name="custom_name", deduplicated=True)
+        def my_task():
+            pass
+    """
+    if func is not None:
+        return QStashTask(func, name=name, deduplicated=deduplicated, **options)
+    return lambda f: QStashTask(f, name=name, deduplicated=deduplicated, **options)

{django_qstash-0.0.6 → django_qstash-0.0.8}/src/django_qstash/discovery/utils.py

@@ -32,7 +32,7 @@ def discover_tasks() -> list[tuple[str, str]]:
             ('other_app.tasks.custom_task', 'special_name')
         ]
     """
-    from django_qstash.tasks import QStashTask
+    from django_qstash.app import QStashTask
 
     discovered_tasks = []
     packages = []
@@ -71,7 +71,7 @@ def discover_tasks() -> list[tuple[str, str]]:
                     if attr.name == attr_name:
                         label = value
                     else:
-                        label = f"{attr.name} ({value})"
+                        label = f"{attr.name} ({package}.tasks)"
                     discovered_tasks.append((value, label))
         except Exception as e:
             warnings.warn(

django_qstash-0.0.8/src/django_qstash/management/commands/clear_stale_results.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+
+from django_qstash.results.tasks import clear_stale_results_task
+
+DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
+
+
+class Command(BaseCommand):
+    help = f"""Clears stale task results older than\n
+    {DJANGO_QSTASH_RESULT_TTL} seconds (settings.DJANGO_QSTASH_RESULT_TTL)"""
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--no-input",
+            action="store_true",
+            help="Do not ask for confirmation",
+        )
+        parser.add_argument(
+            "--since",
+            type=int,
+            help="The number of seconds ago to clear results for",
+        )
+        parser.add_argument(
+            "--delay", action="store_true", help="Offload request using django_qstash"
+        )
+
+    def handle(self, *args, **options):
+        delay = options["delay"]
+        no_input = options["no_input"]
+        since = options.get("since") or DJANGO_QSTASH_RESULT_TTL
+        user_confirm = not no_input
+        if not delay:
+            clear_stale_results_task(
+                since=since, user_confirm=user_confirm, stdout=self.stdout
+            )
+        else:
+            clear_stale_results_task.delay(
+                since=since, user_confirm=user_confirm, stdout=self.stdout
+            )

{django_qstash-0.0.6 → django_qstash-0.0.8}/src/django_qstash/management/commands/task_schedules.py

@@ -7,7 +7,8 @@ from django.apps import apps
 from django.core.management.base import BaseCommand
 from django.db import models
 
-from django_qstash.schedules.client import QStashScheduleClient
+from django_qstash.callbacks import get_callback_url
+from django_qstash.client import qstash_client
 
 logger = logging.getLogger(__name__)
 
@@ -28,6 +29,11 @@ class Command(BaseCommand):
             action="store_true",
             help="Sync schedules from QStash to local database",
         )
+        parser.add_argument(
+            "--no-input",
+            action="store_true",
+            help="Do not ask for confirmation",
+        )
 
     def get_task_schedule_model(self) -> models.Model | None:
         """Get the TaskSchedule model if available."""
@@ -40,13 +46,10 @@ class Command(BaseCommand):
                     "Add `django_qstash.schedules` to INSTALLED_APPS and run migrations."
                 )
             )
-            return None
 
     def sync_schedules(self, schedules: list) -> None:
         """Sync remote schedules to local database."""
         TaskSchedule = self.get_task_schedule_model()
-        if not TaskSchedule:
-            return
 
         for schedule in schedules:
             try:
@@ -72,6 +75,7 @@ class Command(BaseCommand):
                 logger.exception("Failed to sync schedule %s", schedule.schedule_id)
 
     def handle(self, *args, **options) -> None:
+        auto_confirm = options.get("no_input")
         if not (options.get("sync") or options.get("list")):
             self.stdout.write(
                 self.style.ERROR("Please specify either --list or --sync option")
@@ -79,9 +83,8 @@ class Command(BaseCommand):
             return
 
         try:
-            client = QStashScheduleClient()
-            destination = client._get_callback_url()
-            schedules = client.list_schedules()
+            destination = get_callback_url()
+            schedules = qstash_client.schedule.list()
 
             self.stdout.write(
                 self.style.SUCCESS(
@@ -105,8 +108,9 @@ class Command(BaseCommand):
 
             if options.get("sync"):
                 user_input = input("Do you want to sync remote schedules? (y/n): ")
-                if user_input.lower() == "y":
+                if user_input.lower() == "y" or auto_confirm:
                     self.sync_schedules(schedules)
-
+                else:
+                    self.stdout.write(self.style.ERROR("Sync cancelled"))
         except Exception as e:
             self.stdout.write(self.style.ERROR(f"An error occurred: {str(e)}"))

django_qstash-0.0.8/src/django_qstash/results/tasks.py

@@ -0,0 +1,67 @@
+from __future__ import annotations
+
+import logging
+from datetime import timedelta
+
+from django.apps import apps
+from django.conf import settings
+from django.utils import timezone
+
+from django_qstash import shared_task
+
+DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
+
+logger = logging.getLogger(__name__)
+
+
+@shared_task(name="Cleanup Task Results")
+def clear_stale_results_task(
+    since=None, stdout=None, user_confirm=False, *args, **options
+):
+    delta_seconds = since or DJANGO_QSTASH_RESULT_TTL
+    cutoff_date = timezone.now() - timedelta(seconds=delta_seconds)
+    TaskResult = None
+    try:
+        TaskResult = apps.get_model("django_qstash_results", "TaskResult")
+    except LookupError as e:
+        msg = "Django QStash Results not installed.\nAdd `django_qstash.results` to INSTALLED_APPS and run migrations."
+        if stdout is not None:
+            stdout.write(msg)
+        logger.exception(msg)
+        raise e
+    qs_to_delete = TaskResult.objects.filter(date_done__lt=cutoff_date)
+
+    if user_confirm:
+        user_input = input("Are you sure? (Y/n): ")
+        if f"{user_input}".lower() != "y":
+            msg = "Skipping deletion"
+            if stdout is not None:
+                stdout.write(msg)
+            logger.info(msg)
+            return
+
+    if not qs_to_delete.exists():
+        msg = "No stale Django QStash task results found"
+        if stdout is not None:
+            stdout.write(msg)
+        else:
+            logger.info(msg)
+        return
+    delete_msg = f"Deleting {qs_to_delete.count()} task results older than {cutoff_date} ({DJANGO_QSTASH_RESULT_TTL} seconds)"
+    if stdout is not None:
+        stdout.write(delete_msg)
+    else:
+        logger.info(delete_msg)
+    try:
+        deleted_count, _ = qs_to_delete.delete()
+        msg = f"Successfully deleted {deleted_count} stale results."
+        if stdout is not None:
+            stdout.write(msg)
+        else:
+            logger.info(msg)
+    except Exception as e:
+        msg = f"Error deleting stale results: {e}"
+        if stdout is not None:
+            stdout.write(msg)
+        logger.exception(msg)
+        raise e

{django_qstash-0.0.6 → django_qstash-0.0.8}/src/django_qstash.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-qstash
-Version: 0.0.6
+Version: 0.0.8
 Summary: A drop-in replacement for Celery's shared_task with Upstash QStash.
 Author-email: Justin Mitchel <justin@codingforentrepreneurs.com>
 Project-URL: Changelog, https://github.com/jmitchel3/django-qstash

{django_qstash-0.0.6 → django_qstash-0.0.8}/src/django_qstash.egg-info/SOURCES.txt

@@ -6,7 +6,6 @@ src/django_qstash/client.py
 src/django_qstash/exceptions.py
 src/django_qstash/handlers.py
 src/django_qstash/settings.py
-src/django_qstash/tasks.py
 src/django_qstash/utils.py
 src/django_qstash/views.py
 src/django_qstash.egg-info/PKG-INFO
@@ -14,11 +13,15 @@ src/django_qstash.egg-info/SOURCES.txt
 src/django_qstash.egg-info/dependency_links.txt
 src/django_qstash.egg-info/requires.txt
 src/django_qstash.egg-info/top_level.txt
+src/django_qstash/app/__init__.py
+src/django_qstash/app/base.py
+src/django_qstash/app/decorators.py
 src/django_qstash/discovery/__init__.py
 src/django_qstash/discovery/fields.py
 src/django_qstash/discovery/models.py
 src/django_qstash/discovery/utils.py
 src/django_qstash/discovery/validators.py
+src/django_qstash/management/__init__.py
 src/django_qstash/management/commands/__init__.py
 src/django_qstash/management/commands/clear_stale_results.py
 src/django_qstash/management/commands/task_schedules.py
@@ -27,6 +30,7 @@ src/django_qstash/results/admin.py
 src/django_qstash/results/apps.py
 src/django_qstash/results/models.py
 src/django_qstash/results/services.py
+src/django_qstash/results/tasks.py
 src/django_qstash/results/migrations/0001_initial.py
 src/django_qstash/results/migrations/__init__.py
 src/django_qstash/schedules/__init__.py
@@ -47,6 +51,5 @@ tests/test_exceptions.py
 tests/test_handlers.py
 tests/test_results_models.py
 tests/test_settings.py
-tests/test_tasks.py
 tests/test_utils.py
 tests/test_views.py

django_qstash-0.0.8/tests/test_settings.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+import warnings
+
+from django.test import TestCase
+from django.test import override_settings
+
+from django_qstash.settings import DJANGO_QSTASH_WEBHOOK_PATH
+
+
+class SettingsTestCase(TestCase):
+    def test_default_webhook_path(self):
+        """Test that default webhook path is set correctly"""
+        self.assertEqual(DJANGO_QSTASH_WEBHOOK_PATH, "/qstash/webhook/")
+
+    def test_warning_when_required_settings_missing(self):
+        """Test that warning is raised when required settings are missing"""
+        with override_settings(QSTASH_TOKEN=None, DJANGO_QSTASH_DOMAIN=None):
+            with warnings.catch_warnings(record=True) as w:
+                warnings.simplefilter("always")
+
+                # Force reload of settings to trigger warning
+                from importlib import reload
+
+                import django_qstash.settings
+
+                reload(django_qstash.settings)
+
+                self.assertEqual(len(w), 1)
+                self.assertTrue(issubclass(w[0].category, RuntimeWarning))
+                self.assertIn(
+                    "QSTASH_TOKEN and DJANGO_QSTASH_DOMAIN should be set",
+                    str(w[0].message),
+                )
+
+    @override_settings(QSTASH_TOKEN="test-token", DJANGO_QSTASH_DOMAIN="example.com")
+    def test_no_warning_when_settings_present(self):
+        """Test that no warning is raised when required settings are present"""
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+
+            # Force reload of settings
+            from importlib import reload
+
+            import django_qstash.settings
+
+            reload(django_qstash.settings)
+
+            self.assertEqual(len(w), 0)
+
+    @override_settings(DJANGO_QSTASH_WEBHOOK_PATH="/custom/webhook/path/")
+    def test_custom_webhook_path(self):
+        """Test that custom webhook path can be set"""
+        # Force reload of settings to get new webhook path
+        from importlib import reload
+
+        import django_qstash.settings
+
+        reload(django_qstash.settings)
+
+        self.assertEqual(
+            django_qstash.settings.DJANGO_QSTASH_WEBHOOK_PATH, "/custom/webhook/path/"
+        )

django_qstash-0.0.6/src/django_qstash/management/commands/clear_stale_results.py

@@ -1,61 +0,0 @@
-from __future__ import annotations
-
-from datetime import timedelta
-
-from django.apps import apps
-from django.conf import settings
-from django.core.management.base import BaseCommand
-from django.utils import timezone
-
-DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
-
-
-class Command(BaseCommand):
-    help = f"""Clears stale task results older than\n
-    {DJANGO_QSTASH_RESULT_TTL} seconds (settings.DJANGO_QSTASH_RESULT_TTL)"""
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "--no-input",
-            action="store_true",
-            help="Do not ask for confirmation",
-        )
-        parser.add_argument(
-            "--since",
-            type=int,
-            help="The number of seconds ago to clear results for",
-        )
-
-    def handle(self, *args, **options):
-        no_input = options["no_input"]
-        since = options.get("since") or DJANGO_QSTASH_RESULT_TTL
-        cutoff_date = timezone.now() - timedelta(seconds=since)
-        try:
-            TaskResult = apps.get_model("django_qstash_results", "TaskResult")
-        except LookupError:
-            self.stdout.write(
-                self.style.ERROR(
-                    "Django QStash Results not installed.\nAdd `django_qstash.results` to INSTALLED_APPS and run migrations."
-                )
-            )
-            return
-        to_delete = TaskResult.objects.filter(date_done__lt=cutoff_date)
-
-        if not to_delete.exists():
-            self.stdout.write("No stale Django QStash task results found")
-            return
-
-        # use input to confirm  deletion
-        self.stdout.write(
-            f"Deleting {to_delete.count()} task results older than {cutoff_date} ({DJANGO_QSTASH_RESULT_TTL} seconds)"
-        )
-        if not no_input:
-            if input("Are you sure? (y/n): ") != "y":
-                self.stdout.write("Skipping deletion")
-                return
-
-        deleted_count, _ = to_delete.delete()
-
-        self.stdout.write(
-            self.style.SUCCESS(f"Successfully deleted {deleted_count} stale results.")
-        )

django_qstash-0.0.6/tests/test_settings.py

@@ -1,29 +0,0 @@
-# from django.conf import settings
-# from django.test import TestCase
-
-
-from __future__ import annotations
-
-# class SettingsTestCase(TestCase):
-#     def test_required_settings_present(self):
-#         """Test that all required QStash settings are present"""
-#         self.assertTrue(hasattr(settings, "QSTASH_TOKEN"))
-#         self.assertTrue(hasattr(settings, "DJANGO_QSTASH_DOMAIN"))
-#         self.assertTrue(hasattr(settings, "QSTASH_CURRENT_SIGNING_KEY"))
-#         self.assertTrue(hasattr(settings, "QSTASH_NEXT_SIGNING_KEY"))
-#     def test_settings_values(self):
-#         """Test that settings have expected test values"""
-#         self.assertEqual(settings.QSTASH_TOKEN, "test-token")
-#         self.assertEqual(settings.DJANGO_QSTASH_DOMAIN, "example.com")
-#         self.assertEqual(settings.QSTASH_CURRENT_SIGNING_KEY, "current-key")
-#         self.assertEqual(settings.QSTASH_NEXT_SIGNING_KEY, "next-key")
-
-#     def test_required_apps_installed(self):
-#         """Test that required apps are in INSTALLED_APPS"""
-#         required_apps = [
-#             "django_qstash",
-#             "django_qstash.results",
-#             "django_qstash.schedules",
-#         ]
-#         for app in required_apps:
-#             self.assertIn(app, settings.INSTALLED_APPS)

django_qstash-0.0.6/tests/test_tasks.py

@@ -1,53 +0,0 @@
-from unittest.mock import Mock, patch
-
-import pytest
-
-from django_qstash.tasks import shared_task
-
-
-@shared_task
-def sample_task(x, y):
-    return x + y
-
-
-@shared_task(name="custom_task", deduplicated=True)
-def sample_task_with_options(x, y):
-    return x * y
-
-
-@pytest.mark.django_db
-class TestQStashTasks:
-    def test_basic_task_execution(self):
-        """Test that tasks can be executed directly"""
-        result = sample_task(2, 3)
-        assert result == 5
-
-    def test_task_with_options(self):
-        """Test that tasks with custom options work"""
-        result = sample_task_with_options(4, 5)
-        assert result == 20
-
-    @patch("django_qstash.tasks.qstash_client")
-    def test_task_delay(self, mock_client):
-        """Test that delay() sends task to QStash"""
-        mock_response = Mock()
-        mock_response.message_id = "test-id-123"
-        mock_client.message.publish_json.return_value = mock_response
-
-        result = sample_task.delay(2, 3)
-
-        assert result.task_id == "test-id-123"
-        mock_client.message.publish_json.assert_called_once()
-
-    @patch("django_qstash.tasks.qstash_client")
-    def test_task_apply_async(self, mock_client):
-        """Test that apply_async() works with countdown"""
-        mock_response = Mock()
-        mock_response.message_id = "test-id-456"
-        mock_client.message.publish_json.return_value = mock_response
-
-        result = sample_task.apply_async(args=(2, 3), countdown=60)
-
-        assert result.task_id == "test-id-456"
-        call_kwargs = mock_client.message.publish_json.call_args[1]
-        assert call_kwargs["delay"] == "60s"