fix:scheduler_worker command argument

Author: cunla

docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v4.0.3 🌈
+
+### 🐛 Bug Fixes
+
+- Updated `scheduler_worker` management command argument to `--without-scheduler` since the worker has a scheduler by
+  default.
+
 ## v4.0.2 🌈
 
 ### 🐛 Bug Fixes

docs/commands.md

@@ -8,8 +8,11 @@ If no queues are specified, will run on default queue only.
 All queues must have the same redis settings on `SCHEDULER_QUEUES`.
 
 ```shell
-usage: manage.py scheduler_worker [-h] [--pid PIDFILE] [--name NAME] [--worker-ttl WORKER_TTL] [--fork-job-execution FORK_JOB_EXECUTION] [--sentry-dsn SENTRY_DSN] [--sentry-debug] [--sentry-ca-certs SENTRY_CA_CERTS] [--burst]
-                                  [--max-jobs MAX_JOBS] [--max-idle-time MAX_IDLE_TIME] [--with-scheduler] [--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] [--force-color]
+usage: manage.py scheduler_worker [-h] [--pid PIDFILE] [--name NAME] [--worker-ttl WORKER_TTL]
+                                  [--fork-job-execution FORK_JOB_EXECUTION] [--sentry-dsn SENTRY_DSN] [--sentry-debug]
+                                  [--sentry-ca-certs SENTRY_CA_CERTS] [--burst] [--max-jobs MAX_JOBS]
+                                  [--max-idle-time MAX_IDLE_TIME] [--without-scheduler] [--version] [-v {0,1,2,3}]
+                                  [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] [--force-color]
                                   [--skip-checks]
                                   [queues ...]
 
@@ -33,14 +36,15 @@ options:
   --max-jobs MAX_JOBS   Maximum number of jobs to execute before terminating worker
   --max-idle-time MAX_IDLE_TIME
                         Maximum number of seconds to wait for new job before terminating worker
-  --with-scheduler      Run worker with scheduler, default to True
+  --without-scheduler   Run worker without scheduler, default to with scheduler
   --version             Show program's version number and exit.
-  -v {0,1,2,3}, --verbosity {0,1,2,3}
+  -v, --verbosity {0,1,2,3}
                         Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output
-  --settings SETTINGS   The Python path to a settings module, e.g. "myproject.settings.main". If this isn't provided, the DJANGO_SETTINGS_MODULE environment variable will be used.
+  --settings SETTINGS   The Python path to a settings module, e.g. "myproject.settings.main". If this isn't provided, the
+                        DJANGO_SETTINGS_MODULE environment variable will be used.
   --pythonpath PYTHONPATH
                         A directory to add to the Python path, e.g. "/home/djangoprojects/myproject".
-  --traceback           Raise on CommandError exceptions.
+  --traceback           Display a full stack trace on CommandError exceptions.
   --no-color            Don't colorize the command output.
   --force-color         Force colorization of the command output.
   --skip-checks         Skip system checks.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "django-tasks-scheduler"
-version = "4.0.2"
+version = "4.0.3"
 description = "An async job scheduler for django using redis/valkey brokers"
 authors = [{ name = "Daniel Moran", email = "[email protected]" }]
 requires-python = "~=3.10"

scheduler/management/commands/scheduler_worker.py

@@ -83,11 +83,11 @@ def _add_work_args(self, parser):
             help="Maximum number of seconds to wait for new job before terminating worker",
         )
         parser.add_argument(
-            "--with-scheduler",
-            action="store_true",
+            "--without-scheduler",
+            action="store_false",
             default=True,
             dest="with_scheduler",
-            help="Run worker with scheduler, default to True",
+            help="Run worker without scheduler, default to with scheduler",
         )
 
     def add_arguments(self, parser):

scheduler/tests/test_mgmt_commands/test_scheduler_worker.py

@@ -1,3 +1,5 @@
+from unittest import mock
+
 from django.core.management import call_command
 from django.test import TestCase
 
@@ -28,6 +30,26 @@ def test_scheduler_worker__no_queues_params(self):
             self.assertTrue(job.is_failed)
         SCHEDULER_CONFIG.SCHEDULER_INTERVAL = 10
 
+    @mock.patch("scheduler.worker.create_worker")
+    def test_scheduler_worker__without_scheduler(self, mock_create_worker):
+        queue = get_queue("default")
+
+        # Create a worker to execute these jobs
+        call_command("scheduler_worker", "default", "--without-scheduler")
+        mock_create_worker.assert_called_once_with(
+            'default', name=None, fork_job_execution=True, burst=False, with_scheduler=False,
+        )
+
+    @mock.patch("scheduler.worker.create_worker")
+    def test_scheduler_worker__with_scheduler(self, mock_create_worker):
+        queue = get_queue("default")
+
+        # Create a worker to execute these jobs
+        call_command("scheduler_worker", "default")
+        mock_create_worker.assert_called_once_with(
+            'default', name=None, fork_job_execution=True, burst=False, with_scheduler=True,
+        )
+
     def test_scheduler_worker__run_jobs(self):
         SCHEDULER_CONFIG.SCHEDULER_INTERVAL = 1
         queue = get_queue("default")