fractal-server 2.14.5__py3-none-any.whl → 2.14.6__py3-none-any.whl

fractal_server/ssh/_fabric.py

@@ -1,18 +1,18 @@
 import json
 import logging
 import time
+from collections.abc import Generator
 from contextlib import contextmanager
 from pathlib import Path
 from threading import Lock
 from typing import Any
-from typing import Generator
 from typing import Literal
-from typing import Optional
 
 import paramiko.sftp_client
 from fabric import Connection
 from invoke import UnexpectedExit
 from paramiko.ssh_exception import NoValidConnectionsError
+from pydantic import BaseModel
 
 from ..logger import get_logger
 from ..logger import set_logger
@@ -35,6 +35,12 @@ class FractalSSHUnknownError(RuntimeError):
     pass
 
 
+class SSHConfig(BaseModel):
+    host: str
+    user: str
+    key_path: str
+
+
 logger = set_logger(__name__)
 
 
@@ -75,7 +81,7 @@ def _acquire_lock_with_timeout(
             logger.info(f"Lock for '{label}' was released.")
 
 
-class FractalSSH(object):
+class FractalSSH:
     """
     Wrapper of `fabric.Connection` object, enriched with locks.
 
@@ -159,7 +165,7 @@ class FractalSSH(object):
         raise e
 
     def _run(
-        self, *args, label: str, lock_timeout: Optional[float] = None, **kwargs
+        self, *args, label: str, lock_timeout: float | None = None, **kwargs
     ) -> Any:
         actual_lock_timeout = self.default_lock_timeout
         if lock_timeout is not None:
@@ -275,10 +281,10 @@ class FractalSSH(object):
         self,
         *,
         cmd: str,
-        allow_char: Optional[str] = None,
-        max_attempts: Optional[int] = None,
-        base_interval: Optional[float] = None,
-        lock_timeout: Optional[int] = None,
+        allow_char: str | None = None,
+        max_attempts: int | None = None,
+        base_interval: float | None = None,
+        lock_timeout: int | None = None,
     ) -> str:
         """
         Run a command within an open SSH connection.
@@ -375,7 +381,7 @@ class FractalSSH(object):
         *,
         local: str,
         remote: str,
-        lock_timeout: Optional[float] = None,
+        lock_timeout: float | None = None,
     ) -> None:
         """
         Transfer a file via SSH
@@ -415,7 +421,7 @@ class FractalSSH(object):
         *,
         local: str,
         remote: str,
-        lock_timeout: Optional[float] = None,
+        lock_timeout: float | None = None,
     ) -> None:
         """
         Transfer a file via SSH
@@ -506,7 +512,7 @@ class FractalSSH(object):
         *,
         path: str,
         content: str,
-        lock_timeout: Optional[float] = None,
+        lock_timeout: float | None = None,
     ) -> None:
         """
         Open a remote file via SFTP and write it.
@@ -560,7 +566,7 @@ class FractalSSH(object):
                 )
 
 
-class FractalSSHList(object):
+class FractalSSHList:
     """
     Collection of `FractalSSH` objects
 
@@ -714,3 +720,22 @@ class FractalSSHList(object):
                 f"({fractal_ssh_obj.is_connected=})."
             )
             fractal_ssh_obj.close()
+
+
+@contextmanager
+def SingleUseFractalSSH(
+    *,
+    ssh_config: SSHConfig,
+    logger_name: str,
+) -> Generator[FractalSSH, Any, None]:
+    """
+    Get a new FractalSSH object (with a fresh connection).
+
+    Args:
+        ssh_config:
+        logger_name:
+    """
+    _fractal_ssh_list = FractalSSHList(logger_name=logger_name)
+    _fractal_ssh = _fractal_ssh_list.get(**ssh_config.model_dump())
+    yield _fractal_ssh
+    _fractal_ssh.close()

fractal_server/string_tools.py

@@ -1,5 +1,5 @@
 import string
-from typing import Optional
+
 
 __SPECIAL_CHARACTERS__ = f"{string.punctuation}{string.whitespace}"
 
@@ -36,7 +36,7 @@ def sanitize_string(value: str) -> str:
 def validate_cmd(
     command: str,
     *,
-    allow_char: Optional[str] = None,
+    allow_char: str | None = None,
     attribute_name: str = "Command",
 ):
     """

fractal_server/syringe.py

@@ -34,8 +34,8 @@ or popped from the directory.
     >>> bar()
     42
 """
+from collections.abc import Callable
 from typing import Any
-from typing import Callable
 from typing import TypeVar
 
 

fractal_server/tasks/v2/local/collect.py

@@ -4,7 +4,6 @@ import shutil
 import time
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Optional
 
 from ..utils_database import create_db_tasks_and_update_task_group_sync
 from ._utils import _customize_and_run_template
@@ -39,7 +38,7 @@ def collect_local(
     *,
     task_group_activity_id: int,
     task_group_id: int,
-    wheel_file: Optional[WheelFile] = None,
+    wheel_file: WheelFile | None = None,
 ) -> None:
     """
     Collect a task package.
@@ -132,7 +131,7 @@ def collect_local(
                     ).as_posix(),
                     prefix=(
                         f"{int(time.time())}_"
-                        f"{TaskGroupActivityActionV2.COLLECT.value}_"
+                        f"{TaskGroupActivityActionV2.COLLECT}_"
                     ),
                     logger_name=LOGGER_NAME,
                 )

fractal_server/tasks/v2/local/deactivate.py

@@ -107,7 +107,7 @@ def deactivate_local(
                         ).as_posix(),
                         prefix=(
                             f"{int(time.time())}_"
-                            f"{TaskGroupActivityActionV2.DEACTIVATE.value}_"
+                            f"{TaskGroupActivityActionV2.DEACTIVATE}_"
                         ),
                         logger_name=LOGGER_NAME,
                     )

fractal_server/tasks/v2/local/reactivate.py

@@ -107,7 +107,7 @@ def reactivate_local(
                     ).as_posix(),
                     prefix=(
                         f"{int(time.time())}_"
-                        f"{TaskGroupActivityActionV2.REACTIVATE.value}_"
+                        f"{TaskGroupActivityActionV2.REACTIVATE}_"
                     ),
                     logger_name=LOGGER_NAME,
                 )