cgse-common 0.17.1__tar.gz → 0.17.3__tar.gz

{cgse_common-0.17.1 → cgse_common-0.17.3}/.gitignore

@@ -32,6 +32,11 @@ venv
 
 .idea
 
+# VSCode IDE
+
+.vscode
+*.code-workspace
+
 # MKDOCS documentation site
 
 /site

{cgse_common-0.17.1 → cgse_common-0.17.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-common
-Version: 0.17.1
+Version: 0.17.3
 Summary: Software framework to support hardware testing
 Author: IvS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

{cgse_common-0.17.1 → cgse_common-0.17.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.17.1"
+version = "0.17.3"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}
@@ -68,19 +68,23 @@ markers = [
     "slow: marks tests as slow (deselect with '-m \"not slow\"')"
 ]
 
+# Some of these omitted files are only temporary omitted until refactored
 [tool.coverage.run]
 omit = [
     "tests/*",
     "conftest.py",
+    "src/egse/ratelimit.py",
+    "src/egse/plugins/metrics/duckdb.py",
+    "src/egse/plugins/metrics/timescaledb.py",
 ]
 
 [tool.hatch.build.targets.sdist]
 exclude = [
-    "/tests",
-    "/pytest.ini",
-    "/.gitignore",
-    "/*poetry*",
-    "/*setuptools*",
+    "tests",
+    "pytest.ini",
+    ".gitignore",
+    "*poetry*",
+    "*setuptools*",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -90,8 +94,12 @@ packages = ["src/egse", "src/scripts", "src/cgse_common"]
 line-length = 120
 
 [tool.ruff.lint]
+select = ["F", "I"]
 extend-select = ["E", "W"]
 
+[tool.ruff.lint.isort]
+force-single-line = true
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

{cgse_common-0.17.1 → cgse_common-0.17.3}/src/egse/bits.py

@@ -5,7 +5,6 @@ This module contains a number of convenience functions to work with bits, bytes
 from __future__ import annotations
 
 import ctypes
-from collections.abc import Iterable
 from typing import Union
 
 
@@ -33,7 +32,7 @@ def extract_bits(value: int, start_position: int, num_bits: int) -> int:
     return extracted_bits
 
 
-def set_bit(value: int, bit) -> int:
+def set_bit(value: int, bit: int) -> int:
     """
     Set bit to 1 for the given value.
 
@@ -47,7 +46,7 @@ def set_bit(value: int, bit) -> int:
     return value | (1 << bit)
 
 
-def set_bits(value: int, bits: tuple) -> int:
+def set_bits(value: int, bits: tuple[int, int]) -> int:
     """
     Set the given bits in value to 1.
 
@@ -63,7 +62,7 @@ def set_bits(value: int, bits: tuple) -> int:
     return value
 
 
-def clear_bit(value: int, bit) -> int:
+def clear_bit(value: int, bit: int) -> int:
     """
     Set bit to 0 for the given value.
 
@@ -77,7 +76,7 @@ def clear_bit(value: int, bit) -> int:
     return value & ~(1 << bit)
 
 
-def clear_bits(value: int, bits: tuple) -> int:
+def clear_bits(value: int, bits: tuple[int, int]) -> int:
     """
     Set the given bits in value to 0.
 
@@ -93,7 +92,7 @@ def clear_bits(value: int, bits: tuple) -> int:
     return value
 
 
-def toggle_bit(value: int, bit) -> int:
+def toggle_bit(value: int, bit: int) -> int:
     """
     Toggle the bit in the given value.
 
@@ -107,7 +106,7 @@ def toggle_bit(value: int, bit) -> int:
     return value ^ (1 << bit)
 
 
-def bit_set(value: int, bit) -> bool:
+def bit_set(value: int, bit: int) -> bool:
     """
     Return True if the bit is set.
 
@@ -122,27 +121,25 @@ def bit_set(value: int, bit) -> bool:
     return value & bit_value == bit_value
 
 
-def bits_set(value: int, *args: Union[int, Iterable[int]]) -> bool:
+def bits_set(value: int, *args: int) -> bool:
     """
     Return True if all the bits are set.
 
     Args:
         value (int): the value to check
         args: a set of indices of the bits to check, starting from 0 at the LSB.
-            All the indices can be given as separate arguments, or they can be passed
-            in as a list.
+            All the indices shall be given as separate arguments, i.e. unpack a list
+            if needed.
 
     Returns:
         True if all the bits are set (1).
 
     Examples:
-        >>> assert bits_set(0b0101_0000_1011, [0, 1, 3, 8, 10])
-        >>> assert bits_set(0b0101_0000_1011, [3, 8])
-        >>> assert not bits_set(0b0101_0000_1011, [1, 2, 3])
+        >>> assert bits_set(0b0101_0000_1011, 0, 1, 3, 8, 10)
+        >>> assert bits_set(0b0101_0000_1011, 3, 8)
+        >>> assert not bits_set(0b0101_0000_1011, *[1, 2, 3])
     """
 
-    if len(args) == 1 and isinstance(args[0], list):
-        args = args[0]
     return all([bit_set(value, bit) for bit in args])
 
 
@@ -506,7 +503,7 @@ def crc_calc(data: list[bytes | int], start: int, len_: int) -> int:
     Reference:
         The description of the CRC calculation for RMAP is given in the ECSS document
         _Space Engineering: SpaceWire - Remote Memory Access Protocol_, section A.3
-        on page 80 [ECSS‐E‐ST‐50‐52C].
+        on page 80 [ECSS-E-ST-50-52C].
 
     """
     crc: int = 0
@@ -548,7 +545,7 @@ def s16(value: int) -> int:
         >>> s16(0b1000_0000_0001_0001)
         -32751
 
-        The 'bin()' fuction will return a strange representation of this number:
+        The 'bin()' function will return a strange representation of this number:
 
         >>> bin(-32751)
         '-0b111111111101111'

{cgse_common-0.17.1 → cgse_common-0.17.3}/src/egse/decorators.py

@@ -15,8 +15,8 @@ from typing import Optional
 
 import rich
 
-from egse.system import get_caller_info
 from egse.log import logger
+from egse.system import get_caller_info
 
 
 def static_vars(**kwargs):
@@ -316,7 +316,10 @@ def debug(func):
 
 
 def profile_func(
-    output_file: str = None, sort_by: str = "cumulative", lines_to_print: int = None, strip_dirs: bool = False
+    output_file: str | None = None,
+    sort_by: str = "cumulative",
+    lines_to_print: int | None = None,
+    strip_dirs: bool = False,
 ) -> Callable:
     """A time profiler decorator.
 
@@ -346,7 +349,7 @@ def profile_func(
         decorator](https://gist.github.com/ekhoda/2de44cf60d29ce24ad29758ce8635b78).
 
         Inspired by and modified the profile decorator of Giampaolo Rodola:
-        [profile decorato](http://code.activestate.com/recipes/577817-profile-decorator/).
+        [profile decorator](http://code.activestate.com/recipes/577817-profile-decorator/).
 
 
     """

{cgse_common-0.17.1 → cgse_common-0.17.3}/src/egse/device.py

@@ -339,76 +339,6 @@ class AsyncDeviceTransport:
         return await self.trans(command)
 
 
-class AsyncDeviceConnectionInterface(DeviceConnectionObservable):
-    """Generic connection interface for all Device classes and Controllers.
-
-    This interface shall be implemented in the Controllers that directly connect to the
-    hardware, but also in the simulators to guarantee an identical interface as the controllers.
-
-    This interface will be implemented in the Proxy classes through the
-    YAML definitions. Therefore, the YAML files shall define at least
-    the following commands: `connect`, `disconnect`, `reconnect`, `is_connected`.
-    """
-
-    def __init__(self):
-        super().__init__()
-
-    def __enter__(self):
-        self.connect()
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.disconnect()
-
-    async def connect(self) -> None:
-        """Connect to the device controller.
-
-        Raises:
-            ConnectionError: when the connection can not be opened.
-        """
-
-        raise NotImplementedError
-
-    async def disconnect(self) -> None:
-        """Disconnect from the device controller.
-
-        Raises:
-            ConnectionError: when the connection can not be closed.
-        """
-        raise NotImplementedError
-
-    async def reconnect(self):
-        """Reconnect the device controller.
-
-        Raises:
-            ConnectionError: when the device can not  be reconnected for some reason.
-        """
-        raise NotImplementedError
-
-    async def is_connected(self) -> bool:
-        """Check if the device is connected.
-
-        Returns:
-            True if the device is connected and responds to a command, False otherwise.
-        """
-        raise NotImplementedError
-
-
-class AsyncDeviceInterface(AsyncDeviceConnectionInterface):
-    """A generic interface for all device classes."""
-
-    def is_simulator(self) -> bool:
-        """Checks whether the device is a simulator rather than a real hardware controller.
-
-        This can be useful for testing purposes or when doing actual movement simulations.
-
-        Returns:
-            True if the Device is a Simulator; False if the Device is connected to real hardware.
-        """
-
-        raise NotImplementedError
-
-
 class DeviceFactoryInterface:
     """
     Base class for creating a device factory class to access devices.

{cgse_common-0.17.1 → cgse_common-0.17.3}/src/egse/env.py

@@ -72,8 +72,8 @@ import os
 import warnings
 from pathlib import Path
 
-from dotenv import load_dotenv as _load_dotenv
 from dotenv import find_dotenv
+from dotenv import load_dotenv as _load_dotenv
 from rich.console import Console
 
 from egse.decorators import static_vars
@@ -697,6 +697,7 @@ def env_var(**kwargs: str | int | float | bool | None):
 def main(args: list | None = None):  # pragma: no cover
     import argparse
     import sys
+
     import rich
 
     parser = argparse.ArgumentParser()

{cgse_common-0.17.1 → cgse_common-0.17.3}/src/egse/exceptions.py

@@ -61,3 +61,6 @@ class Abort(RuntimeError):
 
 class InitialisationError(Error):
     """Raised when an initialisation failed."""
+
+
+InitializationError = InitialisationError  # Alias with American spelling

{cgse_common-0.17.1 → cgse_common-0.17.3}/src/egse/log.py

@@ -18,6 +18,7 @@ __all__ = [
     "LOG_DATE_FORMAT_FULL",
     "LOG_DATE_FORMAT_CLEAN",
     "logger",
+    "logging",  # export to guarantee that this module is imported and initialized before users use logging
     "root_logger",
     "egse_logger",
     "get_log_level_from_env",
@@ -84,7 +85,7 @@ class NonEGSEFilter(logging.Filter):
         return not record.name.startswith("egse")
 
 
-def get_log_level_from_env(env_var: str = "LOG_LEVEL", default: int = logging.INFO):
+def get_log_level_from_env(env_var: str = "LOG_LEVEL", default: str = "INFO") -> int:
     """Read the log level from an environment variable."""
     log_level_str = os.getenv(env_var, default)
 
@@ -95,18 +96,16 @@ def get_log_level_from_env(env_var: str = "LOG_LEVEL", default: int = logging.IN
         if 10 <= log_level <= 50:
             return log_level
         else:
-            logging.warning(
-                f"Log level {log_level} outside standard range (10-50). Using {logging.getLevelName(default)}."
-            )
-            return default
+            logging.warning(f"Log level {log_level} outside standard range (10-50). Using {default.upper()}.")
+            return logging._nameToLevel[default.upper()]
 
     except ValueError:
         log_level_str = log_level_str.upper()
         try:
             return getattr(logging, log_level_str)
         except AttributeError:
-            logging.error(f"Invalid LOG_LEVEL '{log_level_str}'. Using {logging.getLevelName(default)}.")
-            return default
+            logging.error(f"Invalid LOG_LEVEL '{log_level_str}'. Using {default.upper()}.")
+            return logging._nameToLevel[default.upper()]
 
 
 egse_logger = logging.getLogger("egse")
@@ -145,7 +144,7 @@ if __name__ == "__main__":
             Environment variables:
               - LOG_LEVEL=debug|info|warning|critical
               - LOG_FORMAT=full|clean
-            
+
             Example logging statements
               - logging level set to INFO
               - logging format set to full