feat: adds redis kwargs and info command

feat: adds redis kwargs and info command

Author: cofin

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.0.292"
+    rev: "v0.1.0"
     hooks:
       - id: ruff
         args: ["--fix"]
@@ -53,6 +53,6 @@ repos:
             "litestar[cli]",
           ]
   - repo: https://github.com/sphinx-contrib/sphinx-lint
-    rev: "v0.6.8"
+    rev: "v0.8.1"
     hooks:
       - id: sphinx-lint

litestar_saq/cli.py

@@ -19,7 +19,7 @@ def build_cli_app() -> Group:
     from click import IntRange, group, option
     from litestar.cli._utils import LitestarGroup, console
 
-    @group(cls=LitestarGroup, name="workers")
+    @group(cls=LitestarGroup, name="workers", no_args_is_help=True)
     def background_worker_group() -> None:
         """Manage background task workers."""
 
@@ -66,6 +66,26 @@ def run_worker(
             for worker_instance in plugin.get_workers():
                 loop.run_until_complete(worker_instance.stop())
 
+    @background_worker_group.command(
+        name="status",
+        help="Check the status of currently configured workers and queues.",
+    )
+    @option("-v", "--verbose", help="Enable verbose logging.", is_flag=True, default=None, type=bool, required=False)
+    @option("-d", "--debug", help="Enable debugging.", is_flag=True, default=None, type=bool, required=False)
+    def worker_status(
+        app: Litestar,
+        verbose: bool | None,
+        debug: bool | None,
+    ) -> None:
+        """Run the API server."""
+        console.rule("[yellow]Checking SAQ worker status[/]", align="left")
+        if app.logging_config is not None:
+            app.logging_config.configure()
+        if debug is not None or verbose is not None:
+            app.debug = True
+        plugin = get_saq_plugin(app)
+        show_saq_info(app, 1, plugin)
+
     return background_worker_group
 
 

litestar_saq/config.py

@@ -62,6 +62,10 @@ class SAQConfig:
     """Pre-configured Redis instance to use."""
     redis_url: str | None = None
     """Redis URL to connect with."""
+    redis_kwargs: dict[str, Any] = field(
+        default_factory=lambda: {"socket_connect_timeout": 2, "socket_keepalive": 5, "health_check_interval": 5},
+    )
+    """Redis kwargs to pass into a redis instance."""
     namespace: str = "saq"
     """Namespace to use for Redis"""
     queue_instances: Mapping[str, Queue] | None = None
@@ -139,12 +143,8 @@ def get_redis(self) -> Redis:
             return self.redis
         pool = ConnectionPool.from_url(
             url=cast("str", self.redis_url),
-            decode_responses=False,
-            socket_connect_timeout=2,
-            socket_keepalive=5,
-            health_check_interval=5,
         )
-        self.redis = Redis(connection_pool=pool)
+        self.redis = Redis(connection_pool=pool, **self.redis_kwargs)
         return self.redis
 
     def get_queues(self) -> TaskQueues:

pdm.lock

@@ -30,7 +30,7 @@ license = {text = "MIT"}
 name = "litestar-saq"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.1.8"
+version = "0.1.9"
 
 [project.urls]
 Changelog = "https://cofin.github.io/litesatr-saq/latest/changelog"