steady-queue 0.1.6__tar.gz → 0.1.8__tar.gz

{steady_queue-0.1.6/steady_queue.egg-info → steady_queue-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steady-queue
-Version: 0.1.6
+Version: 0.1.8
 Summary: An asynchronous task library for Django that supports delayed tasks, concurrency controls, recurring tasks, pausing queues, numeric priorities per task, priorities by queue order and bulk enqueueing.
 Author-email: Elias Hernandis <elias@hernandis.me>
 License-Expression: MIT
@@ -505,8 +505,7 @@ There are several settings that control how Steady Queue works that you can set
   requesting immediate termination—defaults to 5 seconds.
 - `supervisor_pidfile`: path to a pidfile that the supervisor will create when
   booting to prevent running more than one supervisor in the same host, or in
-  case you want to use it for a health check. It's set to
-  `tmp/pids/steady_queue_supervisor.pid` by default.
+  case you want to use it for a health check. It's `None` by default.
 - `preserve_finished_jobs`: whether to keep finished jobs in the
   `steady_queue_jobs` table—defaults to `True`.
 - `clear_finished_jobs_after`: period to keep finished jobs around, in case

{steady_queue-0.1.6 → steady_queue-0.1.8}/README.md

@@ -479,8 +479,7 @@ There are several settings that control how Steady Queue works that you can set
   requesting immediate termination—defaults to 5 seconds.
 - `supervisor_pidfile`: path to a pidfile that the supervisor will create when
   booting to prevent running more than one supervisor in the same host, or in
-  case you want to use it for a health check. It's set to
-  `tmp/pids/steady_queue_supervisor.pid` by default.
+  case you want to use it for a health check. It's `None` by default.
 - `preserve_finished_jobs`: whether to keep finished jobs in the
   `steady_queue_jobs` table—defaults to `True`.
 - `clear_finished_jobs_after`: period to keep finished jobs around, in case

{steady_queue-0.1.6 → steady_queue-0.1.8}/pyproject.toml

@@ -64,6 +64,9 @@ ignore_missing_imports = true
 django_settings_module = "tests.settings"
 
 [dependency-groups]
+docs = [
+    "sphinx>=8.0",
+]
 dev = [
     "coverage>=7.13.4",
     "django-environ>=0.12.0",

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/__init__.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
 from typing import Optional
 
-VERSION = (0, 1, 6)
+VERSION = (0, 1, 8)
 
 __version__ = ".".join(map(str, VERSION))
 
@@ -17,6 +17,6 @@ clear_finished_jobs_after: timedelta = timedelta(days=1)
 
 default_concurrency_control_period: timedelta = timedelta(minutes=3)
 
-supervisor_pidfile: Optional[str] = "tmp/pids/steady_queue_supervisor.pid"
+supervisor_pidfile: Optional[str] = None
 
 database: str = "default"

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/configuration.py

@@ -132,6 +132,9 @@ class Configuration:
         if self.options.only_work:
             return self.workers
 
+        if self.skip_recurring:
+            return self.workers + self.dispatchers
+
         return self.workers + self.dispatchers + self.schedulers
 
     @property

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/processes/maintenance.py

@@ -21,7 +21,8 @@ class Maintenance:
         self.maintenance_task.start()
 
     def stop_maintenance_task(self):
-        self.maintenance_task.stop()
+        if hasattr(self, "maintenance_task"):
+            self.maintenance_task.stop()
 
     def fail_orphaned_executions(self):
         with AppExecutor.wrap_in_app_executor():

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/processes/pidfile.py

@@ -1,3 +1,4 @@
+import atexit
 import os
 
 
@@ -9,6 +10,7 @@ class Pidfile:
     def setup(self):
         self.check_status()
         self.write_file()
+        self.set_at_exit_hook()
 
     def delete(self):
         self.delete_file()
@@ -36,6 +38,9 @@ class Pidfile:
             self.check_status()
             self.write_file()
 
+    def set_at_exit_hook(self):
+        atexit.register(lambda: self.delete() if os.getpid() == self.pid else None)
+
     def delete_file(self):
         try:
             os.unlink(self.path)

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/processes/registrable.py

@@ -63,6 +63,8 @@ class Registrable(Base):
         self.heartbeat_task.start()
 
     def stop_heartbeat(self):
+        if not hasattr(self, "heartbeat_task"):
+            return
         logger.debug("stopping heartbeat for %s", self.name)
         self.heartbeat_task.stop()
         logger.debug("stopped heartbeat for %s", self.name)

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/processes/supervisor.py

@@ -48,7 +48,7 @@ class Supervisor(Maintenance, Signals, Pidfiled, Registrable, Interruptible, Bas
         except SystemExit:
             logger.info("supervisor interrupted during boot, shutting down")
             self.restore_default_signal_handlers()
-            self.delete_pidfile()
+            self.shutdown()
             return
         self.supervise()
 
@@ -154,7 +154,7 @@ class Supervisor(Maintenance, Signals, Pidfiled, Registrable, Interruptible, Bas
             if terminated_fork and (not is_exited or exit_status > 0):
                 self.handle_claimed_jobs_by(terminated_fork, wait_status)
 
-            self.configured_processes.pop(pid)
+            self.configured_processes.pop(pid, None)
 
     def replace_fork(self, pid: int, exitcode: int) -> None:
         logger.info("replacing fork %s due to exit code %s", pid, exitcode)

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/processes/timer.py

@@ -39,7 +39,7 @@ class TimerTask:
         self._stop_event = threading.Event()
 
     def start(self):
-        self.thread = threading.Thread(target=self.run)
+        self.thread = threading.Thread(target=self.run, daemon=True)
         self.thread.start()
 
     def stop(self):
@@ -69,7 +69,7 @@ class TimerTask:
 
     def perform_task(self):
         # Run the callable in a separate thread to isolate crashes
-        work_thread = threading.Thread(target=self.wrapped_callable)
+        work_thread = threading.Thread(target=self.wrapped_callable, daemon=True)
         work_thread.start()
         work_thread.join()
 

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue/recurring_task.py

@@ -20,7 +20,7 @@ def recurring(
     """
     Decorator for registering a task to run on a recurring schedule.
 
-    Usage:
+    Example::
 
         @recurring(schedule="*/1 * * * *", key="unique_task_key")
         @task()

{steady_queue-0.1.6 → steady_queue-0.1.8/steady_queue.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steady-queue
-Version: 0.1.6
+Version: 0.1.8
 Summary: An asynchronous task library for Django that supports delayed tasks, concurrency controls, recurring tasks, pausing queues, numeric priorities per task, priorities by queue order and bulk enqueueing.
 Author-email: Elias Hernandis <elias@hernandis.me>
 License-Expression: MIT
@@ -505,8 +505,7 @@ There are several settings that control how Steady Queue works that you can set
   requesting immediate termination—defaults to 5 seconds.
 - `supervisor_pidfile`: path to a pidfile that the supervisor will create when
   booting to prevent running more than one supervisor in the same host, or in
-  case you want to use it for a health check. It's set to
-  `tmp/pids/steady_queue_supervisor.pid` by default.
+  case you want to use it for a health check. It's `None` by default.
 - `preserve_finished_jobs`: whether to keep finished jobs in the
   `steady_queue_jobs` table—defaults to `True`.
 - `clear_finished_jobs_after`: period to keep finished jobs around, in case

{steady_queue-0.1.6 → steady_queue-0.1.8}/steady_queue.egg-info/SOURCES.txt

@@ -74,6 +74,7 @@ tests/test_configuration.py
 tests/test_db_router.py
 tests/test_executions.py
 tests/test_job.py
+tests/test_pidfile.py
 tests/test_process_lifecycle.py
 tests/test_queue_selector.py
 tests/test_recurring_task.py

{steady_queue-0.1.6 → steady_queue-0.1.8}/tests/test_configuration.py

@@ -220,6 +220,16 @@ class ConfigurationValidationTestCase(SimpleTestCase):
         errors = config.validate_recurring_tasks()
         self.assertEqual(len(errors), 0)
 
+    def test_skip_recurring_excludes_schedulers_from_configured_processes(self):
+        """skip_recurring option excludes scheduler processes."""
+        options = Configuration.Options(skip_recurring=True)
+        config = Configuration(options)
+
+        process_kinds = [p.kind for p in config.configured_processes]
+        self.assertNotIn("scheduler", process_kinds)
+        self.assertIn("worker", process_kinds)
+        self.assertIn("dispatcher", process_kinds)
+
 
 class RecurringTaskConfigurationTestCase(SimpleTestCase):
     """Tests for recurring task configuration."""

steady_queue-0.1.8/tests/test_pidfile.py

@@ -0,0 +1,42 @@
+import os
+from tempfile import TemporaryDirectory
+from unittest.mock import patch
+
+from django.test import SimpleTestCase
+
+import steady_queue
+from steady_queue.processes.pidfile import Pidfile
+
+
+class PidfileDefaultsTestCase(SimpleTestCase):
+    def test_supervisor_pidfile_defaults_to_none(self):
+        self.assertIsNone(steady_queue.supervisor_pidfile)
+
+
+class PidfileLifecycleTestCase(SimpleTestCase):
+    def test_setup_registers_atexit_cleanup_hook(self):
+        with TemporaryDirectory() as temp_dir, patch("atexit.register") as register:
+            path = os.path.join(temp_dir, "pids", "steady_queue_supervisor.pid")
+
+            pidfile = Pidfile(path)
+            pidfile.setup()
+
+            register.assert_called_once()
+            self.assertTrue(os.path.exists(path))
+            with open(path) as f:
+                self.assertEqual(str(os.getpid()), f.read().strip())
+
+    def test_setup_replaces_stale_pidfile_for_dead_process(self):
+        with TemporaryDirectory() as temp_dir:
+            path = os.path.join(temp_dir, "pids", "steady_queue_supervisor.pid")
+
+            os.makedirs(os.path.dirname(path), exist_ok=True)
+            with open(path, "w") as f:
+                f.write("999999")
+
+            with patch("atexit.register"):
+                pidfile = Pidfile(path)
+                pidfile.setup()
+
+            with open(path) as f:
+                self.assertEqual(str(os.getpid()), f.read().strip())