cgse-common 2025.0.4__py3-none-any.whl → 2025.0.6__py3-none-any.whl

egse/setup.py

@@ -120,6 +120,7 @@ import logging
 import os
 import re
 import textwrap
+import warnings
 from functools import lru_cache
 from pathlib import Path
 from typing import Any
@@ -130,11 +131,14 @@ import rich
 import yaml
 from rich.tree import Tree
 
+from egse.env import get_conf_data_location
 from egse.env import get_conf_repo_location
 from egse.env import get_conf_repo_location_env_name
 from egse.env import get_data_storage_location
+from egse.env import has_conf_repo_location
+from egse.env import print_env
 from egse.response import Failure
-from egse.env import get_conf_data_location
+from egse.settings import read_configuration_file
 from egse.system import format_datetime
 from egse.system import sanity_check
 from egse.system import walk_dict_tree
@@ -218,8 +222,8 @@ def _load_yaml(resource_name: str):
     [in_dir, fn] = parts if len(parts) > 1 else [None, parts[0]]
     conf_location = get_conf_data_location()
     try:
-        yaml_location = Path(conf_location) / in_dir / fn
-        content = NavigableDict(Settings.load(filename=yaml_location, add_local_settings=False))
+        yaml_location = Path(conf_location) / in_dir
+        content = NavigableDict(Settings.load(location=yaml_location, filename=fn, add_local_settings=False))
     except (TypeError, SettingsError) as exc:
         raise ValueError(
             f"Couldn't load resource '{resource_name}' from default {conf_location=}") from exc
@@ -227,7 +231,11 @@ def _load_yaml(resource_name: str):
 
 
 def _load_pandas(resource_name: str, separator: str):
-    """ Find and return the content of the given files as a pandas DataFrame object.
+    """
+    Find and return the content of the given file as a pandas DataFrame object.
+
+    The file is loaded relative from the location of the configuration data
+    as defined by `get_conf_data_location()`.
 
     Args:
         - resource_name: Filename, preceded by "pandas//".
@@ -336,7 +344,7 @@ class NavigableDict(dict):
 
     """
 
-    def __init__(self, head: dict = None):
+    def __init__(self, head: dict = None, label: str = None):
         """
         Args:
             head (dict): the original dictionary
@@ -344,6 +352,7 @@ class NavigableDict(dict):
         head = head or {}
         super().__init__(head)
         self.__dict__["_memoized"] = {}
+        self.__dict__["_label"] = label
 
         # By agreement, we only want the keys to be set as attributes if all keys are strings.
         # That way we enforce that always all keys are navigable, or none.
@@ -572,7 +581,7 @@ class NavigableDict(dict):
         return msg
 
     def __rich__(self) -> Tree:
-        tree = Tree("NavigableDict", guide_style="dim")
+        tree = Tree(self.__dict__["_label"] or "NavigableDict", guide_style="dim")
         walk_dict_tree(self, tree, text_style="dark grey")
         return tree
 
@@ -636,8 +645,8 @@ class Setup(NavigableDict):
     """The Setup class represents a version of the configuration of the test facility, the
     test setup and the Camera Under Test (CUT)."""
 
-    def __init__(self, nav_dict: NavigableDict | dict = None):
-        super().__init__(nav_dict or {})
+    def __init__(self, nav_dict: NavigableDict | dict = None, label: str = None):
+        super().__init__(nav_dict or {}, label=label)
 
     @staticmethod
     def from_dict(my_dict):
@@ -651,7 +660,7 @@ class Setup(NavigableDict):
             >>> assert setup["ID"] == setup.ID == "my-setup-001"
 
         """
-        return Setup(my_dict)
+        return Setup(my_dict, label="Setup")
 
     @staticmethod
     def from_yaml_string(yaml_content: str = None):
@@ -674,27 +683,36 @@ class Setup(NavigableDict):
         if "Setup" in setup_dict:
             setup_dict = setup_dict["Setup"]
 
-        return Setup(setup_dict)
+        return Setup(setup_dict, label="Setup")
 
     @staticmethod
     @lru_cache
-    def from_yaml_file(filename: Union[str, Path] = None):
+    def from_yaml_file(filename: Union[str, Path] = None, add_local_settings: bool = True):
         """Loads a Setup from the given YAML file.
 
         Args:
             filename (str): the path of the YAML file to be loaded
+            add_local_settings (bool): if local settings shall be loaded and override the settings from the YAML file.
 
         Returns:
             a Setup that was loaded from the given location.
         """
-        from egse.settings import Settings
 
         if not filename:
             raise ValueError("Invalid argument to function: No filename or None given.")
 
-        setup_dict = Settings.load("Setup", filename=filename, force=True)
+        # MODULE_LOGGER.info(f"Loading {filename}...")
+
+        setup_dict = read_configuration_file(filename, force=True)
+        if setup_dict == {}:
+            warnings.warn(f"Empty Setup file: {filename!s}")
+
+        try:
+            setup_dict = setup_dict["Setup"]
+        except KeyError:
+            warnings.warn(f"Setup file doesn't have a 'Setup' group: {filename!s}")
 
-        setup = Setup(setup_dict)
+        setup = Setup(setup_dict, label="Setup")
         setup.set_private_attribute("_filename", filename)
         if setup_id := _parse_filename_for_setup_id(str(filename)):
             setup.set_private_attribute("_setup_id", setup_id)
@@ -911,18 +929,15 @@ def get_setup(setup_id: int = None):
 
 def _check_conditions_for_get_path_of_setup_file(site_id: str) -> Path:
     """
-    Check some pre-conditions that need to be met before we try to determine the file path for
-    the requested Setup file.
+    Check some pre-conditions that need to be met before we try to determine the
+    file path for the requested Setup file.
 
     The following checks are performed:
 
-    * if the environment variable 'PLATO_CONF_REPO_LOCATION' is set
-
+    * if the environment variable '{PROJECT}_CONF_REPO_LOCATION' is set
     * if the directory specified in the env variable actually exists
-
     * if the folder with the Setups exists for the given site_id
 
-
     Args:
         site_id (str): the name of the test house
 
@@ -939,9 +954,12 @@ def _check_conditions_for_get_path_of_setup_file(site_id: str) -> Path:
 
     if not (repo_location := get_conf_repo_location()):
         raise LookupError(
-            f"Environment variable doesn't exist, please define {repo_location_env} and try again."
+            f"Environment variable doesn't exist or points to an invalid location, please (re-)define"
+            f" {repo_location_env} and try again."
         )
 
+    print_env()
+
     repo_location = Path(repo_location)
     setup_location = repo_location / 'data' / site_id / 'conf'
 
@@ -962,11 +980,13 @@ def _check_conditions_for_get_path_of_setup_file(site_id: str) -> Path:
 
 def get_path_of_setup_file(setup_id: int, site_id: str) -> Path:
     """
-    Returns the Path to the last Setup file for the given site_id. The last Setup file is the file
-    with the largest setup_id number.
+    Returns the Path to the last Setup file for the given site_id. The last Setup
+    file is the file with the largest setup_id number.
 
-    This function needs the environment variable <PROJECT>_CONF_REPO_LOCATION to be defined as the
-    location of the repository with configuration data on your disk.
+    This function needs the environment variable <PROJECT>_CONF_REPO_LOCATION to
+    be defined as the location of the repository with configuration data on your
+    disk. If the repo is not defined, the configuration data location will be used
+    instead.
 
     Args:
         setup_id (int): the identifier for the requested Setup
@@ -984,7 +1004,10 @@ def get_path_of_setup_file(setup_id: int, site_id: str) -> Path:
 
     """
 
-    setup_location = _check_conditions_for_get_path_of_setup_file(site_id)
+    if not has_conf_repo_location():
+        setup_location = Path(get_conf_data_location(site_id))
+    else:
+        setup_location = _check_conditions_for_get_path_of_setup_file(site_id)
 
     if setup_id:
         files = list(setup_location.glob(f'SETUP_{site_id}_{setup_id:05d}_*.yaml'))

egse/system.py

@@ -28,6 +28,7 @@ import socket
 import subprocess  # For executing a shell command
 import sys
 import time
+import warnings
 from collections import namedtuple
 from contextlib import contextmanager
 from pathlib import Path
@@ -512,6 +513,9 @@ class AttributeDict(dict):
         return self.__class__.__name__ + f"({{{sub_msg}{', ...' if len(self) > count else ''}}})"
 
 
+attrdict = AttributeDict
+
+
 def walk_dict_tree(dictionary: dict, tree: Tree, text_style: str = "green"):
     for k, v in dictionary.items():
         if isinstance(v, dict):
@@ -931,22 +935,23 @@ def env_var(**kwargs):
 
     """
     saved_env = {}
-    try:
-        for k, v in kwargs.items():
-            saved_env[k] = os.environ.get(k)
-            if v is None:
-                if k in os.environ:
-                    del os.environ[k]
-            else:
-                os.environ[k] = v
-        yield
-    finally:
-        for k, v in saved_env.items():
-            if v is None:
-                if k in os.environ:
-                    del os.environ[k]
-            else:
-                os.environ[k] = v
+
+    for k, v in kwargs.items():
+        saved_env[k] = os.environ.get(k)
+        if v is None:
+            if k in os.environ:
+                del os.environ[k]
+        else:
+            os.environ[k] = v
+
+    yield
+
+    for k, v in saved_env.items():
+        if v is None:
+            if k in os.environ:
+                del os.environ[k]
+        else:
+            os.environ[k] = v
 
 
 def filter_by_attr(elements: Iterable, **attrs) -> List:
@@ -1120,7 +1125,7 @@ def is_namespace(module) -> bool:
         return False
 
 
-def get_package_location(module) -> List[Path]:
+def get_package_location(module: str) -> List[Path]:
     """
     Retrieves the file system locations associated with a Python package.
 
@@ -1153,6 +1158,7 @@ def get_package_location(module) -> List[Path]:
     try:
         module = importlib.import_module(module)
     except TypeError:
+        warnings.warn(f"The module is not found or is not valid: {module_name}.")
         return []
 
     if is_namespace(module):

cgse_common-2025.0.4.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[cgse.version]
-cgse-common = egse