cgse-common 2023.1.5__py3-none-any.whl → 2024.1.4__py3-none-any.whl

egse/setup.py

@@ -44,10 +44,10 @@ Some of the information in the Setup is interpreted in a special way, i.e. some
 processed before returning. Examples are the device classes and calibration/data files. The
 following values are treated special if they start with:
 
-* `class//`: the class in instantiated and the object is returned
-* `csv//`: the CSV file is loaded and a numpy array is returned
-* `yaml//`: the YAML file is loaded and a dictionary is returned
-* `enum//`: the enumeration is created dynamically and the object is returned
+* `class//`: instantiate the class and return the object
+* `csv//`: load the CSV file and return a numpy array
+* `yaml//`: load the YAML file and return a dictionary
+* `enum//`: dynamically create the enumeration and return the Enum object
 
 #### Device Classes
 
@@ -63,7 +63,7 @@ return the device object. As an example, the following defines the Hexapod devic
     >>> setup.gse.hexapod.device.is_homing_done()
     False
     >>> setup.gse.hexapod.device.info()  # doctest: +ELLIPSIS
-    'Info about the PunaSimulator...
+    'Info about the PunaSimulator...'
 
 In the above example you see that we can call the `is_homing_done()` and `info()` methodes
 directly on the device by navigating the Setup. It would however be better (more performant) to
@@ -99,8 +99,21 @@ Note: the resource location is always relative to the path defined by the PLATO_
 environment variable.
 
 """
+
 from __future__ import annotations
 
+__all__ = [
+    "Setup",
+    "navdict",  # noqa: ignore typo
+    "list_setups",
+    "load_setup",
+    "get_setup",
+    "submit_setup",
+    "SetupError",
+    "load_last_setup_id",
+    "save_last_setup_id",
+]
+
 import enum
 import importlib
 import logging
@@ -117,7 +130,11 @@ import rich
 import yaml
 from rich.tree import Tree
 
-from egse.control import Failure
+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.response import Failure
+from egse.env import get_conf_data_location
 from egse.system import format_datetime
 from egse.system import sanity_check
 from egse.system import walk_dict_tree
@@ -131,9 +148,10 @@ class SetupError(Exception):
 
 
 def _load_class(class_name: str):
-    """Find and returns a class based on the fully qualified name.
+    """
+    Find and returns a class based on the fully qualified name.
 
-    A class name can be preceded with the string `class//`. This is used in YAML
+    A class name can be preceded with the string `class//` or `factory//`. This is used in YAML
     files where the class is then instantiated on load.
 
     Args:
@@ -155,7 +173,7 @@ def _load_csv(resource_name: str):
 
     parts = resource_name[5:].rsplit("/", 1)
     [in_dir, fn] = parts if len(parts) > 1 else [None, parts[0]]
-    conf_location = os.environ['PLATO_CONF_DATA_LOCATION']
+    conf_location = get_conf_data_location()
     try:
         csv_location = Path(conf_location) / in_dir / fn
         content = genfromtxt(csv_location, delimiter=",", skip_header=1)
@@ -198,7 +216,7 @@ def _load_yaml(resource_name: str):
 
     parts = resource_name[6:].rsplit("/", 1)
     [in_dir, fn] = parts if len(parts) > 1 else [None, parts[0]]
-    conf_location = os.environ['PLATO_CONF_DATA_LOCATION']
+    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))
@@ -246,22 +264,19 @@ def _parse_filename_for_setup_id(filename: str):
 
     try:
         return match[2]  # match[2] is setup_id
-    except (IndexError, TypeError) as exc:
+    except (IndexError, TypeError):
         return None
 
 
 def get_last_setup_id_file_path(site_id: str = None) -> Path:
     """
     Return the fully expanded file path of the file containing the last loaded Setup in the configuration manager.
+    The default location for this file is the data storage location.
 
     Args:
-        site_id: The SITE identifier
+        site_id: The SITE identifier (overrides the SITE_ID environment variable)
 
     """
-    from egse.env import get_data_storage_location
-    from egse.settings import Settings
-
-    site_id = site_id or Settings.load("SITE").ID
     location = get_data_storage_location(site_id=site_id)
 
     return Path(location).expanduser().resolve() / "last_setup_id.txt"
@@ -510,11 +525,10 @@ class NavigableDict(dict):
             ValueError: when the key doesn't start with an underscore.
         """
         if not key.startswith("_"):
-            raise ValueError(
-                f"Invalid argument key='{key}', must start with underscore character '_'."
-            )
+            raise ValueError(f"Invalid argument key='{key}', must start with underscore character '_'.")
+
         try:
-            self.__dict__[key]
+            _ = self.__dict__[key]
             return True
         except KeyError:
             return False
@@ -614,11 +628,15 @@ class NavigableDict(dict):
         return list(self.__dict__["_memoized"].keys())
 
 
+navdict = NavigableDict  # noqa: ignore typo
+"""Shortcut for NavigableDict and more Pythonic."""
+
+
 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 = None):
+    def __init__(self, nav_dict: NavigableDict | dict = None):
         super().__init__(nav_dict or {})
 
     @staticmethod
@@ -722,10 +740,9 @@ class Setup(NavigableDict):
     @staticmethod
     def compare(setup_1: NavigableDict, setup_2: NavigableDict):
         from egse.device import DeviceInterface
-        from egse.dpu import DPUSimulator
         from deepdiff import DeepDiff
 
-        return DeepDiff(setup_1, setup_2, exclude_types={DeviceInterface, DPUSimulator})
+        return DeepDiff(setup_1, setup_2, exclude_types=[DeviceInterface])
 
     # def get_devices(self):
     #     """Returns a list of devices for the current setup.
@@ -741,7 +758,7 @@ class Setup(NavigableDict):
     #     return devices
 
     @staticmethod
-    def find_devices(node: NavigableDict, devices={}):
+    def find_devices(node: NavigableDict, devices: dict = None):
         """
         Returns a dictionary with the devices that are included in the setup.  The keys
         in the dictionary are taken from the "device_name" entries in the setup file. The
@@ -755,6 +772,7 @@ class Setup(NavigableDict):
         Returns:
             - Dictionary with the devices that are included in the setup.
         """
+        devices = devices or {}
 
         for sub_node in node.values():
 
@@ -848,7 +866,11 @@ def list_setups(**attr):
     >>> list_setups(gse__hexapod__ID=4)
     """
 
-    from egse.confman import ConfigurationManagerProxy
+    try:
+        from egse.confman import ConfigurationManagerProxy
+    except ImportError:
+        print("WARNING: package 'cgse-core' is not installed, service not available.")
+        return
 
     try:
         with ConfigurationManagerProxy() as proxy:
@@ -873,16 +895,18 @@ def get_setup(setup_id: int = None):
     This function is for interactive use and consults the configuration manager server. Don't use
     this within the test script, but use the `GlobalState.setup` property instead.
     """
-    from egse.confman import ConfigurationManagerProxy
+    try:
+        from egse.confman import ConfigurationManagerProxy
+    except ImportError:
+        print("WARNING: package 'cgse-core' is not installed, service not available.")
+        return
 
     try:
         with ConfigurationManagerProxy() as proxy:
             setup = proxy.get_setup(setup_id)
         return setup
-    except ConnectionError as exc:
-        print(
-            "Could not make a connection with the Configuration Manager, no Setup returned."
-        )
+    except ConnectionError:
+        print("Could not make a connection with the Configuration Manager, no Setup returned.")
 
 
 def _check_conditions_for_get_path_of_setup_file(site_id: str) -> Path:
@@ -911,8 +935,9 @@ def _check_conditions_for_get_path_of_setup_file(site_id: str) -> Path:
         NotADirectoryError when either the repository folder or the Setups folder doesn't exist.
 
     """
-    repo_location_env = 'PLATO_CONF_REPO_LOCATION'
-    if not (repo_location := os.environ.get(repo_location_env)):
+    repo_location_env = get_conf_repo_location_env_name()
+
+    if not (repo_location := get_conf_repo_location()):
         raise LookupError(
             f"Environment variable doesn't exist, please define {repo_location_env} and try again."
         )
@@ -940,8 +965,8 @@ 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.
 
-    This function needs the environment variable PLATO_CONF_REPO_LOCATION to be defined as the
-    location of the repository 'plato-cgse-conf' 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.
 
     Args:
         setup_id (int): the identifier for the requested Setup
@@ -1019,7 +1044,11 @@ def load_setup(
 
     # When we arrive here the Setup shall be loaded from the Configuration manager
 
-    from egse.confman import ConfigurationManagerProxy
+    try:
+        from egse.confman import ConfigurationManagerProxy
+    except ImportError:
+        print("WARNING: package 'cgse-core' is not installed, service not available. Returning an empty Setup.")
+        return Setup()
 
     if setup_id is not None:
         try:
@@ -1064,7 +1093,11 @@ def submit_setup(setup: Setup, description: str):
     #                 be replaced by this new Setup. [default=True]
     replace: bool = True
 
-    from egse.confman import ConfigurationManagerProxy
+    try:
+        from egse.confman import ConfigurationManagerProxy
+    except ImportError:
+        print("WARNING: package 'cgse-core' is not installed, service not available.")
+        return
 
     try:
         with ConfigurationManagerProxy() as proxy:
@@ -1076,27 +1109,27 @@ def submit_setup(setup: Setup, description: str):
             rich.print(f"[red]Submit failed for given Setup[/red]: {setup}")
             setup = None
         elif replace:
-            rich.print(textwrap.dedent(
-                f"""\
+            rich.print(textwrap.dedent("""\
                 [green]
-                Your new setup has been submitted and pushed to GitHub. The new setup is also 
+                Your new setup has been submitted and pushed to GitHub. The new setup is also
                 activated in the configuration manager. Load the new setup in your session with:
 
-                    setup = load_setup() 
+                    setup = load_setup()
                 [/]
                 """
             ))
         else:
-            rich.print(textwrap.dedent(
-                f"""\
-                [dark_orange]
-                Your new setup has been submitted and pushed to GitHub, but has not been
-                activated in the configuration manager. To activate this setup, use the
-                following command: 
-
-                    setup = load_setup({str(setup.get_id())})
-                [/]
-                """)
+            rich.print(
+                textwrap.dedent(
+                    """[dark_orange]
+                    Your new setup has been submitted and pushed to GitHub, but has not been
+                    activated in the configuration manager. To activate this setup, use the
+                    following command:
+
+                        setup = load_setup({str(setup.get_id())})
+                    [/]
+                    """
+                )
             )
 
         return setup.get_id() if setup is not None else None
@@ -1104,29 +1137,18 @@ def submit_setup(setup: Setup, description: str):
     except ConnectionError:
         rich.print("Could not make a connection with the Configuration Manager, no Setup was submitted.")
     except NotImplementedError:
-        rich.print(textwrap.dedent(
-            """\
-            Caught a NotImplementedError. That usually means the configuration manager is not running or 
-            can not be reached. Check on the egse-server if the `cm_cs` process is running. If not you will
-            need to be restart the core services.
-            """
-        ))
-
-
-__all__ = [
-    "Setup",
-    "list_setups",
-    "load_setup",
-    "get_setup",
-    "submit_setup",
-    "SetupError",
-    "load_last_setup_id",
-    "save_last_setup_id",
-]
+        rich.print(
+            textwrap.dedent(
+                """\
+                Caught a NotImplementedError. That usually means the configuration manager is not running or
+                can not be reached. Check on the egse-server if the `cm_cs` process is running. If not you will
+                need to be restart the core services.
+                """
+            )
+        )
 
-if __name__ == "__main__":
 
-    import sys
+def main(args: list = None):  # pragma: no cover
     import argparse
 
     from rich import print
@@ -1137,10 +1159,10 @@ if __name__ == "__main__":
     SITE = Settings.load("SITE")
     location = os.environ.get("PLATO_CONF_DATA_LOCATION")
     parser = argparse.ArgumentParser(
-        description=textwrap.dedent(f"""\
-            Print out the Setup for the given setup-id. The Setup will 
-            be loaded from the location given by the environment variable 
-            PLATO_CONF_DATA_LOCATION. If this env is not set, the Setup 
+        description=textwrap.dedent("""\
+            Print out the Setup for the given setup-id. The Setup will
+            be loaded from the location given by the environment variable
+            PLATO_CONF_DATA_LOCATION. If this env is not set, the Setup
             will be searched from the current directory."""
         ),
         epilog=f"PLATO_CONF_DATA_LOCATION={location}"
@@ -1150,17 +1172,21 @@ if __name__ == "__main__":
         help="the Setup ID. If not given, the last Setup will be selected.")
     parser.add_argument("--list", "-l", action="store_true", help="list available Setups.")
     parser.add_argument("--use-cm", action="store_true", help="use the configuration manager.")
-    args = parser.parse_args()
+    args = parser.parse_args(args or [])
 
     if args.use_cm:
-        from egse.confman import ConfigurationManagerProxy
+        try:
+            from egse.confman import ConfigurationManagerProxy
+        except ImportError:
+            print("WARNING: package 'cgse-core' is not installed, service not available.")
+            return
 
         with ConfigurationManagerProxy() as cm:
             if args.list:
                 print(cm.list_setups())
             else:
                 print(cm.get_setup())
-        sys.exit(0)
+        return
 
     if args.list:
         files = find_files(f"SETUP_{SITE.ID}_*_*.yaml", root=location)
@@ -1175,6 +1201,15 @@ if __name__ == "__main__":
             setup_files = find_files(f"SETUP_{SITE.ID}_*_*.yaml", root=location)
         else:
             setup_files = find_files(f"SETUP_{SITE.ID}_{setup_id:05d}_*.yaml", root=location)
-        setup_file = sorted(setup_files)[-1]
-        setup = Setup.from_yaml_file(setup_file)
-        print(setup)
+        setup_files = list(setup_files)
+        if len(setup_files) > 0:
+            setup_file = sorted(setup_files)[-1]
+            setup = Setup.from_yaml_file(setup_file)
+            print(setup)
+        else:
+            print("[red]No setup files were found.[/]")
+
+
+if __name__ == "__main__":
+    import sys
+    main(sys.argv[1:])

egse/system.py

@@ -29,6 +29,7 @@ import subprocess  # For executing a shell command
 import sys
 import time
 from collections import namedtuple
+from contextlib import contextmanager
 from pathlib import Path
 from types import FunctionType
 from types import ModuleType
@@ -36,7 +37,6 @@ from typing import Any
 from typing import Callable
 from typing import Iterable
 from typing import List
-from typing import NamedTuple
 from typing import Optional
 from typing import Tuple
 from typing import Union
@@ -51,12 +51,6 @@ TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%f%z"
 
 logger = logging.getLogger(__name__)
 
-from contextlib import contextmanager
-import logging
-
-
-# Code below is copied from https://gist.github.com/simon-weber/7853144
-
 
 @contextmanager
 def all_logging_disabled(highest_level=logging.CRITICAL, flag=True):
@@ -68,6 +62,7 @@ def all_logging_disabled(highest_level=logging.CRITICAL, flag=True):
             This would only need to be changed if a custom level greater than CRITICAL is defined.
         flag: True to disable all logging [default=True]
     """
+    # Code below is copied from https://gist.github.com/simon-weber/7853144
     # two kind-of hacks here:
     #    * can't get the highest logging level in effect => delegate to the user
     #    * can't get the current module-level override => use an undocumented
@@ -939,14 +934,19 @@ def env_var(**kwargs):
     try:
         for k, v in kwargs.items():
             saved_env[k] = os.environ.get(k)
-            os.environ[k] = v
+            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 not None:
-                os.environ[k] = v
+            if v is None:
+                if k in os.environ:
+                    del os.environ[k]
             else:
-                del os.environ[k]
+                os.environ[k] = v
 
 
 def filter_by_attr(elements: Iterable, **attrs) -> List:
@@ -1121,6 +1121,25 @@ def is_namespace(module) -> bool:
 
 
 def get_package_location(module) -> List[Path]:
+    """
+    Retrieves the file system locations associated with a Python package.
+
+    This function takes a module, module name, or fully qualified module path,
+    and returns a list of Path objects representing the file system locations
+    associated with the package. If the module is a namespace package, it returns
+    the paths of all namespaces; otherwise, it returns the location of the module.
+
+    Args:
+        module (Union[FunctionType, ModuleType, str]): The module or module name to
+            retrieve locations for.
+
+    Returns:
+        List[Path]: A list of Path objects representing the file system locations.
+
+    Note:
+        If the module is not found or is not a valid module, an empty list is returned.
+
+    """
 
     if isinstance(module, FunctionType):
         module_name = module.__module__
@@ -1133,7 +1152,7 @@ def get_package_location(module) -> List[Path]:
 
     try:
         module = importlib.import_module(module)
-    except TypeError as exc:
+    except TypeError:
         return []
 
     if is_namespace(module):
@@ -1180,7 +1199,7 @@ def get_module_location(arg) -> Optional[Path]:
 
     try:
         module = importlib.import_module(module_name)
-    except TypeError as exc:
+    except TypeError:
         return None
 
     if is_namespace(module):

cgse_common-2023.1.5.dist-info/RECORD

@@ -1,32 +0,0 @@
-egse/bits.py,sha256=6oNKp6BrCjwMlZ6lDwMPuZXTT6NzRW4Y04jLd5ALUGc,10235
-egse/command.py,sha256=PEPivQQu_FPerhEveVri_qiUkFnrjFA2nIkgo9qwXNg,23112
-egse/config.py,sha256=xQL3vdheYywBKzX70hoT4He9l29GlTI24CQfdtwMn-U,14743
-egse/control.py,sha256=TzaUDAHOttKRmnJvWbNLAQmNatWtZ_ExDJihqf0QTIE,15193
-egse/decorators.py,sha256=yR7QrXrdCxcyL5dnjD-gCI0eMGq43lo3Xp8GABtHYVU,13452
-egse/device.py,sha256=NGsjVELxMFFKJd1w-Bs1dFsAIpeistdv1H5xARdj1O4,8385
-egse/env.py,sha256=xTl5q1tUY0YtJMVUraAmU9wnziSIN1gzdO6cMYkjqfg,10306
-egse/exceptions.py,sha256=Tc1xqUrWxV6SXxc9xB9viK_O-GVa_SpzqZUVEhZkwzA,1801
-egse/mixin.py,sha256=J3yu5lPnm0grJqIm5LiacBUCZujJsdcKBNRaOQcMnNo,17345
-egse/monitoring.py,sha256=-pwXqPoiNKzQYKQSpKddFlaPkCTJZYdxvG1d2MBN3l0,3033
-egse/observer.py,sha256=6faaLHqgpOQs_oEvdBygQ5HF7mGneKJEfyQEFUFA5VY,1069
-egse/obsid.py,sha256=-HPuHApZrr3Nj1J2-qqnIiE814C-gm4FSHdM2afKdRY,5883
-egse/persistence.py,sha256=Lx6LMJ1-dh8N43XF7tTM6RwD0sSETiGQ9DNqug-G-zQ,2160
-egse/plugin.py,sha256=Fd_QnABm33_dLjaj1zDgEZr3RKy-N88U5Hz5OZm9Jj0,2684
-egse/process.py,sha256=mQ2ojeL_9oE_QkMJlQDPd1290z0j2mOrGXrlrWtOtzI,16615
-egse/protocol.py,sha256=Psy0iOLPTgARn1VqeKtPCSKepHr_S2KW58UYwjOA6J0,23827
-egse/proxy.py,sha256=pMKdnF62SXm0quLoKfgvK9GFkH2mLMB5fWNrZenfqQQ,18100
-egse/reload.py,sha256=rDT0bC6RFeRhW38wSgFcxr30h8FvaKkoGp_OE-AwBB4,4388
-egse/resource.py,sha256=FV6KYRnWZL0-xbrpAYEDHV0bPhvhAJgJmrKwOBfMWSk,12658
-egse/services.py,sha256=ZgkF0Rx_PykOVHAOV1cKduJdUhuY6A4DgwjPJWRGj3U,7642
-egse/services.yaml,sha256=p8QBF56zLI21iJ9skt65VlNz4rIqRoFfBTZxOIUZCZ4,1853
-egse/settings.py,sha256=t0Zzb1W40fF6cnJ2xvOdt0ZYnoE8i22wdS_co9SbTOI,13389
-egse/settings.yaml,sha256=g0xhRWWGwysmYUIIz4ViDG78TeDj230tZF48CA7Gg4g,48652
-egse/setup.py,sha256=XZN5vPf7kcgkIVP2c2gE3DXhJQApIRoeKndXVhZwpS4,41676
-egse/state.py,sha256=ekcCZu_DZKkKYn-5iWG7ij7Aif2WYMNVs5h3cia-cVc,5352
-egse/system.py,sha256=yvADB0ukpKFEd64tfx50TpG4y22UrnXOwqbko9UK2SY,48100
-egse/version.py,sha256=EigdH05E8pNtSQznUfqM_RxlOjuAVp3Oe6S6MM5xGIM,6132
-egse/zmq_ser.py,sha256=2-nwVUBWZ3vvosKNmlWobHJrIJA2HlM3V5a63Gz2JY0,1819
-cgse_common-2023.1.5.dist-info/METADATA,sha256=XJquyxu7_-dlJz0RpUVfZnibGJcOT08zDd3yf5Nt4Sc,2321
-cgse_common-2023.1.5.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-cgse_common-2023.1.5.dist-info/entry_points.txt,sha256=wl2zf4c5s9gQ-LAYVyiBtqTAZFxx8zuOZ2J5xz-r9zw,33
-cgse_common-2023.1.5.dist-info/RECORD,,

cgse_common-2023.1.5.dist-info/entry_points.txt

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