django-qstash 0.0.7__tar.gz → 0.0.9__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of django-qstash might be problematic. Click here for more details.

Files changed (59) hide show
  1. {django_qstash-0.0.7 → django_qstash-0.0.9}/PKG-INFO +1 -1
  2. {django_qstash-0.0.7 → django_qstash-0.0.9}/pyproject.toml +3 -4
  3. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/__init__.py +2 -2
  4. django_qstash-0.0.9/src/django_qstash/app/__init__.py +7 -0
  5. django_qstash-0.0.7/src/django_qstash/tasks.py → django_qstash-0.0.9/src/django_qstash/app/base.py +0 -23
  6. django_qstash-0.0.9/src/django_qstash/app/decorators.py +29 -0
  7. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/discovery/utils.py +2 -2
  8. django_qstash-0.0.9/src/django_qstash/management/commands/clear_stale_results.py +42 -0
  9. django_qstash-0.0.9/src/django_qstash/results/tasks.py +67 -0
  10. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/services.py +3 -1
  11. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash.egg-info/PKG-INFO +1 -1
  12. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash.egg-info/SOURCES.txt +4 -2
  13. django_qstash-0.0.7/src/django_qstash/management/commands/clear_stale_results.py +0 -61
  14. django_qstash-0.0.7/tests/test_tasks.py +0 -53
  15. {django_qstash-0.0.7 → django_qstash-0.0.9}/README.md +0 -0
  16. {django_qstash-0.0.7 → django_qstash-0.0.9}/setup.cfg +0 -0
  17. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/callbacks.py +0 -0
  18. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/client.py +0 -0
  19. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/discovery/__init__.py +0 -0
  20. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/discovery/fields.py +0 -0
  21. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/discovery/models.py +0 -0
  22. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/discovery/validators.py +0 -0
  23. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/exceptions.py +0 -0
  24. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/handlers.py +0 -0
  25. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/management/__init__.py +0 -0
  26. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/management/commands/__init__.py +0 -0
  27. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/management/commands/task_schedules.py +0 -0
  28. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/__init__.py +0 -0
  29. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/admin.py +0 -0
  30. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/apps.py +0 -0
  31. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/migrations/0001_initial.py +0 -0
  32. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/migrations/__init__.py +0 -0
  33. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/models.py +0 -0
  34. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/results/services.py +0 -0
  35. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/__init__.py +0 -0
  36. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/admin.py +0 -0
  37. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/apps.py +0 -0
  38. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/exceptions.py +0 -0
  39. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/formatters.py +0 -0
  40. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/forms.py +0 -0
  41. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/migrations/0001_initial.py +0 -0
  42. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/migrations/0002_taskschedule_updated_at.py +0 -0
  43. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/migrations/__init__.py +0 -0
  44. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/models.py +0 -0
  45. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/signals.py +0 -0
  46. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/schedules/validators.py +0 -0
  47. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/settings.py +0 -0
  48. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/utils.py +0 -0
  49. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash/views.py +0 -0
  50. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash.egg-info/dependency_links.txt +0 -0
  51. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash.egg-info/requires.txt +0 -0
  52. {django_qstash-0.0.7 → django_qstash-0.0.9}/src/django_qstash.egg-info/top_level.txt +0 -0
  53. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_callbacks.py +0 -0
  54. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_exceptions.py +0 -0
  55. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_handlers.py +0 -0
  56. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_results_models.py +0 -0
  57. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_settings.py +0 -0
  58. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_utils.py +0 -0
  59. {django_qstash-0.0.7 → django_qstash-0.0.9}/tests/test_views.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: django-qstash
3
- Version: 0.0.7
3
+ Version: 0.0.9
4
4
  Summary: A drop-in replacement for Celery's shared_task with Upstash QStash.
5
5
  Author-email: Justin Mitchel <justin@codingforentrepreneurs.com>
6
6
  Project-URL: Changelog, https://github.com/jmitchel3/django-qstash
@@ -6,7 +6,7 @@ requires = [
6
6
 
7
7
  [project]
8
8
  name = "django-qstash"
9
- version = "0.0.7"
9
+ version = "0.0.9"
10
10
  description = "A drop-in replacement for Celery's shared_task with Upstash QStash."
11
11
  readme = "README.md"
12
12
  license = { file = "LICENSE" }
@@ -70,7 +70,6 @@ branch = true
70
70
  parallel = true
71
71
  source = [
72
72
  "django_qstash",
73
- "tests",
74
73
  ]
75
74
  omit = [
76
75
  "*/migrations/*",
@@ -80,8 +79,8 @@ omit = [
80
79
 
81
80
  [tool.coverage.paths]
82
81
  source = [
83
- "src",
84
- ".tox/**/site-packages",
82
+ "src/django_qstash",
83
+ ".tox/*/lib/python*/site-packages/django_qstash",
85
84
  ]
86
85
 
87
86
  [tool.coverage.report]
@@ -1,7 +1,7 @@
1
1
  from __future__ import annotations
2
2
 
3
- __version__ = "0.0.7"
3
+ __version__ = "0.0.9"
4
4
 
5
- from .tasks import shared_task
5
+ from django_qstash.app import shared_task
6
6
 
7
7
  __all__ = ["shared_task"]
@@ -0,0 +1,7 @@
1
+ from __future__ import annotations
2
+
3
+ from .base import AsyncResult
4
+ from .base import QStashTask
5
+ from .decorators import shared_task
6
+
7
+ __all__ = ["AsyncResult", "QStashTask", "shared_task"]
@@ -118,26 +118,3 @@ class AsyncResult:
118
118
  @property
119
119
  def id(self) -> str:
120
120
  return self.task_id
121
-
122
-
123
- def shared_task(
124
- func: Callable | None = None,
125
- name: str | None = None,
126
- deduplicated: bool = False,
127
- **options: dict[str, Any],
128
- ) -> QStashTask:
129
- """
130
- Decorator that mimics Celery's shared_task
131
-
132
- Can be used as:
133
- @shared_task
134
- def my_task():
135
- pass
136
-
137
- @shared_task(name="custom_name", deduplicated=True)
138
- def my_task():
139
- pass
140
- """
141
- if func is not None:
142
- return QStashTask(func, name=name, deduplicated=deduplicated, **options)
143
- return lambda f: QStashTask(f, name=name, deduplicated=deduplicated, **options)
@@ -0,0 +1,29 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any
4
+ from typing import Callable
5
+
6
+ from django_qstash.app.base import QStashTask
7
+
8
+
9
+ def shared_task(
10
+ func: Callable | None = None,
11
+ name: str | None = None,
12
+ deduplicated: bool = False,
13
+ **options: dict[str, Any],
14
+ ) -> QStashTask:
15
+ """
16
+ Decorator that mimics Celery's shared_task
17
+
18
+ Can be used as:
19
+ @shared_task
20
+ def my_task():
21
+ pass
22
+
23
+ @shared_task(name="custom_name", deduplicated=True)
24
+ def my_task():
25
+ pass
26
+ """
27
+ if func is not None:
28
+ return QStashTask(func, name=name, deduplicated=deduplicated, **options)
29
+ return lambda f: QStashTask(f, name=name, deduplicated=deduplicated, **options)
@@ -32,7 +32,7 @@ def discover_tasks() -> list[tuple[str, str]]:
32
32
  ('other_app.tasks.custom_task', 'special_name')
33
33
  ]
34
34
  """
35
- from django_qstash.tasks import QStashTask
35
+ from django_qstash.app import QStashTask
36
36
 
37
37
  discovered_tasks = []
38
38
  packages = []
@@ -71,7 +71,7 @@ def discover_tasks() -> list[tuple[str, str]]:
71
71
  if attr.name == attr_name:
72
72
  label = value
73
73
  else:
74
- label = f"{attr.name} ({value})"
74
+ label = f"{attr.name} ({package}.tasks)"
75
75
  discovered_tasks.append((value, label))
76
76
  except Exception as e:
77
77
  warnings.warn(
@@ -0,0 +1,42 @@
1
+ from __future__ import annotations
2
+
3
+ from django.conf import settings
4
+ from django.core.management.base import BaseCommand
5
+
6
+ from django_qstash.results.tasks import clear_stale_results_task
7
+
8
+ DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
9
+
10
+
11
+ class Command(BaseCommand):
12
+ help = f"""Clears stale task results older than\n
13
+ {DJANGO_QSTASH_RESULT_TTL} seconds (settings.DJANGO_QSTASH_RESULT_TTL)"""
14
+
15
+ def add_arguments(self, parser):
16
+ parser.add_argument(
17
+ "--no-input",
18
+ action="store_true",
19
+ help="Do not ask for confirmation",
20
+ )
21
+ parser.add_argument(
22
+ "--since",
23
+ type=int,
24
+ help="The number of seconds ago to clear results for",
25
+ )
26
+ parser.add_argument(
27
+ "--delay", action="store_true", help="Offload request using django_qstash"
28
+ )
29
+
30
+ def handle(self, *args, **options):
31
+ delay = options["delay"]
32
+ no_input = options["no_input"]
33
+ since = options.get("since") or DJANGO_QSTASH_RESULT_TTL
34
+ user_confirm = not no_input
35
+ if not delay:
36
+ clear_stale_results_task(
37
+ since=since, user_confirm=user_confirm, stdout=self.stdout
38
+ )
39
+ else:
40
+ clear_stale_results_task.delay(
41
+ since=since, user_confirm=user_confirm, stdout=self.stdout
42
+ )
@@ -0,0 +1,67 @@
1
+ from __future__ import annotations
2
+
3
+ import logging
4
+ from datetime import timedelta
5
+
6
+ from django.apps import apps
7
+ from django.conf import settings
8
+ from django.utils import timezone
9
+
10
+ from django_qstash import shared_task
11
+
12
+ DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
13
+
14
+ logger = logging.getLogger(__name__)
15
+
16
+
17
+ @shared_task(name="Cleanup Task Results")
18
+ def clear_stale_results_task(
19
+ since=None, stdout=None, user_confirm=False, *args, **options
20
+ ):
21
+ delta_seconds = since or DJANGO_QSTASH_RESULT_TTL
22
+ cutoff_date = timezone.now() - timedelta(seconds=delta_seconds)
23
+ TaskResult = None
24
+ try:
25
+ TaskResult = apps.get_model("django_qstash_results", "TaskResult")
26
+ except LookupError as e:
27
+ msg = "Django QStash Results not installed.\nAdd `django_qstash.results` to INSTALLED_APPS and run migrations."
28
+ if stdout is not None:
29
+ stdout.write(msg)
30
+ logger.exception(msg)
31
+ raise e
32
+ qs_to_delete = TaskResult.objects.filter(date_done__lt=cutoff_date)
33
+
34
+ if user_confirm:
35
+ user_input = input("Are you sure? (Y/n): ")
36
+ if f"{user_input}".lower() != "y":
37
+ msg = "Skipping deletion"
38
+ if stdout is not None:
39
+ stdout.write(msg)
40
+ logger.info(msg)
41
+ return
42
+
43
+ if not qs_to_delete.exists():
44
+ msg = "No stale Django QStash task results found"
45
+ if stdout is not None:
46
+ stdout.write(msg)
47
+ else:
48
+ logger.info(msg)
49
+ return
50
+ delete_msg = f"Deleting {qs_to_delete.count()} task results older than {cutoff_date} ({DJANGO_QSTASH_RESULT_TTL} seconds)"
51
+ if stdout is not None:
52
+ stdout.write(delete_msg)
53
+ else:
54
+ logger.info(delete_msg)
55
+ try:
56
+ deleted_count, _ = qs_to_delete.delete()
57
+ msg = f"Successfully deleted {deleted_count} stale results."
58
+ if stdout is not None:
59
+ stdout.write(msg)
60
+ else:
61
+ logger.info(msg)
62
+ except Exception as e:
63
+ msg = f"Error deleting stale results: {e}"
64
+ if stdout is not None:
65
+ stdout.write(msg)
66
+ logger.exception(msg)
67
+ raise e
@@ -20,7 +20,9 @@ def sync_task_schedule_instance_to_qstash(instance: TaskSchedule) -> TaskSchedul
20
20
  and updates existing schedules when active.
21
21
  """
22
22
  data = format_task_schedule_for_qstash(instance)
23
- qstash_client.schedule.create(**data)
23
+ schedule_id = qstash_client.schedule.create(**data)
24
+ if not instance.schedule_id:
25
+ TaskSchedule.objects.filter(id=instance.id).update(schedule_id=schedule_id)
24
26
 
25
27
  sync_state_changes(instance)
26
28
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: django-qstash
3
- Version: 0.0.7
3
+ Version: 0.0.9
4
4
  Summary: A drop-in replacement for Celery's shared_task with Upstash QStash.
5
5
  Author-email: Justin Mitchel <justin@codingforentrepreneurs.com>
6
6
  Project-URL: Changelog, https://github.com/jmitchel3/django-qstash
@@ -6,7 +6,6 @@ src/django_qstash/client.py
6
6
  src/django_qstash/exceptions.py
7
7
  src/django_qstash/handlers.py
8
8
  src/django_qstash/settings.py
9
- src/django_qstash/tasks.py
10
9
  src/django_qstash/utils.py
11
10
  src/django_qstash/views.py
12
11
  src/django_qstash.egg-info/PKG-INFO
@@ -14,6 +13,9 @@ src/django_qstash.egg-info/SOURCES.txt
14
13
  src/django_qstash.egg-info/dependency_links.txt
15
14
  src/django_qstash.egg-info/requires.txt
16
15
  src/django_qstash.egg-info/top_level.txt
16
+ src/django_qstash/app/__init__.py
17
+ src/django_qstash/app/base.py
18
+ src/django_qstash/app/decorators.py
17
19
  src/django_qstash/discovery/__init__.py
18
20
  src/django_qstash/discovery/fields.py
19
21
  src/django_qstash/discovery/models.py
@@ -28,6 +30,7 @@ src/django_qstash/results/admin.py
28
30
  src/django_qstash/results/apps.py
29
31
  src/django_qstash/results/models.py
30
32
  src/django_qstash/results/services.py
33
+ src/django_qstash/results/tasks.py
31
34
  src/django_qstash/results/migrations/0001_initial.py
32
35
  src/django_qstash/results/migrations/__init__.py
33
36
  src/django_qstash/schedules/__init__.py
@@ -48,6 +51,5 @@ tests/test_exceptions.py
48
51
  tests/test_handlers.py
49
52
  tests/test_results_models.py
50
53
  tests/test_settings.py
51
- tests/test_tasks.py
52
54
  tests/test_utils.py
53
55
  tests/test_views.py
@@ -1,61 +0,0 @@
1
- from __future__ import annotations
2
-
3
- from datetime import timedelta
4
-
5
- from django.apps import apps
6
- from django.conf import settings
7
- from django.core.management.base import BaseCommand
8
- from django.utils import timezone
9
-
10
- DJANGO_QSTASH_RESULT_TTL = getattr(settings, "DJANGO_QSTASH_RESULT_TTL", 604800)
11
-
12
-
13
- class Command(BaseCommand):
14
- help = f"""Clears stale task results older than\n
15
- {DJANGO_QSTASH_RESULT_TTL} seconds (settings.DJANGO_QSTASH_RESULT_TTL)"""
16
-
17
- def add_arguments(self, parser):
18
- parser.add_argument(
19
- "--no-input",
20
- action="store_true",
21
- help="Do not ask for confirmation",
22
- )
23
- parser.add_argument(
24
- "--since",
25
- type=int,
26
- help="The number of seconds ago to clear results for",
27
- )
28
-
29
- def handle(self, *args, **options):
30
- no_input = options["no_input"]
31
- since = options.get("since") or DJANGO_QSTASH_RESULT_TTL
32
- cutoff_date = timezone.now() - timedelta(seconds=since)
33
- try:
34
- TaskResult = apps.get_model("django_qstash_results", "TaskResult")
35
- except LookupError:
36
- self.stdout.write(
37
- self.style.ERROR(
38
- "Django QStash Results not installed.\nAdd `django_qstash.results` to INSTALLED_APPS and run migrations."
39
- )
40
- )
41
- return
42
- to_delete = TaskResult.objects.filter(date_done__lt=cutoff_date)
43
-
44
- if not to_delete.exists():
45
- self.stdout.write("No stale Django QStash task results found")
46
- return
47
-
48
- # use input to confirm deletion
49
- self.stdout.write(
50
- f"Deleting {to_delete.count()} task results older than {cutoff_date} ({DJANGO_QSTASH_RESULT_TTL} seconds)"
51
- )
52
- if not no_input:
53
- if input("Are you sure? (y/n): ") != "y":
54
- self.stdout.write("Skipping deletion")
55
- return
56
-
57
- deleted_count, _ = to_delete.delete()
58
-
59
- self.stdout.write(
60
- self.style.SUCCESS(f"Successfully deleted {deleted_count} stale results.")
61
- )
@@ -1,53 +0,0 @@
1
- from unittest.mock import Mock, patch
2
-
3
- import pytest
4
-
5
- from django_qstash.tasks import shared_task
6
-
7
-
8
- @shared_task
9
- def sample_task(x, y):
10
- return x + y
11
-
12
-
13
- @shared_task(name="custom_task", deduplicated=True)
14
- def sample_task_with_options(x, y):
15
- return x * y
16
-
17
-
18
- @pytest.mark.django_db
19
- class TestQStashTasks:
20
- def test_basic_task_execution(self):
21
- """Test that tasks can be executed directly"""
22
- result = sample_task(2, 3)
23
- assert result == 5
24
-
25
- def test_task_with_options(self):
26
- """Test that tasks with custom options work"""
27
- result = sample_task_with_options(4, 5)
28
- assert result == 20
29
-
30
- @patch("django_qstash.tasks.qstash_client")
31
- def test_task_delay(self, mock_client):
32
- """Test that delay() sends task to QStash"""
33
- mock_response = Mock()
34
- mock_response.message_id = "test-id-123"
35
- mock_client.message.publish_json.return_value = mock_response
36
-
37
- result = sample_task.delay(2, 3)
38
-
39
- assert result.task_id == "test-id-123"
40
- mock_client.message.publish_json.assert_called_once()
41
-
42
- @patch("django_qstash.tasks.qstash_client")
43
- def test_task_apply_async(self, mock_client):
44
- """Test that apply_async() works with countdown"""
45
- mock_response = Mock()
46
- mock_response.message_id = "test-id-456"
47
- mock_client.message.publish_json.return_value = mock_response
48
-
49
- result = sample_task.apply_async(args=(2, 3), countdown=60)
50
-
51
- assert result.task_id == "test-id-456"
52
- call_kwargs = mock_client.message.publish_json.call_args[1]
53
- assert call_kwargs["delay"] == "60s"
File without changes
File without changes