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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-crontask
-Version: 1.1.2
+Version: 1.2.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>
@@ -11,7 +11,9 @@ Classifier: Programming Language :: Python
 Classifier: Environment :: Web Environment
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX
 Classifier: Topic :: Communications :: Email
 Classifier: Topic :: Text Processing :: Markup :: Markdown
 Classifier: Topic :: Software Development
@@ -29,7 +31,12 @@ Requires-Dist: django>=6.0
 Requires-Dist: redis ; extra == "redis"
 Requires-Dist: sentry-sdk ; extra == "sentry"
 Project-URL: Changelog, https://github.com/codingjoe/django-crontask/releases
-Project-URL: Project-URL, https://github.com/codingjoe/django-crontask
+Project-URL: Documentation, https://django-crontask.rtfd.io/
+Project-URL: Funding, https://github.com/sponsors/codingjoe
+Project-URL: Homepage, https://github.com/codingjoe/django-crontask
+Project-URL: Issues, https://github.com/codingjoe/django-crontask/issues
+Project-URL: Releasenotes, https://github.com/codingjoe/django-crontask/releases/latest
+Project-URL: Source, https://github.com/codingjoe/django-crontask
 Provides-Extra: redis
 Provides-Extra: sentry
 
@@ -139,9 +146,12 @@ def my_interval_task():
 
 ### Sentry Cron Monitors
 
-If you use [Sentry] you can add cron monitors to your tasks.
+If you use [Sentry] suitable tasks will be automatically monitored.
 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.
+
 ### The crontask command
 
 ```ShellSession

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

@@ -104,9 +104,12 @@ def my_interval_task():
 
 ### Sentry Cron Monitors
 
-If you use [Sentry] you can add cron monitors to your tasks.
+If you use [Sentry] suitable tasks will be automatically monitored.
 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.
+
 ### The crontask command
 
 ```ShellSession

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

@@ -13,12 +13,13 @@ from django.tasks import Task
 from django.utils import timezone
 
 from . import _version
+from .contrib import sentry
+
+__all__ = ["cron", "interval", "scheduler", "VERSION", "__version__"]
 
 __version__ = _version.version
 VERSION = _version.version_tuple
 
-__all__ = ["cron", "interval", "scheduler"]
-
 
 class LazyBlockingScheduler(BlockingScheduler):
     """Avoid annoying info logs for pending jobs."""
@@ -45,21 +46,15 @@ def cron(schedule: str | BaseTrigger) -> typing.Callable[[Task], Task]:
         def cron_test():
             print("Cron test")
 
-
-    Please don't forget to set up a sentry monitor for the actor, otherwise you won't
-    get any notifications if the cron job fails.
-
-    The monitor slug is your actor name, the schedule should be set to the same
-    cron schedule as the cron decorator. The schedule type should be set to cron.
-    The monitors timezone should be set to Europe/Berlin.
+    Sentry cron monitors are automatically upserted on every check-in
+    using the task name as the monitor slug.
     """
 
     def decorator(task: Task) -> Task:
-        trigger = schedule
         if isinstance(schedule, str):
             *_, day_schedule = schedule.split(" ")
-            # CronTrigger uses Python's timezone dependent first weekday,
-            # so in Berlin monday is 0 and sunday is 6. We use literals to avoid
+            # CronTrigger uses Python's timezone-dependent first weekday,
+            # so in Berlin Monday is 0, and Sunday is 6. We use literals to avoid
             # confusion. Literals are also more readable and crontab conform.
             if any(i.isdigit() for i in day_schedule):
                 raise ValueError(
@@ -69,22 +64,10 @@ def cron(schedule: str | BaseTrigger) -> typing.Callable[[Task], Task]:
                 schedule,
                 timezone=timezone.get_default_timezone(),
             )
-
-        try:
-            from sentry_sdk.crons import monitor
-        except ImportError:
-            fn = task.func
         else:
-            fn = monitor(task.name)(task.func)
-
-        task = type(task)(
-            priority=task.priority,
-            func=fn,
-            queue_name=task.queue_name,
-            backend=task.backend,
-            takes_context=task.takes_context,
-            run_after=task.run_after,
-        )
+            trigger = schedule
+
+        task = sentry.monitor_cron_task(task, trigger)
 
         scheduler.add_job(
             func=task.enqueue,

django_crontask-1.2.0/crontask/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+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)
+
+__commit_id__ = commit_id = 'gae12a07e2'

django_crontask-1.2.0/crontask/contrib/sentry.py

@@ -0,0 +1,88 @@
+import typing
+
+from apscheduler.triggers.base import BaseTrigger
+from apscheduler.triggers.calendarinterval import CalendarIntervalTrigger
+from apscheduler.triggers.cron import CronTrigger
+from apscheduler.triggers.interval import IntervalTrigger
+from django.tasks import Task
+from django.utils import timezone
+
+
+def trigger_to_monitor_config(trigger: BaseTrigger) -> dict[str, typing.Any] | None:
+    """Convert an APScheduler trigger to a Sentry monitor configuration if possible."""
+    tz = str(timezone.get_default_timezone())
+    match trigger:
+        case CronTrigger():
+            fields = {f.name: str(f) for f in trigger.fields}
+            return {
+                "schedule": {
+                    "type": "crontab",
+                    "value": "{minute} {hour} {day} {month} {day_of_week}".format(
+                        **fields
+                    ),
+                },
+                "timezone": tz,
+            }
+        case IntervalTrigger():
+            seconds = trigger.interval.total_seconds()
+            for unit, size in (
+                ("year", 31536000),
+                ("month", 2592000),
+                ("week", 604800),
+                ("day", 86400),
+                ("hour", 3600),
+                ("minute", 60),
+            ):
+                if seconds % size == 0:
+                    return {
+                        "schedule": {
+                            "type": "interval",
+                            "value": seconds // size,
+                            "unit": unit,
+                        },
+                        "timezone": tz,
+                    }
+            return None  # Less than a minute
+        case CalendarIntervalTrigger():
+            fields = {
+                "year": trigger.years,
+                "month": trigger.months,
+                "week": trigger.weeks,
+                "day": trigger.days,
+            }
+            set_fields = {k: v for k, v in fields.items() if v}
+            if len(set_fields) == 1:
+                ((unit, value),) = set_fields.items()
+                return {
+                    "schedule": {"type": "interval", "value": value, "unit": unit},
+                    "timezone": tz,
+                }
+            return None
+        case _:
+            return None
+
+
+def monitor_cron_task(task: Task, trigger: BaseTrigger) -> Task:
+    """
+    Wrap the task function in a Sentry monitor for a suitable trigger.
+
+    You don't need to create the monitor in advance since
+    the Sentry monitor configuration is upserted on each task execution.
+    If the trigger is not supported, the task is returned unchanged.
+    """
+    try:
+        from sentry_sdk import monitor
+    except ImportError:
+        return task
+    else:
+        if monitor_config := trigger_to_monitor_config(trigger):
+            return type(task)(
+                priority=task.priority,
+                func=monitor(task.name, monitor_config=monitor_config)(task.func),
+                queue_name=task.queue_name,
+                backend=task.backend,
+                takes_context=task.takes_context,
+                run_after=task.run_after,
+            )
+
+    return task

{django_crontask-1.1.2 → django_crontask-1.2.0}/crontask/management/commands/crontask.py

@@ -1,5 +1,6 @@
 import importlib
 import signal
+import sys
 
 from apscheduler.triggers.interval import IntervalTrigger
 from django.apps import apps
@@ -60,7 +61,11 @@ class Command(BaseCommand):
             self.stderr.write("Another scheduler is already running.")
 
     def launch_scheduler(self, lock, scheduler):
-        signal.signal(signal.SIGHUP, kill_softly)
+        match sys.platform:
+            case "win32":
+                signal.signal(signal.SIGBREAK, kill_softly)
+            case _:
+                signal.signal(signal.SIGHUP, kill_softly)
         signal.signal(signal.SIGTERM, kill_softly)
         signal.signal(signal.SIGINT, kill_softly)
         self.stdout.write(self.style.SUCCESS("Starting scheduler…"))

{django_crontask-1.1.2 → django_crontask-1.2.0}/pyproject.toml

@@ -20,7 +20,9 @@ classifiers = [
   "Environment :: Web Environment",
   "License :: OSI Approved :: BSD License",
   "Intended Audience :: Developers",
-  "Operating System :: OS Independent",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: MacOS :: MacOS X",
+  "Operating System :: POSIX",
   "Topic :: Communications :: Email",
   "Topic :: Text Processing :: Markup :: Markdown",
   "Topic :: Software Development",
@@ -41,8 +43,14 @@ sentry = ["sentry-sdk"]
 redis = ["redis"]
 
 [project.urls]
-Project-URL = "https://github.com/codingjoe/django-crontask"
+# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
+Homepage = "https://github.com/codingjoe/django-crontask"
 Changelog = "https://github.com/codingjoe/django-crontask/releases"
+Source = "https://github.com/codingjoe/django-crontask"
+Releasenotes = "https://github.com/codingjoe/django-crontask/releases/latest"
+Documentation = "https://django-crontask.rtfd.io/"
+Issues = "https://github.com/codingjoe/django-crontask/issues"
+Funding = "https://github.com/sponsors/codingjoe"
 
 [tool.flit.module]
 name = "crontask"

django_crontask-1.1.2/crontask/_version.py

@@ -1,34 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = [
-    "__version__",
-    "__version_tuple__",
-    "version",
-    "version_tuple",
-    "__commit_id__",
-    "commit_id",
-]
-
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-    COMMIT_ID = Union[str, None]
-else:
-    VERSION_TUPLE = object
-    COMMIT_ID = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-commit_id: COMMIT_ID
-__commit_id__: COMMIT_ID
-
-__version__ = version = '1.1.2'
-__version_tuple__ = version_tuple = (1, 1, 2)
-
-__commit_id__ = commit_id = 'g08c90d2cc'