cgse 2025.0.4__tar.gz → 2025.0.5__tar.gz

{cgse-2025.0.4 → cgse-2025.0.5}/NOTES.md

@@ -55,29 +55,6 @@ Note that each library or project is a standalone Poetry package with its own `p
 
 All packages in the monorepo will have the same version. This can be maintained with the `bump.py` script. This script will read the version from the `pyproject.toml` file at the root of the monorepo and propagate the version to all libs and projects in the monorepo. Note that you –for now– will have to update the version number in the `pyproject.toml` file  located at the monorepo root folder manually. 
 
-# Use of Poetry (DEPRECATED: see below)
-
-I have now Poetry configurations for all `libs` in this monorepo. So, how do we use Poetry in this project?
-
-First thing to understand, Poetry is a development and dependency management tool. So, if you are installing the different packages in this repo from PyPI there is no need to use Poetry. The package will be installed in your current virtual environment.
-
-You can choose how you want to manage your virtual environments for each of the packages in the monorepo. I personally use `pyenv` to manage my virtual environments and I disable the virtual environment that would normally be used by Poetry.
-
-> Explain how to use `pyenv` for your virtual environments
-
-The following command starts a new sub-shell and activates the virtual environment: 
-```
-$ poetry shell
-```
-
-If you do not want to start a new shell, but just want to execute a command in the virtual environment, use the `poetry run` command, e.g.
-```
-$ poetry run pytest tests/test_bits.py
-```
-Or
-```
-$ poetry run python -m egse.monitoring localhost 6001
-```
 
 # Build and Publish
 

{cgse-2025.0.4 → cgse-2025.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 2025.0.4
+Version: 2025.0.5
 Summary: Generic Common-EGSE: Commanding and monitoring lab equipment
 Author-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
 License: MIT

cgse-2025.0.5/conftest.py

@@ -0,0 +1,30 @@
+from glob import glob
+
+import rich
+
+# Quick hack to load plugins from different places.
+# This doesn't work, I get an import error.
+
+# def refactor(string: str) -> str:
+#     entry = string.replace("/", ".").replace("\\", ".").replace(".py", "")
+#     rich.print(f"[green]{entry = }[/]")
+#     return entry
+#
+# pytest_plugins = [
+#     refactor(conftest)
+#     for conftest in glob("**/tests/fixtures/*.py", recursive=True)
+#     if "__" not in conftest
+# ]
+
+# Doesn't work, with the following error:
+#
+# File "/Users/rik/github/cgse/libs/cgse-common/tests/fixtures/default_env.py", line 7, in <module>
+#     from fixtures.helpers import setup_data_storage_layout, teardown_data_storage_layout
+# ImportError: Error importing plugin "libs.cgse-common.tests.fixtures.default_env": No module named 'fixtures'
+#
+
+# pytest_plugins = [
+#     "libs.cgse-common.tests.fixtures.helpers",
+#     "libs.cgse-common.tests.fixtures.default_env",
+#     "libs.cgse-core.tests.fixtures.services",
+# ]

cgse-2025.0.5/docs/dev_guide/index.md

@@ -0,0 +1,6 @@
+# Developer Guide
+
+Welcome to the CGSE developer guide! An in-depth reference on how to contribute to the CGSE.
+
+First thing to know is that this repository is actually a monorepo, meaning it contains a bunch of related but 
+self-standing packages with a minimum of interdependencies. These packages are  

{cgse-2025.0.4 → cgse-2025.0.5}/docs/dev_guide/uv.md

@@ -40,15 +40,23 @@ $ uv python install 3.9.20
 
 You can check which Python versions are installed already on your system:
 
-```shell
-$ uv python list --only-installed
-cpython-3.12.8-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.12.8-macos-aarch64-none/bin/python3.12
-cpython-3.10.16-macos-aarch64-none    /Users/rik/Library/Application Support/uv/python/cpython-3.10.16-macos-aarch64-none/bin/python3.10
-cpython-3.9.21-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.21-macos-aarch64-none/bin/python3.9
-cpython-3.9.20-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.20-macos-aarch64-none/bin/python3.9
-cpython-3.9.6-macos-aarch64-none      /Library/Developer/CommandLineTools/usr/bin/python3 -> ../../Library/Frameworks/Python3.framework/Versions/3.9/bin/python3
-cpython-3.8.17-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.8.17-macos-aarch64-none/bin/python3.8
-```
+=== "Command"
+
+    ```bash
+    $ uv python list --only-installed
+    ```
+
+=== "Output"
+
+    ```
+    cpython-3.12.8-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.12.8-macos-aarch64-none/bin/python3.12
+    cpython-3.10.16-macos-aarch64-none    /Users/rik/Library/Application Support/uv/python/cpython-3.10.16-macos-aarch64-none/bin/python3.10
+    cpython-3.9.21-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.21-macos-aarch64-none/bin/python3.9
+    cpython-3.9.20-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.9.20-macos-aarch64-none/bin/python3.9
+    cpython-3.9.6-macos-aarch64-none      /Library/Developer/CommandLineTools/usr/bin/python3 -> ../../Library/Frameworks/Python3.framework/Versions/3.9/bin/python3
+    cpython-3.8.17-macos-aarch64-none     /Users/rik/Library/Application Support/uv/python/cpython-3.8.17-macos-aarch64-none/bin/python3.8
+    ```
+
 
 ## Create a virtual environment
 
@@ -94,6 +102,19 @@ $ uv pip install -e .
     $ source .venv/bin/activate
     ```
 
+!!! info
+
+    In a workspace, maintaining a virtual environment per package might be a hassle and most of the time that is not 
+    needed. A good approach is to always use the virtual environment at the workspace root. This `venv` which will be 
+    automatically created if you run a command or if you use `uv sync` in the package folder. With `uv sync` you can 
+    make sure the virtual environment is up-to-date and contains only those dependencies that are required for the 
+    package you are in. So, each time you switch to another package and want to run a comand or a test for that 
+    package, use 
+
+    ```
+    $ uv sync
+    ```
+
 ## Building and publishing all packages
 
 We have chosen for one and the same version number for all packages in the `cgse` monorepo. That means that whenever 

cgse-2025.0.5/docs/libs/cgse-common/index.md

@@ -0,0 +1,18 @@
+# Common Code
+
+
+This package `cgse-common` contain modules that are used by all other packages. 
+
+## Binary: `egse.bits`
+
+TBW
+
+## Environment: `egse.env`
+
+TBW
+
+## System: `egse.system`
+
+TBW
+
+## 

cgse-2025.0.5/docs/libs/cgse-coordinates/index.md

@@ -0,0 +1,2 @@
+
+# Reference Coordinates

cgse-2025.0.5/docs/libs/cgse-core/index.md

@@ -0,0 +1 @@
+# Core Services

cgse-2025.0.5/docs/libs/cgse-gui/index.md

@@ -0,0 +1 @@
+# GUI Components

cgse-2025.0.5/docs/libs/index.md

@@ -0,0 +1,11 @@
+
+# Libraries
+
+The libraries are those packages that make up the CGSE framework.
+
+The libraries are located under the `libs` folder, and we currently find the following packages there:
+
+- `cgse-common`
+- `cgse-core`
+- `cgse-coordinates`
+- `cgse-gui`

cgse-2025.0.5/docs/projects/cgse-tools.md

@@ -0,0 +1,2 @@
+
+# Tools for the CGSE framework

cgse-2025.0.5/docs/projects/index.md

@@ -0,0 +1,16 @@
+# Projects
+
+The projects are those packages that add functionality to the CGSE framework.
+
+The projects live under the folder `projects`, and they are organised in _generic_ and _specific_ projects. Generic 
+projects do not have an implementation that is specific for one particular project, while, obviously, specific 
+projects have. We currently have the following generic packages:
+
+- `cgse-tools`
+- `symetrie-hexapod`
+
+and then there are the project specific packages:
+
+- `plato-fits`
+- `plato-hdf5`
+- `plato-spw`

cgse-2025.0.5/docs/projects/symetrie-hexapod.md

@@ -0,0 +1,2 @@
+
+# The Symétrie Hexapods

{cgse-2025.0.4 → cgse-2025.0.5}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "2025.0.4"
+version = "2025.0.5"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IVS KU Leuven"}
@@ -47,6 +47,7 @@ filterwarnings = [
 [tool.coverage.run]
 omit = [
     "tests/*",
+    "conftest.py",
 ]
 
 [tool.hatch.build.targets.sdist]

{cgse-2025.0.4 → cgse-2025.0.5}/libs/cgse-common/src/egse/control.py

@@ -5,7 +5,6 @@ import abc
 import logging
 import pickle
 import threading
-from typing import Any
 
 import zmq
 

{cgse-2025.0.4 → cgse-2025.0.5}/libs/cgse-common/src/egse/env.py

@@ -40,32 +40,38 @@ WARNING:
 from __future__ import annotations
 
 __all__ = [
-    "get_project_name",
-    "get_site_id",
-    "get_data_storage_location",
-    "set_data_storage_location",
-    "get_data_storage_location_env_name",
+    "env_var",
     "get_conf_data_location",
-    "set_conf_data_location",
     "get_conf_data_location_env_name",
     "get_conf_repo_location",
-    "set_conf_repo_location",
     "get_conf_repo_location_env_name",
+    "get_data_storage_location",
+    "get_data_storage_location_env_name",
+    "get_local_settings",
+    "get_local_settings_env_name",
     "get_log_file_location",
-    "set_log_file_location",
     "get_log_file_location_env_name",
-    "get_local_settings",
+    "get_project_name",
+    "get_site_id",
+    "set_conf_data_location",
+    "set_conf_repo_location",
+    "set_data_storage_location",
     "set_local_settings",
-    "get_local_settings_env_name",
+    "set_log_file_location",
 ]
 
+import contextlib
 import os
 import warnings
 from pathlib import Path
 
 from egse.system import all_logging_disabled
+from egse.system import get_caller_info
 from egse.system import ignore_m_warning
 
+from rich.console import Console
+console = Console(width=100)
+
 # Every project shall have a PROJECT and a SITE_ID environment variable set. This variable will be used to
 # create the other environment variables that are specific to the project.
 
@@ -123,11 +129,18 @@ class _Env:
         self._env = {}
 
     def set(self, key, value):
-        self._env[key] = value
+        if value is None:
+            if key in self._env:
+                del self._env[key]
+        else:
+            self._env[key] = value
 
     def get(self, key) -> str:
         return self._env.get(key, NoValue())
 
+    def __rich__(self):
+        return self._env
+
 
 _env = _Env()
 
@@ -159,28 +172,60 @@ def _check_no_value(var_name, value):
     """Raise a ValueError when the value for the variable is NoValue."""
     if value == NoValue():
         project = _env.get("PROJECT")
-        env_name = var_name if var_name == "SITE_ID" else f"{project}_{var_name}"
+        env_name = var_name if var_name in ("PROJECT", "SITE_ID") else f"{project}_{var_name}"
         raise ValueError(
             f"The environment variable {env_name} is not set. "
             f"Please set the environment variable before proceeding."
         )
 
 
+def set_default_environment(
+        project: str,
+        site_id: str,
+        data_storage_location: str | Path,
+        conf_data_location: str | Path | None = None,
+        conf_repo_location: str | Path | None = None,
+        log_file_location: str | Path | None = None,
+        local_settings: str | Path | None = None,
+):
+    set_project_name(project)
+    set_site_id(site_id)
+    set_data_storage_location(data_storage_location)
+    set_conf_data_location(conf_data_location)
+    set_conf_repo_location(conf_repo_location)
+    set_log_file_location(log_file_location)
+    set_local_settings(local_settings)
+
+
 def get_project_name():
+    """Get the PROJECT name. Return None when the PROJECT is not set."""
     return _env.get("PROJECT") or None
 
 
+def set_project_name(name: str):
+    """Set the environment variable PROJECT and its internal representation."""
+    os.environ["PROJECT"] = name
+    _env.set("PROJECT", name)
+
+
 def get_site_id():
+    """Get the SITE_ID. Return None if the SITE_ID is not set."""
     return _env.get("SITE_ID") or None
 
 
+def set_site_id(name: str):
+    """Set the environment variable SITE_ID and its internal representation."""
+    os.environ["SITE_ID"] = name
+    _env.set("SITE_ID", name)
+
+
 def get_data_storage_location_env_name() -> str:
     """Returns the name of the environment variable for the project."""
     project = _env.get("PROJECT")
     return f"{project}_DATA_STORAGE_LOCATION"
 
 
-def set_data_storage_location(location: str | Path):
+def set_data_storage_location(location: str | Path | None):
     """
     Sets the environment variable and the internal representation to the given value.
 
@@ -189,14 +234,19 @@ def set_data_storage_location(location: str | Path):
     """
     env_name = get_data_storage_location_env_name()
 
-    # Check if location exists and is readable
+    if location is None:
+        if env_name in os.environ:
+            del os.environ[env_name]
+        _env.set("DATA_STORAGE_LOCATION", None)
+        return
+
     if not Path(location).exists():
         warnings.warn(
             f"The location you provided for the environment variable {env_name} doesn't exist: {location}."
         )
 
-    os.environ[env_name] = location
-    _env.set('DATA_STORAGE_LOCATION', location)
+    os.environ[env_name] = str(location)
+    _env.set('DATA_STORAGE_LOCATION', str(location))
 
 
 def get_data_storage_location(site_id: str = None) -> str:
@@ -223,6 +273,9 @@ def get_data_storage_location(site_id: str = None) -> str:
     """
     global _env
 
+    project = _env.get("PROJECT")
+    _check_no_value("PROJECT", project)
+
     site_id = site_id or _env.get("SITE_ID")
     _check_no_value("SITE_ID", site_id)
 
@@ -240,7 +293,7 @@ def get_conf_data_location_env_name() -> str:
     return f"{project}_CONF_DATA_LOCATION"
 
 
-def set_conf_data_location(location: str | Path):
+def set_conf_data_location(location: str | Path | None):
     """
     Sets the environment variable and the internal representation to the given value.
 
@@ -250,7 +303,12 @@ def set_conf_data_location(location: str | Path):
 
     env_name = get_conf_data_location_env_name()
 
-    # Check if location exists and is readable
+    if location is None:
+        if env_name in os.environ:
+            del os.environ[env_name]
+        _env.set("CONF_DATA_LOCATION", None)
+        return
+
     if not Path(location).exists():
         warnings.warn(
             f"The location you provided for the environment variable {env_name} doesn't exist: {location}."
@@ -303,7 +361,7 @@ def get_log_file_location_env_name():
     return f"{project}_LOG_FILE_LOCATION"
 
 
-def set_log_file_location(location: str | Path):
+def set_log_file_location(location: str | Path | None):
     """
     Sets the environment variable and the internal representation to the given value.
 
@@ -313,7 +371,12 @@ def set_log_file_location(location: str | Path):
 
     env_name = get_log_file_location_env_name()
 
-    # Check if location exists and is readable
+    if location is None:
+        if env_name in os.environ:
+            del os.environ[env_name]
+        _env.set("LOG_FILE_LOCATION", None)
+        return
+
     if not Path(location).exists():
         warnings.warn(
             f"The location you provided for the environment variable {env_name} doesn't exist: {location}."
@@ -365,17 +428,24 @@ def get_local_settings_env_name() -> str:
     return f"{project}_LOCAL_SETTINGS"
 
 
-def set_local_settings(path: str | Path):
+def set_local_settings(path: str | Path | None):
     """
     Sets the environment variable and the internal representation to the given value.
 
+    When the path is set to None, the environment variable will be unset.
+
     Warnings:
         Issues a warning when the given path doesn't exist.
     """
 
     env_name = get_local_settings_env_name()
 
-    # Check if location exists and is readable
+    if path is None:
+        if env_name in os.environ:
+            del os.environ[env_name]
+        _env.set('LOCAL_SETTINGS', None)
+        return
+
     if not Path(path).exists():
         warnings.warn(
             f"The location you provided for the environment variable {env_name} doesn't exist: {path}."
@@ -399,34 +469,61 @@ def get_local_settings() -> str:
     return local_settings or None
 
 
+def has_conf_repo_location() -> bool:
+    location = _env.get("CONF_REPO_LOCATION")
+    return True if location else False
+
+
 def get_conf_repo_location_env_name() -> str:
     """Returns the name of the environment variable for the project."""
     project = _env.get("PROJECT")
     return f"{project}_CONF_REPO_LOCATION"
 
 
-def get_conf_repo_location() -> str:
-    """Returns the fully qualified name of the location of the repository with configuration and calibration data."""
+def get_conf_repo_location() -> str | None:
+    """
+    Returns the fully qualified name of the location of the repository with
+    configuration and calibration data.
+
+    Returns None if no environment variable was defined or if the location doesn't exist.
+    In both cases a Warning is issued.
+    """
 
     location = _env.get("CONF_REPO_LOCATION")
 
-    if location and not Path(location).exists():
+    if location in (None, NoValue()):
+        warnings.warn(
+            f"The environment variable for the configuration data repository is "
+            f"not defined ({get_conf_repo_location_env_name()})."
+        )
+        return None
+
+    if not Path(location).exists():
         warnings.warn(f"The location of the configuration data repository doesn't exist: {location}.")
+        return None
 
-    return location or None
+    return location
 
 
-def set_conf_repo_location(location: str):
+def set_conf_repo_location(location: str | Path | None):
     """
     Sets the environment variable and the internal representation to the given value.
 
+    When the location is None, the environment variable will be unset and its internal
+    representation will be NoValue().
+
     Warnings:
         Issues a warning when the given location doesn't exist.
     """
 
     env_name = get_conf_repo_location_env_name()
 
-    # Check if location exists and is readable
+    if location is None:
+        if env_name in os.environ:
+            del os.environ[env_name]
+        _env.set("CONF_REPO_LOCATION", None)
+        return
+
     if not Path(location).exists():
         warnings.warn(
             f"The location you provided for the environment variable {env_name} doesn't exist: {location}."
@@ -436,7 +533,69 @@ def set_conf_repo_location(location: str):
     _env.set('CONF_REPO_LOCATION', location)
 
 
-ignore_m_warning('egse.env')
+def print_env():
+    """
+    Prints out the mandatory and known environment variables at the time of the
+    function call. The function and lineno is also printed for information.
+    """
+    col_width = 30
+
+    console = Console(width=200)
+
+    with warnings.catch_warnings():
+        warnings.simplefilter("ignore")
+        caller_info = get_caller_info(level=2)
+        console.print(f"[b]Environment as in {caller_info.filename}:{caller_info.lineno}[/]")
+        console.print(f"  {'PROJECT':{col_width}s}: {get_project_name()}")
+        console.print(f"  {'SITE_ID':{col_width}s}: {get_site_id()}")
+        console.print(f"  {get_data_storage_location_env_name():{col_width}s}: {get_data_storage_location()}")
+        console.print(f"  {get_log_file_location_env_name():{col_width}s}: {get_log_file_location()}")
+        console.print(f"  {get_conf_data_location_env_name():{col_width}s}: {get_conf_data_location()}")
+        console.print(f"  {get_conf_repo_location_env_name():{col_width}s}: {get_conf_repo_location()}")
+        console.print(f"  {get_local_settings_env_name():{col_width}s}: {get_local_settings()}")
+
+
+@contextlib.contextmanager
+def env_var(**kwargs):
+    """
+    Context manager to run some code that need alternate settings for environment variables.
+    This will automatically initialize the CGSE environment upon entry and re-initialize upon exit.
+
+    NOTE: This context manager is different from the one from `egse.system` because of the CGSE environment changes.
+
+    Args:
+        **kwargs: dictionary with environment variables that are needed
+
+    Examples:
+
+        >>> from egse.env import env_var
+        >>> with env_var(PLATO_DATA_STORAGE_LOCATION="/Users/rik/data"):
+        ...    # do stuff that needs these alternate setting
+        ...    pass
+
+    """
+    saved_env = {}
+
+    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
+
+    initialize()
+
+    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
+
+    initialize()
 
 
 def main(args: list | None = None):  # pragma: no cover
@@ -517,8 +676,10 @@ def main(args: list | None = None):  # pragma: no cover
             location = get_data_storage_location()
             if not Path(location).exists():
                 if args.mkdir:
-                    rich.print(f"  [green]⟶ Creating data storage location: {location}[/]")
+                    rich.print(f"  [green]⟶ Creating data storage location: {location} (+ daily + obs)[/]")
                     Path(location).mkdir(parents=True)
+                    (Path(location) / "daily").mkdir()
+                    (Path(location) / "obs").mkdir()
                 else:
                     rich.print("  [red]⟶ ERROR: The data storage location doesn't exist![/]")
             else:
@@ -540,6 +701,16 @@ def main(args: list | None = None):  # pragma: no cover
         except ValueError as exc:
             rich.print(f"    get_conf_data_location() = [red]{exc}[/]")
 
+        try:
+            rich.print(f"    {get_conf_repo_location() = }", flush=True, end="")
+            location = get_conf_repo_location()
+            if location is None or not Path(location).exists():
+                rich.print("  [red]⟶ ERROR: The configuration repository location doesn't exist![/]")
+            else:
+                rich.print()
+        except ValueError as exc:
+            rich.print(f"    get_conf_repo_location() = [red]{exc}[/]")
+
         try:
             rich.print(f"    {get_log_file_location() = }", flush=True, end="")
             location = get_log_file_location()
@@ -623,6 +794,9 @@ def main(args: list | None = None):  # pragma: no cover
     # PLATO_COMMON_EGSE_PATH - YES
 
 
+ignore_m_warning('egse.env')
+
+
 if __name__ == "__main__":
     import sys
     main(sys.argv[1:])

{cgse-2025.0.4 → cgse-2025.0.5}/libs/cgse-common/src/egse/protocol.py

@@ -20,7 +20,7 @@ from prometheus_client import Summary
 from egse.command import Command
 from egse.command import CommandExecution
 from egse.control import ControlServer
-from egse.control import Failure
+from egse.response import Failure
 from egse.device import DeviceConnectionObserver
 from egse.system import format_datetime
 from egse.zmq_ser import bind_address

{cgse-2025.0.4 → cgse-2025.0.5}/libs/cgse-common/src/egse/response.py

@@ -2,9 +2,10 @@
 This module provides functionality to handle responses from the control servers.
 """
 __all__ = [
-    "Success",
     "Failure",
     "Message",
+    "Response",
+    "Success",
 ]
 
 from typing import Any

{cgse-2025.0.4 → cgse-2025.0.5}/libs/cgse-common/src/egse/services.py

@@ -10,6 +10,7 @@ logging levels, or to quit the control server in a controlled way.
 
 import inspect
 import logging
+from pathlib import Path
 
 from egse.command import ClientServerCommand
 from egse.control import ControlServer
@@ -22,7 +23,9 @@ from egse.zmq_ser import connect_address
 
 LOGGER = logging.getLogger(__name__)
 
-SERVICE_SETTINGS = Settings.load(filename="services.yaml")
+HERE = Path(__file__).parent
+
+SERVICE_SETTINGS = Settings.load(filename=str(HERE / "services.yaml"))
 
 
 class ServiceCommand(ClientServerCommand):