cgse 0.16.11__tar.gz → 0.16.13__tar.gz

{cgse-0.16.11 → cgse-0.16.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 0.16.11
+Version: 0.16.13
 Summary: Generic Common-EGSE: Commanding and monitoring lab equipment
 Author: IvS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.16.11"
+version = "0.16.13"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-coordinates/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-coordinates"
-version = "0.16.11"
+version = "0.16.13"
 description = "Reference Frames and Coordinate Transofrmations for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-core"
-version = "0.16.11"
+version = "0.16.13"
 description = "Core services for the CGSE framework"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-core/src/egse/async_control.py

@@ -18,7 +18,6 @@ from rich.traceback import Traceback
 from egse.env import bool_env
 from egse.exceptions import InitialisationError
 from egse.log import logging
-from egse.process import ProcessStatus
 from egse.registry.client import AsyncRegistryClient
 from egse.system import Periodic
 from egse.system import get_current_location
@@ -48,6 +47,7 @@ RECREATE_SOCKET = False
 """Recreate ZeroMQ socket after a timeout. Set to True when experiencing problems 
 with corrupted socket states. This is mainly used for REQ-REP protocols."""
 
+
 class SocketType(Enum):
     """The socket type defines which socket to use for the intended communication."""
 
@@ -498,8 +498,7 @@ class AsyncControlServer:
             self._sequential_queue.put_nowait(coroutine_func)
 
 
-class DummyAsyncControlServer(AsyncControlServer):
-    ...
+class DummyAsyncControlServer(AsyncControlServer): ...
 
 
 DEFAULT_CLIENT_REQUEST_TIMEOUT = 5.0  # seconds
@@ -510,12 +509,12 @@ DEFAULT_LINGER = 100  # milliseconds
 
 class AsyncControlClient:
     def __init__(
-            self,
-            endpoint: str | None = None,
-            service_type: str | None = None,
-            client_id: str = CONTROL_CLIENT_ID,
-            timeout: float = DEFAULT_CLIENT_REQUEST_TIMEOUT,
-            linger: int = DEFAULT_LINGER,
+        self,
+        endpoint: str | None = None,
+        service_type: str | None = None,
+        client_id: str = CONTROL_CLIENT_ID,
+        timeout: float = DEFAULT_CLIENT_REQUEST_TIMEOUT,
+        linger: int = DEFAULT_LINGER,
     ):
         self.logger = logging.getLogger("egse.async_control.client")
 
@@ -672,10 +671,7 @@ class AsyncControlClient:
         return response
 
     async def block(self, sleep: int, timeout: int | None = None) -> str | None:
-        cmd = {
-            'command': 'block',
-            'sleep': sleep
-        }
+        cmd = {"command": "block", "sleep": sleep}
         response = await self._send_request(SocketType.SERVICE, cmd, timeout=timeout)
         if response["success"]:
             return response["message"]
@@ -708,10 +704,10 @@ class AsyncControlClient:
             return None
 
     async def _send_request(
-            self,
-            socket_type: SocketType,
-            request: dict[str, Any] | str,
-            timeout: float | None = None,
+        self,
+        socket_type: SocketType,
+        request: dict[str, Any] | str,
+        timeout: float | None = None,
     ) -> dict[str, Any]:
         """
         Send a request to the control server and get the response.
@@ -832,7 +828,6 @@ class AsyncControlClient:
                 return self.service_command_socket
 
     def recreate_socket(self, socket_type: SocketType):
-
         if RECREATE_SOCKET:
             self.logger.warning(f"Recreating {socket_type.name} socket ...")
             match socket_type:
@@ -845,6 +840,7 @@ class AsyncControlClient:
         else:
             self.logger.debug("Socket recreation after timeout has been disabled.")
 
+
 async def cs_test_device_command_timeouts():
     """
     This test is about timeouts on the client and blocking commands on the server

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-core/src/egse/confman/confman_acs.py

@@ -14,7 +14,6 @@ PROCESS_NAME = "cm_acs"
 
 class AsyncConfigurationManager(AsyncControlServer):
     def __init__(self):
-
         multiprocessing.current_process().name = PROCESS_NAME
 
         super().__init__()

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-core/src/egse/mixin.py

@@ -104,7 +104,7 @@ def add_cr_lf(cmd_string: str) -> str:
     return cmd_string
 
 
-def expand_kwargs(kwargs: Dict):
+def expand_kwargs(kwargs: Dict) -> str:
     """Expand keyword arguments and their values as 'key=value' separated by spaces."""
     return " ".join(f"{k}={v}" for k, v in kwargs.items())
 

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-core/tests/test_mixin.py

@@ -201,10 +201,26 @@ def pre_command(transport: DeviceTransport = None, **kwargs):
     LOGGER.info(f"Inside pre_command({transport.__class__.__name__}, {kwargs})")
 
 
-def post_command(transport: DeviceTransport = None, response: bytes = None):
+def post_command(transport: DeviceTransport = None, response: bytes = None) -> bytes:
     LOGGER.info(f"Inside post_command(transport={transport.__class__.__name__}, {response=})")
     return response
 
+def rewrite_kwargs(kwargs: dict) -> str:
+    """Rewrite some of the keyword arguments according to device specs."""
+
+    def calc_crc(data) -> int:
+        return len(data)
+
+    # assume we need to build our own fancy device command string...
+    address = kwargs.get("address")
+    identifier = kwargs.get("identifier")
+    cargo1 = kwargs.get("cargo1", 1)
+    cargo2 = kwargs.get("cargo2", 2)
+
+    cmd = f"{address:06X} 0x{identifier:06x} DEV_07463 CARGO1={cargo1:04d} CARGO2={cargo2}"
+
+    return f"{cmd} {calc_crc(cmd)}"
+
 
 class NewStyleCommandInterface:
     """Interface definition for new style dynamic commands."""
@@ -251,10 +267,25 @@ class NewStyleCommandInterface:
     def test_cmd_enum_with_format(self, enumeration: MyEnum):
         """Returns the command string"""
 
+    @dynamic_command(
+        cmd_type="transaction",
+        cmd_string="ARG_EXPANSION::{mode}::{crc:06x}",
+        use_format=True
+    )
+    def test_cmd_with_arg_expansion(self, *, mode, crc):
+        """Return the command string, after processing the arguments in the overriding function."""
+
     @dynamic_command(cmd_type="transaction", cmd_string="msg = ${msg}", pre_cmd=pre_command, post_cmd=post_command)
-    def test_cmd_pre_post(self, msg: str):
+    def test_cmd_pre_post(self, msg: str) -> bytes:
         """Return the command string, executes pre- and post-commands."""
 
+    @dynamic_command(cmd_type="transaction", cmd_string="TRANS ${a} ${kwargs}")
+    def test_cmd_process_kwargs(self, *, a, **kwargs):
+        """Returns the command string."""
+
+    @dynamic_command(cmd_type="transaction", cmd_string="TRANS ${kwargs}", process_kwargs=rewrite_kwargs)
+    def test_cmd_rewrite_kwargs(self, **kwargs):
+        """Returns the command string with rewritten kwargs."""
 
 class NewStyleCommand(DynamicCommandMixin, NewStyleCommandInterface):
     """Simple new style commanding interface."""
@@ -263,6 +294,30 @@ class NewStyleCommand(DynamicCommandMixin, NewStyleCommandInterface):
         self.transport = NewStyleTransport()
         super().__init__()
 
+    def test_cmd_with_arg_expansion(self, *, mode, **kwargs):
+        # This function overrides the function from the NewStyleCommandInterface. The reason for doing that is
+        # because we need to reformat and/or process the arguments before passing them to the decorated function.
+
+        # rewrite 'mode'
+        mode = f"{mode:04x}"
+
+        if "crc" in kwargs:
+            crc = kwargs['crc']
+        else:
+            # 'calculate' the checksum
+            crc = 0x1234
+
+        # pass the method as defined in the NewStyleCommandInterface, to the handle_dynamic_command method of
+        # the mixin class. Provide the expected parameters as if the decorated function would have been called.
+        return DynamicCommandMixin.handle_dynamic_command(
+            self,
+            super().test_cmd_with_arg_expansion
+        )(
+            mode=mode, crc=crc
+        )
+
+        # Note that the following doesn't work, I didn't really figure out why yet...
+        # return super().test_cmd_with_mode_expansion(mode, crc)
 
 def test_new_style(caplog):
     caplog.set_level(logging.INFO)
@@ -319,6 +374,16 @@ def test_new_style(caplog):
         in caplog.text
     )
 
+    assert ns.test_cmd_with_arg_expansion(mode=23) == b"ARG_EXPANSION::0017::001234"
+    assert ns.test_cmd_with_arg_expansion(mode=0x10, crc=5678) == b"ARG_EXPANSION::0010::00162e"
+
+    # This tests the expansion of kwargs in the function's signature, by the default `expand_kwargs`
+    assert ns.test_cmd_process_kwargs(a=5, b=2, c=3) == b"TRANS 5 b=2 c=3"
+
+    tcu_mode=42  # == 0x2A
+    assert ns.test_cmd_rewrite_kwargs(address=5, identifier=2, cargo2=f"{hex(int(tcu_mode))[2:].zfill(4)}") == (
+        b"TRANS 000005 0x000002 DEV_07463 CARGO1=0001 CARGO2=002a 49"
+    )
 
 def test_interface_definition():
     with pytest.raises(TypeError):

{cgse-0.16.11 → cgse-0.16.13}/libs/cgse-gui/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-gui"
-version = "0.16.11"
+version = "0.16.13"
 description = "GUI components for CGSE"
 authors = [
     {name = "Rik Huygen", email = "rik.huygen@kuleuven.be"},

{cgse-0.16.11 → cgse-0.16.13}/projects/generic/cgse-tools/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-tools"
-version = "0.16.11"
+version = "0.16.13"
 description = "Tools for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/projects/generic/keithley-tempcontrol/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "keithley-tempcontrol"
-version = "0.16.11"
+version = "0.16.13"
 description = "Keithley Temperature Control for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/projects/generic/lakeshore-tempcontrol/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lakeshore-tempcontrol"
-version = "0.16.11"
+version = "0.16.13"
 description = "Lakeshore Temperature Control for CGSE"
 authors = [
     {name = "IVS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/projects/generic/symetrie-hexapod/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "symetrie-hexapod"
-version = "0.16.11"
+version = "0.16.13"
 description = "Symetrie Hexapod implementation for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/projects/generic/symetrie-hexapod/src/egse/hexapod/symetrie/__init__.py

@@ -102,7 +102,6 @@ class ProxyFactory(DeviceFactoryInterface):
     """
 
     def create(self, device_type: str, *, device_id: str = None, **_ignored):
-
         logger.debug(f"{device_type=}, {device_id=}")
 
         with RegistryClient() as reg:

{cgse-0.16.11 → cgse-0.16.13}/projects/generic/symetrie-hexapod/src/egse/hexapod/symetrie/puna_ui.py

@@ -54,6 +54,7 @@ MODULE_LOGGER = logging.getLogger(__name__)
 
 load_dotenv(override=True)
 
+
 class DeviceControllerType(IntEnum):
     ALPHA = 0
     ALPHA_PLUS = 1
@@ -347,6 +348,7 @@ def parse_arguments():
 
 app = typer.Typer()
 
+
 @app.command()
 def main(device_id: str, device_type: str = "proxy", profile: bool = False):
     multiprocessing.current_process().name = "puna_ui"
@@ -370,7 +372,7 @@ def main(device_id: str, device_type: str = "proxy", profile: bool = False):
             Settings.set_profiling(True)
 
         if device_type == "proxy":
-            *_, device_id, device_name, _ = get_hexapod_controller_pars(device_id)
+            _, _, device_id, device_name, *_ = get_hexapod_controller_pars(device_id)
             factory = ProxyFactory()
             proxy = factory.create(device_name, device_id=device_id)
             if not proxy.ping():

{cgse-0.16.11 → cgse-0.16.13}/projects/plato/plato-fits/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plato-fits"
-version = "0.16.11"
+version = "0.16.13"
 description = "FITS Persistence implementation for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/projects/plato/plato-hdf5/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plato-hdf5"
-version = "0.16.11"
+version = "0.16.13"
 description = "HDF5 Persistence sub-class for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/projects/plato/plato-spw/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plato-spw"
-version = "0.16.11"
+version = "0.16.13"
 description = "SpaceWire implementation for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.11 → cgse-0.16.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse"
-version = "0.16.11"
+version = "0.16.13"
 description = "Generic Common-EGSE: Commanding and monitoring lab equipment"
 authors = [
     {name = "IvS KU Leuven"}