socx-cli 0.11.2__tar.gz → 0.11.4__tar.gz

{socx_cli-0.11.2 → socx_cli-0.11.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: socx-cli
-Version: 0.11.2
+Version: 0.11.4
 Summary: System on chip verification and tooling infrastructure.
 Project-URL: Issues, https://github.com/sagikimhi/socx-cli/issues
 Project-URL: Homepage, https://sagikimhi.dev/socx-cli

{socx_cli-0.11.2 → socx_cli-0.11.4}/pyproject.toml

@@ -29,7 +29,7 @@ socx = 'socx.__main__:main'
 [project]
 name = "socx-cli"
 readme = "README.md"
-version = "0.11.2"
+version = "0.11.4"
 license = "Apache-2.0"
 authors = [{ name = "Sagi Kimhi", email = "sagi.kim5@gmail.com" }]
 maintainers = [{ name = "Sagi Kimhi", email = "sagi.kim5@gmail.com" }]
@@ -107,6 +107,7 @@ dev = [
     "hatch-uvenv",
     "objexplore>=1.6.3",
     "ipython>=8.38.0",
+    "ty>=0.0.14",
 ]
 docs = [
     "mike",

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx/config/converters.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import os
 import sys
 import abc
 import runpy
@@ -17,6 +18,7 @@ from typing import (
     override,
     TypeVar,
     ClassVar,
+    Generic,
 )
 from pathlib import Path
 from importlib import import_module
@@ -52,8 +54,11 @@ _validate = validate_call(config=ConfigDict(arbitrary_types_allowed=True))
 
 logger = logging.getLogger(__name__)
 
+TI = TypeVar("TI")
+TO = TypeVar("TO")
 
-class Converter[TI, TO](abc.ABC):
+
+class Converter(abc.ABC, Generic[TI, TO]):
     """Base protocol for Dynaconf converters used by SoCX."""
 
     @abc.abstractmethod
@@ -73,8 +78,6 @@ class Converter[TI, TO](abc.ABC):
         self, msg: str, *args: Any, exc: Exception | None = None, **kwargs: Any
     ) -> None:
         """Log a recoverable converter error message."""
-        if exc is not None:
-            exc.add_note(msg)
         self.logger.exception(msg, *args, **kwargs)
 
     def convert(self, value: TI, *args: Any, **kwargs: Any) -> TO:
@@ -417,7 +420,7 @@ class CommandConverter(
         return cli
 
     @singledispatchmethod
-    def _run_shell_script(self, value, *args, **kwargs) -> int: ...
+    def _run_shell_script(self, value, *args, **kwargs): ...
 
     @_run_shell_script.register
     def _(
@@ -450,12 +453,15 @@ class CommandConverter(
         env = env or {}
         cwd = local.path(cwd)
 
-        with local.env(), local.cwd(cwd):
+        if not fresh_env:
+            env = dict(os.environ, **env)
+
+        with local.env(env), local.cwd(cwd):
             if fresh_env:
                 local.env.clear()
 
             local.env.update(env)
-            cmd = value.with_cwd(cwd)
+            cmd = value.with_cwd(cwd).with_env(**env)
             cmd_str = str(cmd)
             cwd_str = str(cwd)
             env_str = "\n".join(f"\t{k}={v}" for k, v in local.env.items())
@@ -518,6 +524,7 @@ class CommandConverter(
         cwd = cwd or Path.cwd()
         ctx = click.get_current_context(silent=True)
         argv = sys.argv.copy()
+        environ = os.environ.copy()
 
         path, _, symbol = value.rpartition(":")
 
@@ -550,11 +557,11 @@ class CommandConverter(
         if self.is_script_path(path) or self.is_package_path(path):
             path = str(Path(path).resolve())
 
-        with local.cwd(cwd), local.env():
+        with local.cwd(cwd):
             if fresh_env:
-                local.env.clear()
+                os.environ.clear()
 
-            local.env.update(env)
+            os.environ.update(env)
 
             try:
                 if self.is_module_path(path) and symbol:
@@ -591,6 +598,8 @@ class CommandConverter(
                 self.log_exception(err)
             finally:
                 sys.argv = argv
+                os.environ.clear()
+                os.environ.update(environ)
 
         return rv
 
@@ -766,9 +775,9 @@ class ShConverter(
     def __call__(  # pyright: ignore[reportIncompatibleMethodOverride]
         self,
         value,
-        *args: Any,
-        **kwargs: Any,
-    ) -> Lazy | Script: ...
+        *args,
+        **kwargs,
+    ): ...
 
     @__call__.register
     def _(self, value: Lazy) -> Lazy:
@@ -821,7 +830,7 @@ class MarkdownConverter(Converter[str | Lazy | Markdown | None, str | Lazy]):
         return value
 
 
-class GenericConverter[TI, TO](Converter[TI, TO]):
+class GenericConverter(Converter[TI, TO]):
     """Adapter turning plain callables into ``Converter`` instances."""
 
     def __init__(self, name: str, cvt: Callable[..., TO]) -> None:

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx/core/encoder.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import Any
+from typing import Any, TypeVar, Generic
 
+T = TypeVar("T")
 
-class Encoder[T](ABC):
+
+class Encoder(ABC, Generic[T]):
     """Generic protocol for converting values into configuration payloads."""
 
     @classmethod

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx/core/serializer.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import Any
+from typing import Any, TypeVar, Generic
 
+T = TypeVar("T")
 
-class Serializer[T](ABC):
+
+class Serializer(ABC, Generic[T]):
     """Generic protocol for converting values into configuration payloads."""
 
     @classmethod

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx/patterns/visitor/protocol.py

@@ -2,11 +2,14 @@
 
 from __future__ import annotations
 
-from typing import Protocol
+from typing import Protocol, TypeVar, Generic
 from collections.abc import Iterable
 
 
-class Visitor[NODE](Protocol):
+NODE = TypeVar("NODE")
+
+
+class Visitor(Protocol, Generic[NODE]):
     """Protocol describing objects that can visit nodes."""
 
     __slots__ = ()
@@ -16,7 +19,7 @@ class Visitor[NODE](Protocol):
         ...
 
 
-class Node[NODE](Protocol):
+class Node(Protocol, Generic[NODE]):
     """Protocol for nodes that accept visitors."""
 
     __slots__ = ()
@@ -26,7 +29,7 @@ class Node[NODE](Protocol):
         ...
 
 
-class Structure[NODE](Protocol):
+class Structure(Protocol, Generic[NODE]):
     """Protocol for structures exposing child relationships."""
 
     __slots__ = ()
@@ -37,7 +40,7 @@ class Structure[NODE](Protocol):
         ...
 
 
-class Traversal[NODE](Protocol):
+class Traversal(Protocol, Generic[NODE]):
     """Adapter interface that controls how nodes accept visitors."""
 
     __slots__ = ()

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx/patterns/visitor/traversal.py

@@ -1,13 +1,17 @@
 """Traversal strategies compatible with the visitor protocol."""
 
 from __future__ import annotations
+from typing import TypeVar
 
 from socx.patterns.visitor.protocol import Visitor
 from socx.patterns.visitor.protocol import Structure
 from socx.patterns.visitor.protocol import Traversal
 
 
-class TopDownTraversal[NODE](Traversal[NODE]):
+NODE = TypeVar("NODE")
+
+
+class TopDownTraversal(Traversal[NODE]):
     """Pre-order traversal that visits parents before descendants."""
 
     @classmethod
@@ -19,7 +23,7 @@ class TopDownTraversal[NODE](Traversal[NODE]):
             cls.accept(c, v, p)
 
 
-class BottomUpTraversal[NODE](Traversal[NODE]):
+class BottomUpTraversal(Traversal[NODE]):
     """Post-order traversal that visits descendants before parents."""
 
     @classmethod
@@ -31,7 +35,7 @@ class BottomUpTraversal[NODE](Traversal[NODE]):
         v.visit(n)
 
 
-class ByLevelTraversal[NODE](Traversal[NODE]):
+class ByLevelTraversal(Traversal[NODE]):
     """Breadth-first traversal that visits nodes one level at a time."""
 
     @classmethod

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx/static/settings/regression.yaml

@@ -5,6 +5,6 @@ regression:
   run:
     input:
       filename: small
-      directory: "@path @format {this.paths.app_root_dir}/assets/rgr/inputs"
+      directory: "@path @jinja {{this.paths.app_root_dir}}/assets/rgr/inputs"
     output:
       directory: "@path workrun/regression"

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx_plugins/config/_config.py

@@ -20,12 +20,7 @@ def edit_config():
         Path(file).stem: Path(settings.app_settings_dir / file)
         for file in settings.dynaconf_include
     }
-
-    for name in files:
-        try:
-            files[name] = files[name].resolve()
-        except OSError:
-            del files[name]
+    files = {k: v.resolve() for k, v in files.items() if v.exists()}
 
     file_choice = Prompt.ask(
         console=console,

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx_plugins/rgr/_rgr.py

@@ -28,17 +28,17 @@ def _input() -> Decorator:
     return click.argument(
         "input",
         help="A file containing a list of test commands to be ran.",
-        metavar="[<args>...]",
+        metavar="<file>",
         required=True,
         callback=input_cb,
-        expose_value=True,
+        expose_value=False,
         type=click.Path(
             exists=True,
-            file_okay=True,
-            dir_okay=False,
             readable=True,
-            resolve_path=True,
+            dir_okay=False,
+            file_okay=True,
             path_type=Path,
+            resolve_path=True,
         ),
     )
 
@@ -51,19 +51,18 @@ def _output() -> Decorator:
         "output",
         help="Output directory for writing passed/failed run commands.",
         nargs=1,
+        metavar="[<directory>]",
         type=click.Path(
             exists=False,
-            file_okay=False,
             dir_okay=True,
-            resolve_path=True,
+            file_okay=False,
             path_type=Path,
+            resolve_path=True,
         ),
         default=settings.regression.run.output.directory,
         callback=output_cb,
-        required=True,
-        show_envvar=True,
         show_default=True,
-        expose_value=True,
+        expose_value=False,
     )
 
 
@@ -72,28 +71,23 @@ def options() -> Decorator:
     return join_decorators(_input(), _output())
 
 
-def _correct_path_in(input_path: str | Path | None = None) -> Path:
+def _get_input_path() -> Path:
     """Resolve the regression input path from CLI value or settings."""
-    if input_path is None:
-        input_cfg = settings.regression.run.input
-        dir_in = input_cfg.directory
-        file_in = input_cfg.filename
-        input_path = Path(f"{dir_in}/{file_in}")
-
-    if isinstance(input_path, str):
-        input_path = Path(input_path)
-
-    return input_path.resolve()
+    input_cfg = settings.regression.run.input
+    directory, filename = input_cfg.directory, input_cfg.filename
+    rv = (
+        (Path(directory) / filename)
+        if isinstance(directory, str)
+        else (directory / filename)
+    )
+    return rv.resolve()
 
 
-def _correct_paths_out(
-    regression: Regression,
-    output_path: str | Path | None = None,
-) -> Path:
+def _get_output_path(regression: Regression) -> Path:
     """Return timestamped output paths for passed and failed results."""
     now = time.strftime("%H-%M")
     today = time.strftime("%d-%m-%Y")
-    dir_out = output_path or settings.regression.run.output.directory  # pyright: ignore
+    dir_out = settings.regression.run.output.directory  # pyright: ignore
     if isinstance(dir_out, str):
         dir_out = Path(dir_out)
     dir_out = dir_out / regression.name / today / now
@@ -166,14 +160,11 @@ def populate_regression(filepath: Path) -> Regression:
     )
 
 
-async def run_from_file(
-    input: str | Path | None = None,  # noqa: A002
-    output: str | Path | None = None,
-) -> Regression:
+async def run_regression() -> Regression:
     """Run a regression using file inputs and persist the results."""
-    path_in = _correct_path_in(input)
+    path_in = _get_input_path()
     regression = populate_regression(path_in)
-    output_dir = _correct_paths_out(regression, output)
+    output_dir = _get_output_path(regression)
 
     try:
         async with asyncio.TaskGroup() as tg:

socx_cli-0.11.4/socx_plugins/rgr/callbacks.py

@@ -0,0 +1,28 @@
+"""Rich-Click callbacks for normalising regression CLI arguments."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from socx import settings, log, log_it
+from rich_click import Context, Parameter
+
+
+logger = log.get_logger(__name__)
+
+
+def input_cb(ctx: Context, param: Parameter, value: str | Path) -> Path:
+    """Normalise the regression input path and update configuration."""
+    path = Path(value) if isinstance(value, str) else value
+    settings.regression.run.input.update(
+        {"filename": path.name, "directory": path.parent}
+    )
+    return path
+
+
+@log_it(logger=logger)
+def output_cb(ctx: Context, param: Parameter, value: str | Path) -> Path:
+    """Normalise the regression output directory and update configuration."""
+    path = Path(value) if isinstance(value, str) else value
+    settings.regression.run.output.update({param.name: path})
+    return path

{socx_cli-0.11.2 → socx_cli-0.11.4}/socx_plugins/rgr/rgr.py

@@ -3,11 +3,10 @@
 from __future__ import annotations
 
 import asyncio
-from pathlib import Path
 
 from socx import settings, group, command
 
-from socx_plugins.rgr._rgr import options, run_from_file
+from socx_plugins.rgr._rgr import options, run_regression
 
 
 @group()
@@ -25,7 +24,7 @@ def tui() -> None:
 
 @command(parent=cli, no_args_is_help=True)
 @options()
-def run(input: Path, output: Path):  # noqa: A002
+def run():
     r"""Run a regression of multiple tests defined in FILE.
 
     The FILE argument is a file containing a list of test commands to be ran.
@@ -48,7 +47,7 @@ def run(input: Path, output: Path):  # noqa: A002
     """
     try:
         regression = asyncio.run(
-            run_from_file(input, output),
+            run_regression(),
             debug=settings.cli.params.debug,
         )
     except (asyncio.CancelledError, KeyboardInterrupt):

socx_cli-0.11.2/socx_plugins/rgr/callbacks.py

@@ -1,42 +0,0 @@
-"""Rich-Click callbacks for normalising regression CLI arguments."""
-
-# type: ignore
-from __future__ import annotations
-
-from pathlib import Path
-
-from socx import settings, log, log_it
-from rich_click import Context, Parameter
-
-
-logger = log.get_logger(__name__)
-
-
-def input_cb(ctx: Context, param: Parameter, value: str | Path) -> Path:
-    """Normalise the regression input path and update configuration."""
-    if value and isinstance(value, str):
-        path = Path(value)
-
-        if path.exists() and path.is_file():
-            input_ = {"filename": path.name, "directory": path.parent}
-            settings.set("regression.run.input", input_, merge=True)
-
-    file: str = settings.get("regression.run.input.filename")
-    directory: Path = Path(settings.get("regression.run.input.directory"))
-    input_path = directory / file
-    return input_path
-
-
-@log_it(logger=logger)
-def output_cb(ctx: Context, param: Parameter, value: str) -> str:
-    """Normalise the regression output directory and update configuration."""
-    if value:
-        path = Path(value)
-
-        if path.exists() and path.is_dir():
-            settings.set(
-                "regression.run.output", {"directory": path}, merge=True
-            )
-
-    output_path: Path = Path(settings.get("regression.run.output.directory"))
-    return output_path