django-crontask 1.2.0__tar.gz → 2.0.0__tar.gz

{django_crontask-1.2.0 → django_crontask-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-crontask
-Version: 1.2.0
+Version: 2.0.0
 Summary: Cron style scheduler for Django's task framework.
 Keywords: Django,cron,tasks,scheduler
 Author-email: Rust Saiargaliev <fly.amureki@gmail.com>, Johannes Maron <johannes@maron.family>, Mostafa Mohamed <mostafa.anm91@gmail.com>, Jacqueline Kraus <jacquelinekraus1992@gmail.com>
@@ -152,6 +152,15 @@ The monitor's slug will be the actor's name. Like `my_task` in the example above
 Certain triggers are not supported by Sentry as well as sub-minute intervals.
 In these cases, no monitor will be created and no telemetry will be sent.
 
+Pass a custom config via `sentry_monitor_config` or set it to `None`
+to disable Sentry monitoring for a single task:
+
+```python
+@cron("* * * * *", sentry_monitor_config=None)
+@task
+def my_task_without_sentry(): ...
+```
+
 ### The crontask command
 
 ```ShellSession

{django_crontask-1.2.0 → django_crontask-2.0.0}/README.md

@@ -110,6 +110,15 @@ The monitor's slug will be the actor's name. Like `my_task` in the example above
 Certain triggers are not supported by Sentry as well as sub-minute intervals.
 In these cases, no monitor will be created and no telemetry will be sent.
 
+Pass a custom config via `sentry_monitor_config` or set it to `None`
+to disable Sentry monitoring for a single task:
+
+```python
+@cron("* * * * *", sentry_monitor_config=None)
+@task
+def my_task_without_sentry(): ...
+```
+
 ### The crontask command
 
 ```ShellSession

{django_crontask-1.2.0 → django_crontask-2.0.0}/crontask/__init__.py

@@ -1,21 +1,19 @@
 """Cron style scheduler for Django's task framework."""
 
 import typing
-import warnings
 from unittest.mock import Mock
 
 from apscheduler.schedulers.base import STATE_STOPPED
 from apscheduler.schedulers.blocking import BlockingScheduler
 from apscheduler.triggers.base import BaseTrigger
 from apscheduler.triggers.cron import CronTrigger
-from apscheduler.triggers.interval import IntervalTrigger
 from django.tasks import Task
 from django.utils import timezone
 
 from . import _version
 from .contrib import sentry
 
-__all__ = ["cron", "interval", "scheduler", "VERSION", "__version__"]
+__all__ = ["cron", "scheduler", "VERSION", "__version__"]
 
 __version__ = _version.version
 VERSION = _version.version_tuple
@@ -34,9 +32,14 @@ class LazyBlockingScheduler(BlockingScheduler):
 
 
 scheduler = LazyBlockingScheduler()
+UNSET = object()
 
 
-def cron(schedule: str | BaseTrigger) -> typing.Callable[[Task], Task]:
+def cron(
+    schedule: str | BaseTrigger,
+    *,
+    sentry_monitor_config: dict[str, dict[str, str | int] | str] | None = UNSET,
+) -> typing.Callable[[Task], Task]:
     """
     Run task on a scheduler with a cron schedule.
 
@@ -46,8 +49,10 @@ def cron(schedule: str | BaseTrigger) -> typing.Callable[[Task], Task]:
         def cron_test():
             print("Cron test")
 
-    Sentry cron monitors are automatically upserted on every check-in
-    using the task name as the monitor slug.
+    Args:
+        schedule: A cron schedule string or an APScheduler trigger.
+        sentry_monitor_config: A Sentry monitor configuration dict or None to disable monitoring.
+
     """
 
     def decorator(task: Task) -> Task:
@@ -67,7 +72,14 @@ def cron(schedule: str | BaseTrigger) -> typing.Callable[[Task], Task]:
         else:
             trigger = schedule
 
-        task = sentry.monitor_cron_task(task, trigger)
+        if sentry_monitor_config is not None:
+            task = sentry.monitor_cron_task(
+                task,
+                trigger,
+                sentry_monitor_config={}
+                if sentry_monitor_config is UNSET
+                else sentry_monitor_config,
+            )
 
         scheduler.add_job(
             func=task.enqueue,
@@ -79,25 +91,3 @@ def cron(schedule: str | BaseTrigger) -> typing.Callable[[Task], Task]:
         return task
 
     return decorator
-
-
-def interval(*, seconds):
-    """
-    Run task on a periodic interval.
-
-    The interval decorator is deprecated and will be removed in a future release.
-    Please use the cron decorator with an 'IntervalTrigger' instead.
-    """
-    warnings.warn(
-        "The interval decorator is deprecated and will be removed in a future release. "
-        "Please use the cron decorator with an 'IntervalTrigger' instead.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-
-    return cron(
-        IntervalTrigger(
-            seconds=seconds,
-            timezone=timezone.get_default_timezone(),
-        )
-    )

{django_crontask-1.2.0 → django_crontask-2.0.0}/crontask/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.2.0'
-__version_tuple__ = version_tuple = (1, 2, 0)
+__version__ = version = '2.0.0'
+__version_tuple__ = version_tuple = (2, 0, 0)
 
-__commit_id__ = commit_id = 'gae12a07e2'
+__commit_id__ = commit_id = 'gfbe0c7d7f'

{django_crontask-1.2.0 → django_crontask-2.0.0}/crontask/contrib/sentry.py

@@ -1,5 +1,3 @@
-import typing
-
 from apscheduler.triggers.base import BaseTrigger
 from apscheduler.triggers.calendarinterval import CalendarIntervalTrigger
 from apscheduler.triggers.cron import CronTrigger
@@ -8,7 +6,9 @@ from django.tasks import Task
 from django.utils import timezone
 
 
-def trigger_to_monitor_config(trigger: BaseTrigger) -> dict[str, typing.Any] | None:
+def trigger_to_monitor_config(
+    trigger: BaseTrigger,
+) -> dict[str, dict[str, str | int] | str] | None:
     """Convert an APScheduler trigger to a Sentry monitor configuration if possible."""
     tz = str(timezone.get_default_timezone())
     match trigger:
@@ -62,7 +62,11 @@ def trigger_to_monitor_config(trigger: BaseTrigger) -> dict[str, typing.Any] | N
             return None
 
 
-def monitor_cron_task(task: Task, trigger: BaseTrigger) -> Task:
+def monitor_cron_task(
+    task: Task,
+    trigger: BaseTrigger,
+    sentry_monitor_config: dict[str, dict[str, str | int] | str],
+) -> Task:
     """
     Wrap the task function in a Sentry monitor for a suitable trigger.
 
@@ -75,7 +79,9 @@ def monitor_cron_task(task: Task, trigger: BaseTrigger) -> Task:
     except ImportError:
         return task
     else:
-        if monitor_config := trigger_to_monitor_config(trigger):
+        if monitor_config := sentry_monitor_config or trigger_to_monitor_config(
+            trigger
+        ):
             return type(task)(
                 priority=task.priority,
                 func=monitor(task.name, monitor_config=monitor_config)(task.func),

{django_crontask-1.2.0 → django_crontask-2.0.0}/crontask/utils.py

@@ -41,5 +41,7 @@ def extend_lock(lock, scheduler):
     try:
         lock.extend(get_settings().LOCK_TIMEOUT, True)
     except LockError:
-        scheduler.shutdown()
+        # `extend_lock` runs inside a scheduler worker thread;
+        # shutdown must be done from there to avoid a deadlock on the lock.
+        scheduler.shutdown(wait=False)
         raise