Merge pull request #346 from ewoks-kit/use_ruff

convert to ruff

Author: woutdenolf

.flake8

@@ -216,6 +216,11 @@ jobs:
   # Run linter / checks
   checks:
     uses: ewoks-kit/.github/.github/workflows/python-check.yml@main
+    with:
+      enable-black: "false"
+      enable-flake8: "false"
+      enable-isort: "false"
+      enable-ruff: "true"
 
   # Build documentation
   docs:

.github/workflows/test.yml

@@ -3,7 +3,6 @@
 !.gitignore
 !.github
 !.readthedocs.yaml
-!.flake8
 
 # Byte / compiled / optimized
 *.py[cod]

.gitignore

@@ -76,9 +76,7 @@ test = [
 ]
 dev = [
     "ewoksjob[test]",
-    "black >=25",
-    "flake8 >=4",
-    "isort",
+    "ruff>=0.16.0",
 ]
 doc = [
     "ewoksjob[worker]",
@@ -111,6 +109,25 @@ cancel = "ewoksjob.cli_utils.cancel:cancel"
 [tool.pytest.ini_options]
 timeout = 120
 
-[tool.isort]
-profile = "black"
-force_single_line = "True"
+[tool.ruff.lint]
+select = [
+    "E", # pycodestyle errors
+    "F", # pyflakes
+    "I", # isort
+    "S", # flake8-bandit
+]
+ignore = [
+    "E501", # line too long
+]
+
+[tool.ruff.lint.per-file-ignores]
+"src/ewoksjob/tests/*.py" = [
+    "S101"  # allow asserts
+]
+"scripts/*.py" = [
+    "S101"  # allow asserts
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+known-first-party = ["ewoksjob"]

pyproject.toml

@@ -10,10 +10,10 @@
 
 
 @click.command("cancel")
-@add_click_options(cli_cancel_utils.cancel_arguments(shell=True))
+@add_click_options(cli_cancel_utils.cancel_arguments(shell=True))  # noqa: S604
 def cancel(cli_args: Namespace) -> Optional[Literal[0, 1]]:
     """Abort an Ewoks job."""
-    result = command_cancel(cli_args, shell=True)
+    result = command_cancel(cli_args, shell=True)  # noqa: S604
     if result:
         click.get_current_context().exit(result)
 

src/ewoksjob/cli_utils/cancel.py

@@ -15,10 +15,10 @@
 
 
 @click.command("submit")
-@add_click_options(cli_submit_utils.submit_arguments(shell=True))
+@add_click_options(cli_submit_utils.submit_arguments(shell=True))  # noqa: S604
 def submit(cli_args: Namespace) -> Union[List[dict], Literal[0, 1]]:
     """Submit an Ewoks workflow."""
-    result = command_submit(cli_args, shell=True)
+    result = command_submit(cli_args, shell=True)  # noqa: S604
     if result:
         click.get_current_context().exit(result)
 

src/ewoksjob/cli_utils/submit.py

@@ -25,7 +25,6 @@ class RemoteExit(Exception):
 
 
 class LocalFuture(FutureInterface):
-
     def __init__(self, uuid: str, future: Optional[NATIVE_FUTURE_TYPES] = None) -> None:
         if future is None:
             from .pool import get_active_pool

src/ewoksjob/client/local/futures.py

@@ -1,5 +1,6 @@
 import json
 import os
+import re
 import socket
 from typing import Iterator
 
@@ -22,7 +23,7 @@ def get_events(self, job_id=None, **filters) -> Iterator[EventType]:
         is_equal_filter, post_filter = self.split_filter(**filters)
 
         if job_id:
-            pattern = f"ewoks:{job_id}:*"
+            pattern = f"ewoks:{_escape_glob(job_id)}:*"
         else:
             pattern = "ewoks:*"
         keys = sorted(
@@ -36,3 +37,11 @@ def get_events(self, job_id=None, **filters) -> Iterator[EventType]:
             ):
                 continue
             yield event
+
+
+# Escape glob-special characters so `job_id` is matched literally in a SCAN pattern.
+_GLOB_SPECIAL_RE = re.compile(r"([\\*?\[\]])")
+
+
+def _escape_glob(value: str) -> str:
+    return _GLOB_SPECIAL_RE.sub(r"\\\1", value)

src/ewoksjob/events/readers/redis.py

@@ -4,6 +4,7 @@
 import pytest
 from ewokscore import events
 
+from ..events.readers.redis import _escape_glob
 from .utils import has_redis
 
 
@@ -88,3 +89,16 @@ def assert_stop_event(reader):
     stop_event.set()
     thread.join(timeout=3)
     assert not thread.is_alive()
+
+
+@pytest.mark.parametrize(
+    "job_id,expected",
+    [
+        ("plainid", "plainid"),
+        ("has*star", "has\\*star"),
+        ("has?mark", "has\\?mark"),
+        ("has[bracket]", "has\\[bracket\\]"),
+    ],
+)
+def test_redis_escape_glob(job_id, expected):
+    assert _escape_glob(job_id) == expected

src/ewoksjob/tests/test_events.py

@@ -1,4 +1,5 @@
 import logging
+import shutil
 import subprocess
 import time
 from types import ModuleType
@@ -15,9 +16,13 @@ def has_redis() -> bool:
 
 
 def _check_redis_server() -> bool:
+    redis_server = shutil.which("redis-server")
+    if redis_server is None:
+        logger.debug("Unable to find 'redis-server' executable.'")
+        return False
     try:
-        result = subprocess.run(
-            ["redis-server", "--version"], capture_output=True, text=True, check=True
+        result = subprocess.run(  # noqa: S603 (resolved via shutil.which)
+            [redis_server, "--version"], capture_output=True, text=True, check=True
         )
         return bool(result.stdout.strip())
     except Exception: