shelltastic 0.8.2__tar.gz → 0.9.1__tar.gz

{shelltastic-0.8.2 → shelltastic-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shelltastic
-Version: 0.8.2
+Version: 0.9.1
 Summary: A fantastic shell command runner for python
 Author: Bearmine
 License-Expression: MPL-2.0

shelltastic-0.9.1/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "shelltastic"
+version = "0.9.1"
+description = "A fantastic shell command runner for python"
+readme = "README.md"
+license = "MPL-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+dependencies = []
+
+[[project.authors]]
+name = "Bearmine"
+
+[project.urls]
+Repository = "https://forge.bearmine.com/bearmine/shelltastic"
+
+[dependency-groups]
+lint = ["ruff"]
+test = [
+    "pytest",
+    "pytest-cov>=7.1.0",
+]
+
+[[dependency-groups.dev]]
+include-group = "lint"
+
+[[dependency-groups.dev]]
+include-group = "test"
+
+[build-system]
+requires = ["uv_build>=0.11.18,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.ruff.lint]
+extend-select = [
+    "F",
+    "W",
+    "E",
+    "I",
+    "UP",
+    "C4",
+    "FA",
+    "ISC",
+    "ICN",
+    "RET",
+    "SIM",
+    "TID",
+    "TC",
+    "PTH",
+    "TD",
+    "NPY",
+    "FURB",
+]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 100
+
+[tool.pytest.ini_options]
+addopts = "--cov=shelltastic --cov-report html"

shelltastic-0.8.2/pyproject.toml → shelltastic-0.9.1/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "shelltastic"
-version = "0.8.2"
+version = "0.9.1"
 description = "A fantastic shell command runner for python"
 readme = "README.md"
 authors = [
@@ -13,6 +13,19 @@ license-files = [
 requires-python = ">=3.12"
 dependencies = []
 
+[dependency-groups]
+dev = [
+  {include-group = "lint"},
+  {include-group = "test"},
+]
+lint = [
+  "ruff"
+]
+test = [
+  "pytest",
+  "pytest-cov>=7.1.0"
+]
+
 [project.urls]
 Repository = "https://forge.bearmine.com/bearmine/shelltastic"
 
@@ -44,14 +57,5 @@ extend-select = [
 [tool.ruff.lint.pycodestyle]
 max-line-length = 100
 
-[dependency-groups]
-dev = [
-  {include-group = "lint"},
-  {include-group = "test"}
-]
-lint = [
-  "ruff"
-]
-test = [
-  "pytest"
-]
+[tool.pytest.ini_options]
+addopts = "--cov=shelltastic --cov-report html"

{shelltastic-0.8.2 → shelltastic-0.9.1}/src/shelltastic/backend/base.py

@@ -92,12 +92,10 @@ _backend_shims: list[BackendShim] = []
 
 def clear_shims():
     """Clear all shims"""
-    global _backend_shims
     _backend_shims.clear()
 
 def add_shim(shim: BackendShim):
     """Add a shim to manipulate `ShellBackend` params before any `ShellBackend` runs"""
-    global _backend_shims
     _backend_shims.append(shim)
 
 

{shelltastic-0.8.2 → shelltastic-0.9.1}/src/shelltastic/backend/default/common.py

@@ -1,3 +1,4 @@
+import contextlib
 import logging
 import os
 import shlex
@@ -233,32 +234,35 @@ class CommonShellAsyncResult(ShellResultAsync[RawIOBase | None, RawIOBase | None
         return self._stderr
 
     def __exit__(self, exc_type, exc, tb):
-        self.close()
+        with contextlib.suppress(KeyboardInterrupt, subprocess.TimeoutExpired):
+            self.close()
 
-    def close(self) -> None:
+    def close(self, timeout: float | None = None) -> None:
         if self._closed:
             return
 
-        # Terminate popen
-        self._popen.terminate()
-
         # Wait for command to finish before closing everything
-        self.wait()
-
-        # Close stdout and stderr
-        if self.stdout is not None:
-            self.stdout.close()
-        if self.stderr is not None:
-            self.stderr.close()
-
-        self._closed = True
+        try:
+            self._popen.wait(timeout)
+        except (KeyboardInterrupt, subprocess.TimeoutExpired):
+            # Kill the process and then reraise
+            self._popen.kill()
+            LOGGER.error("pid %s killed", self._popen.pid)
+            raise
+        finally:
+            # Close stdout and stderr
+            if self.stdout is not None:
+                self.stdout.close()
+            if self.stderr is not None:
+                self.stderr.close()
+
+            self._closed = True
 
     def terminate(self) -> None:
         if self._closed:
             raise ShellClosedException(f"{self} is closed")
 
         self._popen.terminate()
-        self.close()
 
     def result(self) -> ShellResult[RawIOBase | None, RawIOBase | None]:
         if self._closed:

{shelltastic-0.8.2 → shelltastic-0.9.1}/src/shelltastic/enum.py

@@ -3,6 +3,8 @@ from enum import Enum, auto
 
 class SystemType(Enum):
     DEBIAN_BASED = auto()
+    CACHYOS = auto()
+    WINDOWS = auto()
     UNKNOWN = auto()
 
 

{shelltastic-0.8.2 → shelltastic-0.9.1}/src/shelltastic/frontend/shell.py

@@ -18,8 +18,11 @@ if TYPE_CHECKING:
 
 
 class ShellFrontend:
+    __slots__ = ("_backend", "_cached_system_type")
+
     def __init__(self, backend: ShellBackend) -> None:
         self._backend = backend
+        self._cached_system_type = None
 
     def which(self, command: str) -> Path | None:
         """Return the path to the command or None if the command is not on the path."""
@@ -34,12 +37,20 @@ class ShellFrontend:
 
     def file_exists(self, path: str | Path) -> bool:
         """Returns true if the file at the given path exists and false if it doesn't."""
-        result = self.run(
-            f'stat "{path}"',
-            check=False,
-            stdout=CaptureMode.DEVNULL,
-            stderr=CaptureMode.DEVNULL,
-        )
+        if self.system_type() == SystemType.WINDOWS:
+            result = self.run(
+                f'IF EXIST "{path}" (exit 0) ELSE (exit 1)',
+                check=False,
+                stdout=CaptureMode.DEVNULL,
+                stderr=CaptureMode.DEVNULL,
+            )
+        else:
+            result = self.run(
+                f'stat "{path}"',
+                check=False,
+                stdout=CaptureMode.DEVNULL,
+                stderr=CaptureMode.DEVNULL,
+            )
         return result.returncode == 0
 
     def home_dir(self) -> Path:
@@ -50,20 +61,55 @@ class ShellFrontend:
         assert result.stdout is not None
         return Path(result.stdout.decode().strip())
 
-    def system_type(self) -> SystemType:
-        """Return system type"""
+    def _system_type(self) -> SystemType:
         if (
+            "Linux"
+            in self.run(
+                "uname -o",
+                check=False,
+                stdout=CaptureMode.PIPE,
+                stderr=CaptureMode.DEVNULL,
+            ).stdout.decode("utf-8")  # type: ignore
+        ):
+            # Linux
+            if (
+                self.run(
+                    "stat /etc/debian_version",
+                    check=False,
+                    stdout=CaptureMode.DEVNULL,
+                    stderr=CaptureMode.DEVNULL,
+                ).returncode
+                == 0
+            ):
+                return SystemType.DEBIAN_BASED
+
+            if "cachyos" in self.run(
+                "uname -r",
+                check=False,
+                stdout=CaptureMode.PIPE,
+                stderr=CaptureMode.DEVNULL,
+            ).stdout.decode("utf-8"):  # type: ignore
+                return SystemType.CACHYOS
+        elif (
             self.run(
-                "stat /etc/debian_version",
+                "echo %OS%",
                 check=False,
-                stdout=CaptureMode.DEVNULL,
+                stdout=CaptureMode.PIPE,
                 stderr=CaptureMode.DEVNULL,
-            ).returncode
-            == 0
+            )
+            .stdout.decode("utf-8")  # type: ignore
+            .strip()
+            == "Windows_NT"
         ):
-            return SystemType.DEBIAN_BASED
+            return SystemType.WINDOWS
         return SystemType.UNKNOWN
 
+    def system_type(self) -> SystemType:
+        """Return system type"""
+        if not self._cached_system_type:
+            self._cached_system_type = self._system_type()
+        return self._cached_system_type
+
     def run(
         self,
         cmd: str | list[str],

{shelltastic-0.8.2 → shelltastic-0.9.1}/src/shelltastic/__init__.py

@@ -6,14 +6,14 @@ from shelltastic.host import Host
 from shelltastic.result import ShellResult
 
 __all__ = [
-    "shell",
-    "scp",
-    "git",
-    "DisplayMode",
     "CaptureMode",
-    "SystemType",
+    "DisplayMode",
     "Host",
     "ShellResult",
+    "SystemType",
+    "git",
+    "scp",
+    "shell",
 ]
 
 shell = LocalShellFrontend()

{shelltastic-0.8.2 → shelltastic-0.9.1}/src/shelltastic/backend/__init__.py

@@ -11,16 +11,16 @@ from shelltastic.backend.default.remote import DefaultRemoteBackend
 from shelltastic.host import Host
 
 __all__ = [
+    "BackendShim",
     "LocalShellBackend",
     "RemoteShellBackend",
-    "BackendShim",
     "ShellBackend",
-    "register_default_local_backend",
-    "register_default_remote_backend",
     "add_shim",
     "clear_shims",
     "get_local_backend",
     "get_remote_backend",
+    "register_default_local_backend",
+    "register_default_remote_backend",
 ]
 
 _default_local_backend: type[LocalShellBackend] = DefaultLocalBackend