socx-cli 0.13.4__tar.gz → 0.13.6__tar.gz

{socx_cli-0.13.4 → socx_cli-0.13.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: socx-cli
-Version: 0.13.4
+Version: 0.13.6
 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.13.4 → socx_cli-0.13.6}/pyproject.toml

@@ -29,7 +29,7 @@ socx = 'socx.__main__:main'
 [project]
 name = "socx-cli"
 readme = "README.md"
-version = "0.13.4"
+version = "0.13.6"
 license = "Apache-2.0"
 authors = [{ name = "Sagi Kimhi", email = "sagi.kim5@gmail.com" }]
 maintainers = [{ name = "Sagi Kimhi", email = "sagi.kim5@gmail.com" }]

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/config/_config.py

@@ -8,9 +8,7 @@ import contextvars as ctx
 from textwrap import dedent
 from typing import Any
 from pathlib import Path
-from collections import ChainMap
 
-from dynaconf.utils import ensure_a_list
 from werkzeug.local import LocalProxy
 
 from socx.config import converters
@@ -109,70 +107,27 @@ def get_settings(
     path: str | Path | None = None,
     /,
     user_overrides: bool = False,
-    local_overrides: bool = False,
+    project_overrides: bool = False,
     extra_overrides: list[str | Path] | None = None,
     **kwargs: Any,
 ) -> Settings:
     """Create a configured ``Settings`` instance, including overrides."""
-    from socx.core import paths
-    from socx.core import metadata
-    from socx.config.serializers import ModuleSerializer
-
-    if isinstance(path, str):
-        path = Path(path)
-
-    includes = []
-    settings_file = ensure_a_list(path or paths.APP_CONFIG_FILE)
-
-    if user_overrides:
-        includes.extend(get_user_config_files())
-
-    if local_overrides:
-        includes.extend(get_local_config_files())
-
-    if extra_overrides:
-        includes.extend(
-            Path(p) if isinstance(p, str) else p for p in extra_overrides
-        )
-
-    root = includes[-1].parent if includes else Path.cwd()
-    settings_kwargs = dict(
-        preload=settings_file, root_path=root, settings_file=includes
-    )
-    kwargs = dict(
-        ChainMap(
-            kwargs,
-            settings_kwargs,
-            ModuleSerializer.serialize(paths),
-            ModuleSerializer.serialize(metadata),
-        ),
+    return Settings(
+        user_overrides=user_overrides,
+        project_overrides=project_overrides,
+        **kwargs,
     )
-    rv = Settings(**kwargs)
-    return rv
 
 
 converters.init()
-
 _tokens = []
-
 _settings_cv: ctx.ContextVar[Settings] = ctx.ContextVar("settings")
-
-_default_settings: Settings = get_settings()
-
-try:
-    _user_settings: Settings = get_settings(user_overrides=True)
-except Exception:
-    _user_settings = _default_settings
-
-try:
-    _local_settings: Settings = get_settings(
-        user_overrides=True, local_overrides=True
-    )
-except Exception:
-    _local_settings = _default_settings
-    _local_settings.update(_user_settings)
-
-settings: SettingsProxy = LocalProxy(  # type: ignore[assignment]
+_default_settings: Settings = Settings(
+    project_overrides=False, user_overrides=False
+)
+_user_settings: Settings = Settings(project_overrides=False)
+_local_settings: Settings = Settings()
+settings: SettingsProxy = LocalProxy(
     _settings_cv,
     unbound_message=dedent("""
         Working outside of application context.
@@ -180,7 +135,7 @@ settings: SettingsProxy = 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]
 
 if "--no-configure" in sys.argv or "-NC" in sys.argv:
     _tokens.append(_settings_cv.set(_default_settings))

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/config/_settings.py

@@ -9,14 +9,16 @@ from collections import ChainMap
 from collections.abc import Callable
 
 from dynaconf import LazySettings, get_history
+from dynaconf.loaders import env_loader
 from dynaconf.base import SourceMetadata, ensure_a_list
 from dynaconf.utils.boxing import DynaBox
 from dynaconf.utils.inspect import get_debug_info, _get_data_by_key
 from dynaconf.utils.parse_conf import unparse_conf_data
 from pydantic_core import to_jsonable_python
 
-from socx.config.serializers import SettingsSerializer
-
+from socx.core import paths, metadata
+from socx.core.enums import SettingsFormat
+from socx.config.serializers import SettingsSerializer, ModuleSerializer
 
 logger = logging.getLogger(__name__)
 
@@ -29,8 +31,10 @@ VT = TypeVar("VT")
 SETTINGS_DEFAULTS: dict[str, Any] = dict(
     env="default",
     envvar="SOCX_SETTINGS_PATH",
+    preload=[paths.APP_CONFIG_FILE],
     encoding="utf-8",
     auto_cast=True,
+    root_path=paths.PROJECT_ROOT_DIR,
     load_dotenv=True,
     environments=False,
     dotted_lookup=True,
@@ -46,15 +50,51 @@ SETTINGS_DEFAULTS: dict[str, Any] = dict(
 
 
 class Settings(LazySettings):
-    """Singleton settings instance of loaded `socx` configurations."""
+    """Application settings class."""
 
     def __init__(self, wrapped=None, **kwargs: Any) -> None:
-        kwargs = dict(ChainMap(kwargs, SETTINGS_DEFAULTS))
+        default_kwargs = SETTINGS_DEFAULTS
+        if kwargs.get("project_overrides", True):
+            project_files = self.get_project_config_files()
+            if project_files:
+                default_kwargs["settings_file"] = [project_files[-1]]
+        kwargs = dict(
+            ChainMap(
+                kwargs,
+                default_kwargs,
+                ModuleSerializer.serialize(paths),
+                ModuleSerializer.serialize(metadata),
+            )
+        )
         LazySettings.__init__(self, wrapped=wrapped, **kwargs)
-        if hasattr(self, "dynaconf_include"):
-            for file in self.dynaconf_include:
-                if file not in self.loaded_files:
-                    self.load_file(path=file)
+
+    def _setup(self) -> None:
+        super()._setup()
+        self._load_overrides()
+
+    def _load_overrides(self) -> None:
+        user_overrides = self.get("user_overrides", True)
+        project_overrides = self.get("project_overrides", True)
+        includes = self.get_settings_overrides(
+            user_overrides=user_overrides, project_overrides=project_overrides
+        )
+
+        if includes:
+            for file in includes:
+                logger.debug("loading settings overrides from: '%s'")
+                try:
+                    self.load_file(file)
+                except Exception:
+                    logger.exception(
+                        "Failed to load settings file: '%s'" % str(file)
+                    )
+                    continue
+                else:
+                    logger.debug("loaded settings overrides from: '%s'")
+
+            last_loader = self.loaders and self.loaders[-1]
+            if last_loader is env_loader:
+                env_loader.load(self._store)
 
     def __contains__(self, key):
         return self.exists(key) or (
@@ -77,19 +117,6 @@ class Settings(LazySettings):
         """Get the root path of the current settings instance."""
         return Path(self._root_path)
 
-    @root.setter
-    def root(self, value: str | Path) -> None:
-        if isinstance(value, str):
-            value = Path(value)
-
-        if value.is_file() and value.exists():
-            self.set(
-                "SETTINGS_FILE_FOR_DYNACONF",
-                value,
-                loader_identifier="init_settings_module",
-            )
-            self.reload()
-
     @property
     def history(self) -> tuple[dict[str, Any], ...]:
         """Get the history of this instance.
@@ -274,6 +301,107 @@ class Settings(LazySettings):
             rv = cls._transform(rv, fn, skip_values=skip_values)
         return rv
 
+    @classmethod
+    def get_settings_overrides(
+        cls, user_overrides: bool = True, project_overrides: bool = True
+    ) -> list[Path]:
+        """Get a list of project settings file overrides."""
+        overrides = []
+        if user_overrides:
+            overrides.extend(cls.get_user_config_files())
+        if project_overrides:
+            overrides.extend(cls.get_project_config_files())
+        return overrides
+
+    @classmethod
+    def get_project_config_files(cls) -> list[Path]:
+        """Get a list of local settings file paths found in parent folders.
+
+        Description:
+        ------------
+        After initialization, `socx` searches parent directories for any file
+        named '.socx.<ext>' where <ext> is any file extension supported by the
+        `socx` configuration system.
+
+        Local configuration overrides are any files named '.socx.<ext>' which
+        found in any of the parent directories of the current working
+        directory, where <ext> may be any one of: '.yaml', '.yml', '.json', or
+        '.toml'.
+
+        For reference, it works similar to git:
+
+        1.  first, default app configurations are loaded to initialize to
+            app's core functionality.
+
+        2.  second, global user configurations are loaded from the user's
+            config directory, determined according to the 'XDG Base Directory
+            Specification'
+            (https://specifications.freedesktop.org/basedir-spec).
+
+        3.  last, a search for local configuration files is done, matching
+            (and loading) any configuration files named '.socx.yaml' found in
+            any of the parent directories starting the search at the current
+            working
+            directory.
+
+        Returns:
+        --------
+        An ordered list of `Path` objects pointing at configuration files to
+        be loaded in that exact order to preserve the described overrides
+        order.
+
+        """
+        from socx.core.paths import LOCAL_CONFIG_FILE, LOCAL_CONFIG_FILENAME
+
+        rv = []
+        for parent in LOCAL_CONFIG_FILE.parents:
+            cfg_file = parent / LOCAL_CONFIG_FILENAME
+            for member in SettingsFormat:
+                rv.extend(
+                    cfg_file.with_suffix(ext)
+                    for ext in member.extensions
+                    if cfg_file.with_suffix(ext).is_file()
+                )
+        return rv
+
+    @classmethod
+    def get_user_config_files(cls) -> list[Path]:
+        """Get a list of all local config files found in parent folders.
+
+        Description:
+        ------------
+        User configuration files are any configuration files who's format is
+        supported and are located under the XDG_CONFIG_HOME directory.
+
+        Local configuration overrides are any files named '.socx.yaml' which
+        found in any of the parent directories of the current working
+        directory.
+
+        For reference, it works similar to git:
+
+        1.  first, default app configurations are loaded to initialize to
+            app's core functionality.
+
+        2.  second, global user configurations are loaded from the user's
+            config directory, determined according to the 'XDG Base Directory
+            Specification'
+            (https://specifications.freedesktop.org/basedir-spec).
+
+        3.  last, a search for local configuration files is done, matching
+            (and loading) any configuration files named '.socx.yaml' found in
+            any of the parent directories starting the search at the current
+            working directory.
+
+        Returns:
+        --------
+        An ordered list of `Path` objects pointing at configuration files to be
+        loaded in that exact order to preserve the described overrides order.
+
+        """
+        from socx.core.paths import USER_CONFIG_FILE
+
+        return [USER_CONFIG_FILE] if USER_CONFIG_FILE.exists() else []
+
     @classmethod
     def _transform(
         cls,

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/core/_paths.py

@@ -36,7 +36,7 @@ def find_project_root(start_path: Path) -> Path:
 
     if not start_path.exists():
         err = f"Path '{start_path}' does not exist."
-        raise OSError(err)
+        raise FileNotFoundError(err)
 
     if start_path.is_file():
         start_path = start_path.parent

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/core/enums.py

@@ -25,7 +25,6 @@ class SettingsFormat(AutoNumber):
     Python = ".python"
 
     def __init__(self, extension: str, *extensions: str) -> None:
-        self.extension = extension
         self.extensions = [extension, *extensions]
 
     @classmethod

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/core/paths.py

@@ -19,8 +19,10 @@ __all__ = (
     "USER_RUNTIME_DIR",
     "USER_LOG_FILENAME",
     "USER_CONFIG_FILENAME",
+    "USER_ROTATING_LOG_FILENAME",
     "USER_LOG_FILE",
     "USER_CONFIG_FILE",
+    "USER_ROTATING_LOG_FILE",
     # Local Paths
     "LOCAL_CONFIG_FILENAME",
     "LOCAL_CONFIG_FILE",
@@ -46,8 +48,12 @@ from socx.core._paths import USER_CONFIG_DIR as USER_CONFIG_DIR
 from socx.core._paths import USER_RUNTIME_DIR as USER_RUNTIME_DIR
 from socx.core._paths import USER_LOG_FILENAME as USER_LOG_FILENAME
 from socx.core._paths import USER_CONFIG_FILENAME as USER_CONFIG_FILENAME
+from socx.core._paths import (
+    USER_ROTATING_LOG_FILENAME as USER_ROTATING_LOG_FILENAME,
+)
 from socx.core._paths import USER_LOG_FILE as USER_LOG_FILE
 from socx.core._paths import USER_CONFIG_FILE as USER_CONFIG_FILE
+from socx.core._paths import USER_ROTATING_LOG_FILE as USER_ROTATING_LOG_FILE
 
 # Local Paths
 from socx.core._paths import LOCAL_CONFIG_FILE as LOCAL_CONFIG_FILE

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/io/log.py

@@ -177,7 +177,6 @@ def _get_rotating_file_handler(
 
     mode = mode or "w"
     handler = logging.handlers.RotatingFileHandler(
-        # no particular reason for size or backup count - arbitrarily chosen
         path,
         mode=mode,
         maxBytes=MBs(10),
@@ -246,9 +245,7 @@ def get_logger(name: str, filename: str | None = None) -> logging.Logger:
     """Return a child logger configured with optional file output."""
     rv = logger.getChild(name)
     if filename is not None:
-        handler = _get_rotating_file_handler(filename)
-        handler.setFormatter(DEFAULT_CHILD_FORMATTER)
-        rv.addHandler(handler)
+        rv.addHandler(_get_file_handler(filename))
     return rv
 
 

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/static/settings/logging.yaml

@@ -1,7 +1,7 @@
 logging:
   handlers:
     file:
-      path: "@get this.paths.user_log_file"
+      path: "@jinja {{this.paths.user_log_file}}"
       level: DEBUG
     console:
       level: INFO
@@ -12,8 +12,7 @@ logging:
             False
         {%- endif -%}"
     rotating_file:
-      level: DEBUG
-      path: "@get this.paths.user_rotating_log_file"
+      path: "@jinja {{this.paths.user_rotating_log_file}}"
 
   formatters:
     default:

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/static/settings/regression.yaml

@@ -3,7 +3,6 @@ regression:
     params:
       inline: false
       inline_no_clear: true
-
     paths:
       app_dir: >-
         @jinja {{'{}/../socx_tui'.format(this.paths.app_root_dir) | realpath}}
@@ -11,30 +10,12 @@ regression:
         @jinja {{'{}/static'.format(this.regression.tui.paths.app_dir) | realpath}}
       tcss_dir: >-
         @jinja {{'{}/tcss/regression'.format(this.regression.tui.paths.static_dir) | realpath}}
-
-    table:
-      view:
-        opts:
-          cursor_type: row
-          show_header: true
-          show_row_labels: true
-          show_cursor: true
-          zebra_stripes: true
-          fixed_rows: 0
-          fixed_columns: 0
-
-      model:
-        opts:
-          exclude:
-            - exec
-
   run:
     input:
       filename: ~
       directory: ~
     output:
       directory: "@path workrun/regression"
-  path: ~
   test_cls: "socx:Test"
   regression_cls: "socx:Regression"
   max_runs_in_parallel: 10

{socx_cli-0.13.4 → socx_cli-0.13.6}/socx/static/settings/rich_click.yaml

@@ -214,11 +214,10 @@ rich_click:
   # type: NotRequired[Optional[Union[str, "Text"]]]
   footer_text: |
     @markdown @jinja :cd: [bold yellow]Cwd[/]: [italic]{{'{}'.format(this.cli.params.cwd)}}[/]
+    :open_file_folder: [bold yellow]Root[/]: [italic]{{'{}'.format(this.paths.project_root_dir)}}[/]
     {% if this.settings_file -%}
-    :open_file_folder: [bold yellow]Root[/]: [italic]{{'{}'.format(this._root_path)}}[/]
     :wrench: [bold yellow]Config[/]: [italic]{{'{}'.format(this.settings_file[-1])}}[/]
     {% else -%}
-    :open_file_folder: [bold yellow]Root[/]: [italic]{{'{}'.format(this._root_path)}}[/]
     :wrench: [bold yellow]Config[/]: [italic red]Not found[/]
     {% endif -%}
     :link: [bold yellow]Documentation[/]: [italic link]https://sagikimhi.dev/socx-cli[/]
@@ -277,7 +276,7 @@ rich_click:
   # type: NotRequired["PaddingDimensions"]
   padding_epilog: ~
   # type: NotRequired["PaddingDimensions"]
-  padding_footer_text: [0,2]
+  padding_footer_text: [0, 2]
   # type: NotRequired["PaddingDimensions"]
   padding_errors_panel: ~
   # type: NotRequired["PaddingDimensions"]