Added 'SettingsDict'

Author: IvanKirpichnikov

docs/settings.md

@@ -1,10 +1,9 @@
 # Settings
 
 TODO: Discuss settings dict and options available
-TODO: Create SettingsDict type
 
 ```python
-settings = {
+settings_raw_dict = {
     "queue": queue,
     "functions": [test],
     "concurrency": 10,
@@ -14,4 +13,14 @@ settings = {
     "before_process": before_process,
     "after_process": after_process,
 }
+settings_typed_dict = SettingsDict(
+    queue=queue,
+    functions=[test],
+    concurrency=10,
+    cron_jobs=[CronJob(cron, cron="* * * * * */5")], # run every 5 seconds
+    startup=startup,
+    shutdown=shutdown,
+    before_process=before_process,
+    after_process=after_process,
+)
 ```

examples/map.py

@@ -24,6 +24,12 @@ async def sum_of_squares(ctx, *, n):
     "functions": [square, sum_of_squares],
     "concurrency": 100,
 }
+# or
+# settings = SettingsDict(
+#     queue=queue,
+#     functions=[square, sum_of_squares],
+#     concurrency=100,
+# )
 
 
 async def enqueue():

examples/propagation.py

@@ -36,6 +36,13 @@ async def before_process(ctx):
     "concurrency": 100,
     "before_process": before_process,
 }
+# or
+# settings = SettingsDict(
+#     queue=queue,
+#     functions=[recurse],
+#     concurrency=100,
+#     before_process"=before_process,
+# )
 
 
 class LoggingContextFilter(logging.Filter):

examples/simple.py

@@ -24,6 +24,12 @@ async def cron_job(ctx):
     "concurrency": 100,
     "cron_jobs": [CronJob(cron_job, cron="* * * * * */5")],
 }
+# or
+# settings = SettingsDict(
+#     functions=[sleeper, adder],
+#     concurrency=100,
+#     cron_jobs=[CronJob(cron_job, cron="* * * * * */5")],
+# }
 
 
 async def enqueue(func, **kwargs):

saq/types.py

@@ -5,11 +5,13 @@
 from __future__ import annotations
 
 import typing as t
+from collections.abc import Collection
+
 
 if t.TYPE_CHECKING:
     from asyncio import Task
 
-    from saq.job import Job, Status
+    from saq.job import CronJob, Job, Status
     from saq.worker import Worker
     from saq.queue import Queue
     from typing_extensions import Required
@@ -97,6 +99,23 @@ class PartialTimersDict(TimersDict, total=False):
     """
 
 
+class SettingsDict(t.TypedDict, total=False):
+    """
+    Settings
+    """
+
+    queue: Queue
+    functions: Required[Collection[Function | tuple[str, Function]]]
+    concurrency: int
+    cron_jobs: Collection[CronJob]
+    startup: ReceivesContext
+    shutdown: ReceivesContext
+    before_process: ReceivesContext
+    after_process: ReceivesContext
+    timers: PartialTimersDict
+    dequeue_timeout: float
+
+
 BeforeEnqueueType = t.Callable[["Job"], t.Awaitable[t.Any]]
 CountKind = t.Literal["queued", "active", "incomplete"]
 DumpType = t.Callable[[t.Mapping[t.Any, t.Any]], str]

saq/worker.py

@@ -31,6 +31,7 @@
         JobTaskContext,
         PartialTimersDict,
         ReceivesContext,
+        SettingsDict,
         TimersDict,
     )
 
@@ -310,7 +311,7 @@ async def wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:
     return wrapped
 
 
-def import_settings(settings: str) -> dict[str, t.Any]:
+def import_settings(settings: str) -> SettingsDict:
     import importlib
 
     # given a.b.c, parses out a.b as the module path and c as the variable