fix: SchedulerConfiguration

Author: cunla

docs/changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v4.0.0b2 🌈
+
+- Fix bug when `SCHEDULER_CONFIG` is `SchedulerConfiguration`
 ## v4.0.0b1 🌈
 
 ### Breaking Changes

docs/configuration.md

@@ -7,10 +7,10 @@ All default settings for scheduler can be in one dictionary in `settings.py`:
 ```python
 from typing import Dict
 
-from scheduler.settings_types import SchedulerConfig, Broker, QueueConfiguration, UnixSignalDeathPenalty
+from scheduler.settings_types import SchedulerConfiguration, Broker, QueueConfiguration, UnixSignalDeathPenalty
 
 
-SCHEDULER_CONFIG = SchedulerConfig(
+SCHEDULER_CONFIG = SchedulerConfiguration(
     EXECUTIONS_IN_PAGE=20,
     SCHEDULER_INTERVAL=10,
     BROKER=Broker.REDIS,

docs/installation.md

@@ -52,9 +52,9 @@
 
 4. Optional: Configure default values for queuing jobs from code:
    ```python
-   from scheduler.settings_types import SchedulerConfig, Broker,  UnixSignalDeathPenalty
+   from scheduler.settings_types import SchedulerConfiguration, Broker,  UnixSignalDeathPenalty
 
-   SCHEDULER_CONFIG = SchedulerConfig(
+   SCHEDULER_CONFIG = SchedulerConfiguration(
     EXECUTIONS_IN_PAGE=20,
     SCHEDULER_INTERVAL=10,
     BROKER=Broker.REDIS,

docs/usage.md

@@ -43,7 +43,7 @@ You can set in `settings.py` a default value for `DEFAULT_JOB_TTL` and `DEFAULT_
 
 ```python
 # settings.py
-SCHEDULER_CONFIG = SchedulerConfig(
+SCHEDULER_CONFIG = SchedulerConfiguration(
     DEFAULT_SUCCESS_TTL=10 * 60,  # Time To Live (TTL) in seconds to keep successful job results
     DEFAULT_FAILURE_TTL=365 * 24 * 60 * 60,  # Time To Live (TTL) in seconds to keep job failure information
     DEFAULT_JOB_TTL=10 * 60,  # Time To Live (TTL) in seconds to keep job information

pyproject.toml

@@ -7,7 +7,7 @@ name = "django-tasks-scheduler"
 packages = [
     { include = "scheduler" },
 ]
-version = "4.0.0b1"
+version = "4.0.0b2"
 description = "An async job scheduler for django using redis/valkey brokers"
 readme = "README.md"
 keywords = ["redis", "valkey", "django", "background-jobs", "job-queue", "task-queue", "redis-queue", "scheduled-jobs"]

scheduler/__init__.py

@@ -4,9 +4,9 @@
 
 __all__ = [
     "QueueConfiguration",
-    "SchedulerConfig",
+    "SchedulerConfiguration",
     "job",
 ]
 
-from scheduler.settings_types import QueueConfiguration, SchedulerConfig
+from scheduler.settings_types import QueueConfiguration, SchedulerConfiguration
 from scheduler.decorators import job

scheduler/settings.py

@@ -4,13 +4,13 @@
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
-from scheduler.settings_types import SchedulerConfig, Broker, QueueConfiguration
+from scheduler.settings_types import SchedulerConfiguration, Broker, QueueConfiguration
 
 logger = logging.getLogger("scheduler")
 logging.basicConfig(level=logging.DEBUG)
 
 _QUEUES: Dict[str, QueueConfiguration] = dict()
-SCHEDULER_CONFIG: SchedulerConfig = SchedulerConfig()
+SCHEDULER_CONFIG: SchedulerConfiguration = SchedulerConfiguration()
 
 
 class QueueNotFoundError(Exception):
@@ -35,14 +35,15 @@ def conf_settings():
             _QUEUES[queue_name] = QueueConfiguration(**queue_config)
 
     user_settings = getattr(settings, "SCHEDULER_CONFIG", {})
-    if "FAKEREDIS" in user_settings:
-        logger.warning("Configuration using FAKEREDIS is deprecated. Use BROKER='fakeredis' instead")
-        user_settings["BROKER"] = Broker.FAKEREDIS if user_settings["FAKEREDIS"] else Broker.REDIS
-        user_settings.pop("FAKEREDIS")
-    for k in user_settings:
-        if k not in SCHEDULER_CONFIG.__annotations__:
-            raise ImproperlyConfigured(f"Unknown setting {k} in SCHEDULER_CONFIG")
-        setattr(SCHEDULER_CONFIG, k, user_settings[k])
+    if isinstance(user_settings, dict):
+        if "FAKEREDIS" in user_settings:
+            logger.warning("Configuration using FAKEREDIS is deprecated. Use BROKER='fakeredis' instead")
+            user_settings["BROKER"] = Broker.FAKEREDIS if user_settings["FAKEREDIS"] else Broker.REDIS
+            user_settings.pop("FAKEREDIS")
+        for k in user_settings:
+            if k not in SCHEDULER_CONFIG.__annotations__:
+                raise ImproperlyConfigured(f"Unknown setting {k} in SCHEDULER_CONFIG")
+            setattr(SCHEDULER_CONFIG, k, user_settings[k])
 
 
 conf_settings()

scheduler/settings_types.py

@@ -16,7 +16,7 @@ def _token_validation(token: str) -> bool:
 
 
 @dataclass(slots=True, kw_only=True)
-class SchedulerConfig:
+class SchedulerConfiguration:
     """Configuration for django-tasks-scheduler"""
 
     EXECUTIONS_IN_PAGE: int = 20