socx-cli 0.13.8__tar.gz → 0.13.9__tar.gz

{socx_cli-0.13.8 → socx_cli-0.13.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: socx-cli
-Version: 0.13.8
+Version: 0.13.9
 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
@@ -29,6 +29,7 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Utilities
 Requires-Python: >=3.12
 Requires-Dist: anyio[trio]>=4.12.1
+Requires-Dist: blinker>=1.9.0
 Requires-Dist: click
 Requires-Dist: copier~=9.11
 Requires-Dist: declare
@@ -53,6 +54,7 @@ Requires-Dist: sh~=2.2
 Requires-Dist: sqlmodel>=0.0.31
 Requires-Dist: textual
 Requires-Dist: textual-fspicker>=0.6.0
+Requires-Dist: textual-serve>=1.1.3
 Requires-Dist: textual-speedups
 Requires-Dist: typer~=0.19
 Requires-Dist: uv

{socx_cli-0.13.8 → socx_cli-0.13.9}/pyproject.toml

@@ -29,7 +29,7 @@ socx = 'socx.__main__:main'
 [project]
 name = "socx-cli"
 readme = "README.md"
-version = "0.13.8"
+version = "0.13.9"
 license = "Apache-2.0"
 authors = [{ name = "Sagi Kimhi", email = "sagi.kim5@gmail.com" }]
 maintainers = [{ name = "Sagi Kimhi", email = "sagi.kim5@gmail.com" }]
@@ -83,6 +83,8 @@ dependencies = [
     "pydantic-settings>=2.12.0",
     "sqlmodel>=0.0.31",
     "anyio[trio]>=4.12.1",
+    "blinker>=1.9.0",
+    "textual-serve>=1.1.3",
 ]
 
 [project.urls]
@@ -129,7 +131,7 @@ docs = [
     "mkdocs-llmstxt>=0.4.0",
     "mkdocs-coverage",
     "mkdocs-glightbox",
-    "mkdocstrings-python",
+    "mkdocstrings[python]>=0.18",
     "mkdocs-material[git, recommended, imaging]",
     "mkdocs-section-index",
     "griffe-typingdoc>=0.3.0",

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/__init__.py

@@ -90,6 +90,7 @@ __all__ = (
     # config
     "schema",
     "settings",
+    "Model",
     "Script",
     "NewPath",
     "FilePath",
@@ -139,6 +140,7 @@ __all__ = (
 
 from socx.core import enums as enums
 from socx.core import schema as schema
+from socx.core import Model as Model
 from socx.core import Script as Script
 from socx.core import NewPath as NewPath
 from socx.core import FilePath as FilePath

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/cli/callbacks.py

@@ -46,10 +46,12 @@ def cwd_cb(ctx: Context, param: Parameter, value: Path) -> Path:
 def debug_cb(_: Context, param: Parameter, value: bool) -> bool:
     """Enable debug logging and persist the CLI switch to settings."""
     socx_logger = _get_logger()
+    settings[param.name] = value
     settings.cli.params[param.name] = value
     if value:
         set_level(Level.DEBUG, socx_logger)
         settings.cli.params["verbosity"] = get_level().name
+        settings.logging.handlers.console.level = Level.DEBUG.name
     return value
 
 

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/config/_config.py

@@ -10,6 +10,7 @@ from typing import Any
 from pathlib import Path
 
 from werkzeug.local import LocalProxy
+from dynaconf.base import Settings as DynaSettings
 
 from socx.config import converters
 from socx.core import (
@@ -21,7 +22,10 @@ from socx.config._settings import Settings
 from socx.patterns.mixins.proxy import ProxyMixin
 
 
-class SettingsProxy(ProxyMixin[Settings], Settings): ...
+class SettingsProxyBase(Settings, DynaSettings): ...
+
+
+class SettingsProxy(ProxyMixin[SettingsProxyBase], SettingsProxyBase): ...
 
 
 logger = logging.getLogger(__name__)

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/config/converters.py

@@ -25,7 +25,6 @@ from importlib import import_module
 from functools import cached_property, singledispatchmethod
 from collections.abc import Iterable, Callable
 
-import sh
 import rich_click as click
 import rich_click.patch as click_patch
 import rich_click.rich_click_theme as click_theme
@@ -679,7 +678,7 @@ class CommandConverter(
         )
 
     def is_shell_command(self, value: Any) -> bool:
-        return isinstance(value, sh.Command)
+        return isinstance(value, BaseCommand)
 
     def is_click_command(self, value: Any) -> bool:
         return isinstance(value, click.Command)

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/core/__init__.py

@@ -7,6 +7,7 @@ __all__ = (
     "schema",
     "metadata",
     # types
+    "Model",
     "Script",
     "NewPath",
     "FilePath",
@@ -57,6 +58,7 @@ from . import paths as paths
 from . import schema as schema
 from . import metadata as metadata
 
+from socx.core.schema import Model as Model
 from socx.core.schema import Script as Script
 from socx.core.schema import NewPath as NewPath
 from socx.core.schema import FilePath as FilePath

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/core/enums.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 import enum
 from typing import Self
 from pathlib import Path
-from functools import cache
 
 
 class AutoNumber(int, enum.ReprEnum):
@@ -18,22 +17,20 @@ class AutoNumber(int, enum.ReprEnum):
 
 
 class SettingsFormat(AutoNumber):
-    Json = ".json"
-    Yaml = ".yaml", ".yml"
+    Ini = ".ini", ".conf"
     Toml = ".toml"
-    Ini = ".ini"
-    Python = ".python"
+    Yaml = ".yaml", ".yml"
+    Json = ".json", ".jsonc", ".json5"
+    Python = ".py"
 
     def __init__(self, extension: str, *extensions: str) -> None:
         self.extensions = {extension, *extensions}
 
     @classmethod
-    @cache
     def all_extensions(cls) -> set[str]:
         return {extension for member in cls for extension in member.extensions}
 
     @classmethod
-    @cache
     def from_path(cls, path: str | Path) -> SettingsFormat:
         if isinstance(path, str):
             path = Path(path)

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/core/schema/__init__.py

@@ -2,6 +2,7 @@ __all__ = (
     "git",
     "types",
     "plugin",
+    "Model",
     "Script",
     "NewPath",
     "FilePath",
@@ -15,6 +16,7 @@ from . import plugin as plugin
 
 from .git import git as git
 
+from socx.core.schema.types import Model as Model
 from socx.core.schema.types import Script as Script
 from socx.core.schema.types import NewPath as NewPath
 from socx.core.schema.types import FilePath as FilePath

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/core/schema/plugin.py

@@ -7,18 +7,14 @@ from pathlib import Path
 
 from box import SBox
 import rich_click as click
-from pydantic import Field, BaseModel, ConfigDict
+from pydantic import Field
 
-from socx.core.schema.types import DirectoryPath, Script
+from socx.core.schema.types import DirectoryPath, Script, Model
 
 
-class PluginModel(BaseModel):
+class PluginModel(Model):
     """Metadata describing a plugin-backed CLI command."""
 
-    name: str = Field(
-        ..., pattern=r"[a-zA-Z0-9_-]+", description="Name of the plugin."
-    )
-
     cwd: DirectoryPath = Field(
         default_factory=Path.cwd,
         description=dedent("""
@@ -29,83 +25,89 @@ class PluginModel(BaseModel):
 
     env: dict[str, str] = Field(
         default_factory=dict,
-        description="""
-            Environment variables that should be present when the
-            command/script is invoked
-        """.strip(),
+        description=dedent("""
+        Environment variables that should be present when the
+        command/script is invoked
+        """),
+    )
+
+    name: str = Field(
+        ..., pattern=r"[a-zA-Z0-9_-]+", description="Name of the plugin."
+    )
+
+    help: str = Field(
+        default="",
+        description=dedent("""
+        Description of what the plugin does to be printed during plugin
+        invocation if any of -h or --help flags were passed with the
+        command.
+        """),
+    )
+
+    enabled: bool = Field(
+        True,
+        description=dedent("""
+        Enable/disable the plugin. Disabled plugins are hidden and cannot be
+        invoked from the commandline. Defaults to True.
+        """),
     )
 
     timeout: float | None = Field(
-        default=None,
+        None,
         ge=0,
-        description="""
+        description=dedent("""
         An optional timeout in seconds for the plugin execution.
         If left unspecified, then plugin execution may last indefinitely.
-        """,
-    )
-
-    enabled: bool = Field(
-        default=True,
-        description="""
-            Whether or not the plugin should be enabled.
-            If left unspecified, defaults to True.
-        """,
+        """),
     )
 
     fresh_env: bool = Field(
-        default=False,
-        description="""
-            Whether or not to execute the plugin in a fresh environment.
-            A fresh environment is an environment with no environment
-            variables defined other than those defined in the ``env`` field.
-            A non-fresh environment will contain all environment variables of
-            the current process, as well as any variables defined in the
-            ``env`` field.
-            If left unspecified, defaults to False.
-        """,
+        False,
+        description=dedent("""
+        Whether or not to execute the plugin in a fresh environment.
+        A fresh environment is an environment with no environment
+        variables defined other than those defined in the ``env`` field.
+        A non-fresh environment will contain all environment variables of
+        the current process, as well as any variables defined in the
+        ``env`` field.
+        If left unspecified, defaults to False.
+        """),
     )
 
     script: Script = Field(
-        default="",
-        description="""
-            A shell command or a path to an executable file to run on plugin
-            invocation.
-        """.strip(),
+        "",
+        description=dedent("""
+        A shell command or a path to an executable file to run on plugin
+        invocation.
+        """),
+        exclude_if=bool,
     )
 
     command: str | click.Command = Field(
         default="",
         pattern=r"(((((\w+)(.|/))*)(\w+))(:(\w+))?)?",
-        description="""
-            A path to a python module or symbol that will be called upon
-            plugin invocation specified in the form of
-            `<module_path/file_path>[:<symbol_name>]`.
-        """.strip(),
-    )
-
-    help: str = Field(
-        default="",
-        description="""
-        Description of what the plugin does to be printed during plugin
-        invocation if any of -h or --help flags were passed with the
-        command.
-    """.strip(),
+        exclude_if=bool,
+        description=dedent("""
+        A path to a python module or symbol that will be called upon
+        plugin invocation specified in the form of
+        `<module_path/file_path>[:<symbol_name>]`.
+        """),
     )
 
     panel: str = Field(
         default="Plugins",
-        description="""
+        description=dedent("""
         Custom panel name in which plugin help text will be displayed when
         CLI is invoked with the -h/--help flag.
-        """.strip(),
+        """),
     )
 
     epilog: str = Field(
         default="",
-        description="""
-            Help string printed at the end of the help page after everything
-            else.
-        """.strip(),
+        description=dedent("""
+        Help string printed at the end of the help page after everything
+        else.
+        """),
     )
 
     aliases: tuple[str, ...] = Field(
@@ -118,12 +120,6 @@ class PluginModel(BaseModel):
         description="The short help to use for this command",
     )
 
-    model_config = ConfigDict(
-        extra="allow",
-        from_attributes=True,
-        arbitrary_types_allowed=True,
-    )
-
     def is_script(self) -> bool:
         return bool(self.script)
 

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/core/schema/types.py

@@ -13,6 +13,8 @@ from pydantic import (
     GetJsonSchemaHandler,
     BeforeValidator,
     PlainSerializer,
+    ConfigDict,
+    BaseModel,
 )
 
 
@@ -232,3 +234,11 @@ Script = Annotated[
     BeforeValidator(validate_script),
     PlainSerializer(str, str),
 ]
+
+
+class Model(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+        from_attributes=True,
+        arbitrary_types_allowed=True,
+    )

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/io/console.py

@@ -121,7 +121,7 @@ _console_cv = contextvars.ContextVar[Console]("console")
 
 _console_cv.set(_console)
 
-console: ConsoleProxy = LocalProxy(  # type: ignore[assignment]
+console: ConsoleProxy = LocalProxy(
     _console_cv,
     unbound_message="""
     Working outside of application context.
@@ -129,4 +129,4 @@ console: ConsoleProxy = LocalProxy(  # type: ignore[assignment]
     Attempted to use functionality that expected a current application to
     be set. To solve this, set up an app context.
     """,
-)
+)  # ty:ignore[invalid-assignment]

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/io/log.py

@@ -139,26 +139,26 @@ def _get_file_handler(
     tracebacks_suppress: Iterable[ModuleType] | None = None,
     tracebacks_show_locals: bool = True,
 ) -> logging.Handler:
-    import atexit
 
     def close_if_open(file: IO) -> None:
         if not file.closed:
             file.close()
 
     mode = mode or "a"
-    file = open(path, mode=mode)  # noqa: SIM115
-    atexit.register(close_if_open, file)
-    handler = _get_console_handler(
-        file=file,
-        level=level,
-        stderr=stderr,
-        tab_size=tab_size,
-        tracebacks=tracebacks,
-        force_terminal=force_terminal,
-        tracebacks_theme=tracebacks_theme,
-        tracebacks_suppress=tracebacks_suppress,
-        tracebacks_show_locals=tracebacks_show_locals,
-    )
+    # file = open(path, mode=mode)
+    # atexit.register(close_if_open, file)
+    # handler = _get_console_handler(
+    #     file=file,
+    #     level=level,
+    #     stderr=stderr,
+    #     tab_size=tab_size,
+    #     tracebacks=tracebacks,
+    #     force_terminal=force_terminal,
+    #     tracebacks_theme=tracebacks_theme,
+    #     tracebacks_suppress=tracebacks_suppress,
+    #     tracebacks_show_locals=tracebacks_show_locals,
+    # )
+    handler = logging.handlers.WatchedFileHandler(path, mode)
     handler.name = "file"
     handler.setFormatter(DEFAULT_CHILD_FORMATTER)
     return handler

{socx_cli-0.13.8 → socx_cli-0.13.9}/socx/regression/regression.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import re
 import logging
-from typing import Any, Self
+from typing import Any, Self, cast
 from pathlib import Path
 from collections import OrderedDict
 from collections.abc import Mapping, Callable, Iterable
@@ -22,14 +22,24 @@ from pydantic import (
 )
 from anyio.abc import TaskStatus
 
-from socx.config import settings
-from socx.core.schema import FilePath
+from socx.config import settings, SymbolConverter
+from socx.core.schema import NewPath, FilePath, DirectoryPath
 from socx.regression.test import Test, TestBase, TestResult, TestStatus
 
 
+_sentinel = object()
+
+_converter = SymbolConverter()
+
+_filepath_adapter = TypeAdapter(FilePath)
+
+_directory_adapter = TypeAdapter(NewPath | DirectoryPath)
+
 logger = logging.getLogger(__name__)
 
-_sentinel = object()
+default_limiter = anyio.CapacityLimiter(
+    settings.regression.max_runs_in_parallel
+)
 
 
 def _safe_dir_name(name: str, node_id: UUID4) -> str:
@@ -37,7 +47,7 @@ def _safe_dir_name(name: str, node_id: UUID4) -> str:
     return f"{slug or 'item'}-{node_id}"
 
 
-def _coerce_status(value: TestStatus | int | str) -> TestStatus:
+def _coerce_status(value: int | str | TestStatus) -> TestStatus:
     if isinstance(value, TestStatus):
         return value
     if isinstance(value, int):
@@ -51,20 +61,15 @@ def _coerce_result(value: TestResult | str) -> TestResult:
     return TestResult(value)
 
 
-default_limiter = anyio.CapacityLimiter(
-    settings.regression.max_runs_in_parallel
-)
-
-
 class Regression(TestBase):
     """Manage and execute a collection of tests with concurrency control."""
 
-    test_map: OrderedDict[UUID4, SerializeAsAny[TestBase]] = Field(
-        default_factory=OrderedDict, repr=True, title="Test Map"
-    )
     limiter: anyio.CapacityLimiter = Field(
         default=default_limiter, exclude=True
     )
+    test_map: OrderedDict[UUID4, SerializeAsAny[TestBase]] = Field(
+        default_factory=OrderedDict, repr=True, title="Test Map"
+    )
 
     model_config = ConfigDict(
         title="Regression",
@@ -76,39 +81,54 @@ class Regression(TestBase):
         self,
         name: str,
         tests: list[TestBase] | None = None,
-        test_map: dict[UUID4, TestBase] | None = None,
         limiter: anyio.CapacityLimiter | None = None,
+        test_map: dict[UUID4, TestBase] | None = None,
+        output_dir: NewPath | DirectoryPath | None = None,
         **kwargs: Any,
     ) -> None:
         super().__init__(name=name, **kwargs)
         test_map = test_map or {}
         tests = [*list(test_map.values()), *(tests or [])]
-        self.test_map = OrderedDict({test.id: test for test in tests})
         self.limiter = limiter if limiter is not None else default_limiter
+        self.test_map = OrderedDict({test.id: test for test in tests})
+        self.output_dir = output_dir
+        if self.output_dir is not None:
+            self.assign_output_dir(self.output_dir)
 
     @classmethod
     @validate_call(config=ConfigDict(extra="allow"))
     def from_file(
         cls,
-        path: str | Path,
+        path: FilePath,
         name: str | None = None,
-        test_cls: type[TestBase] | None = None,
+        test_cls: str | type[Test] | None = None,
         **kwargs: Any,
     ) -> Self:
-        return cls._from_file(path, name=name, test_cls=test_cls, **kwargs)
+        if test_cls is None or not test_cls:
+            test_cls = Test
+
+        if isinstance(test_cls, str):
+            test_cls: type[Test] = _converter(test_cls)
+
+        return cls._from_file(
+            path, name=name, test_cls=cast(type[Test], test_cls), **kwargs
+        )
 
     @classmethod
     @validate_call(config=ConfigDict(extra="allow"))
     def load(
         cls,
-        path: str | Path,
+        path: FilePath,
         name: str | None = None,
-        test_cls: type[Test] | None = None,
+        test_cls: str | type[Test] | None = None,
         **kwargs: Any,
     ) -> Self:
-        path = TypeAdapter(FilePath).validate_python(path)
+        path = Path(path)
         data = cls._read_data(path) | kwargs
 
+        if isinstance(test_cls, str):
+            test_cls: type[Test] = _converter(test_cls)
+
         if cls._looks_like_state(data):
             return cls._from_state_data(
                 data,
@@ -195,8 +215,9 @@ class Regression(TestBase):
         async with self.mutex:
             is_running = self.is_running()
             should_resume = self.is_suspended()
+            should_terminate = self._termination_requested
 
-            if self.is_idle():
+            if self.is_idle() and not should_terminate:
                 self._status = TestStatus.Pending
 
         if should_resume:
@@ -204,6 +225,11 @@ class Regression(TestBase):
             task_status.started()
             return
 
+        if should_terminate:
+            await self.stop()
+            task_status.started()
+            return
+
         if is_running:
             task_status.started()
             return
@@ -265,13 +291,15 @@ class Regression(TestBase):
     async def stop(self) -> None:
         """Terminate active work within the regression."""
         async with self.mutex:
-            is_running = self.is_running()
-            should_resume = self.is_suspended()
-
-            self._termination_requested = True
-
-        if not is_running and not should_resume:
-            return
+            if any(
+                test.status
+                not in {
+                    TestStatus.Finished,
+                    TestStatus.Terminated,
+                }
+                for test in self.tests
+            ):
+                self._termination_requested = True
 
         async with anyio.create_task_group() as tg:
             for test in self.tests:
@@ -310,7 +338,7 @@ class Regression(TestBase):
             self._do_reset()
 
     def assign_output_dir(self, output_dir: Path) -> Path:
-        self.output_dir = output_dir
+        self.output_dir = Path(output_dir)
         output_dir.mkdir(parents=True, exist_ok=True)
 
         for child in self.tests:
@@ -398,12 +426,9 @@ class Regression(TestBase):
     def _do_reset(self) -> None:
         elapsed = self.elapsed_time
         started = self.started_time
-
         super()._do_reset()
-
-        if any(not test.is_idle() for test in self.tests):
-            self._elapsed_time = elapsed
-            self._started_time = started
+        self._elapsed_time = elapsed
+        self._started_time = started
 
     def _serialize_state(self, root_output_dir: Path) -> box.Box:
         return self._serialize_node(self, root_output_dir)
@@ -465,17 +490,25 @@ class Regression(TestBase):
     @validate_call(config=ConfigDict(extra="allow"))
     def _from_file(
         cls,
-        path: str | Path,
+        path: FilePath,
         name: str | None = None,
-        test_cls: type[TestBase] | None = None,
+        test_cls: str | type[Test] | None = None,
         **kwargs: Any,
     ) -> Self:
         """Construct a regression from a test configuration file."""
         from box import Box
 
-        path = TypeAdapter(FilePath).validate_python(path)
-        name = name or path.stem
-        test_cls = test_cls or Test
+        path = _filepath_adapter.validate_python(path)
+
+        if not bool(name):
+            name = path.stem
+
+        if not bool(test_cls):
+            test_cls = Test
+
+        if isinstance(test_cls, str):
+            test_cls = _converter(test_cls)
+
         data = cls._read_data(path)
 
         settings.update(Box({name: data}), merge=False)