cgse-common 0.17.1__py3-none-any.whl → 0.17.3__py3-none-any.whl

{cgse_common-0.17.1.dist-info → cgse_common-0.17.3.dist-info}/METADATA

@@ -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.dist-info → cgse_common-0.17.3.dist-info}/RECORD

@@ -1,18 +1,18 @@
 cgse_common/__init__.py,sha256=wTYOpVomEeDFFuqt4Ss9ROSAIa48UUnYCSafdEOx-CU,129
 cgse_common/cgse.py,sha256=S8MxwJcSzqYNR0wirEscQw5CTg89AKORa8-NHRdrxJM,6642
 cgse_common/settings.yaml,sha256=PS8HOoxbhwVoQ7zzDtZyhx25RZB6SGq3uXNuJTgtRIw,443
-egse/bits.py,sha256=cg6diLN2IwNtnrlZyLgXPfDf9ttcHzS2A7Tjwlwc-lQ,12498
+egse/bits.py,sha256=6UrQdZ8nZ347rDdJ47a1PTWcq3fZt-c3siDjFfBGgiA,12389
 egse/calibration.py,sha256=a5JDaXTC6fMwQ1M-qrwNO31Ass-yYSXxDQUK_PPsZg4,8818
 egse/config.py,sha256=M821_d1IfNT17J3tt_TDjh4bGJgGiYviGBYR0I5v5LA,9639
 egse/counter.py,sha256=7UwBeTAu213xdNdGAOYpUWNQ4jD4yVM1bOG10Ax4UFs,5097
-egse/decorators.py,sha256=RT_-TmcHLN3oqha-1xn-YbqT1tEtKA84zr0Qu1KFyKo,27176
-egse/device.py,sha256=Ga5MNE96ERuPLDzmb0HF7UfjrTqfp0f_r3NDVZY9l28,13595
+egse/decorators.py,sha256=ZJgXKP8IEniOFd8nHljNeUNpQLAB2Z9q4UiQsnLFzhA,27204
+egse/device.py,sha256=gfv5Eazf1nZt3U59w9RwSWnKnAMs4hZrhb4Zv5xBvGE,11431
 egse/dicts.py,sha256=dUAq7PTPvs73OrZb2Fh3loxvYv4ifUiK6bBcgrFU77Y,3972
-egse/env.py,sha256=2ZeEOyVUp9IANy4S0XK53KUMohelbct7S3lR6iWpeks,31704
-egse/exceptions.py,sha256=QB3MZRJizecWOj1cPbvG0UcIqFn7NRJ6rw1xtdNSFxw,1225
+egse/env.py,sha256=MWftGEmodckKbjXxFGm3WsQRnZ96wCDR3bci0KzZP0Y,31705
+egse/exceptions.py,sha256=yhOtO5NkCxgvTyVo8fgTyxauX-ZtiEkxDB76ZdCbPrM,1301
 egse/heartbeat.py,sha256=2SeZzX3tWFog1rgYThX-iaZPwHYq8TVma2ll7r624Eg,3039
 egse/hk.py,sha256=AumSpB8SYXes75CB2iiKXfLkMK5IkVDHITFKrf8IT6g,32010
-egse/log.py,sha256=Q_TviwuyMam6CwRklaJk1lZM5WIZK_L9GS7wWDy_naM,5251
+egse/log.py,sha256=5sdVQC2DfBlHbOQzY8ChzLjoL7kNDMErTZFaj97aNBE,5350
 egse/metrics.py,sha256=2hHtJXG0Rn782l2bfmLNBbw6ucC5nf7jPnNzqbhP_Zs,7012
 egse/observer.py,sha256=xQ7F7NVHqdRZ6IIsBM5M0kMuullMghoR98dwAsjgh0s,1287
 egse/obsid.py,sha256=y87AYX5mtNEBqEtpEFEec2MhEmo1Hej3Wwi5od84wR8,5848
@@ -21,25 +21,21 @@ egse/plugin.py,sha256=RDH1R65vuxpEOSmibYoRPhtPsDLn7MIRXQkDhFgt3Hk,10337
 egse/process.py,sha256=iw17U1c3nzTON7JQaHGZTN8KzqV-3WtbdX2GGUeevn4,26850
 egse/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 egse/randomwalk.py,sha256=dllGv_F4AFYanp_A5ynBsAjglYzxaPYpRCBifwQScx4,6451
-egse/ratelimit.py,sha256=JdJxD6UIi9LYngKEsG9zh8bTE9r_56D4EZCnp_fkrI0,9161
 egse/reload.py,sha256=PzOE0m1tmcNcQPVFH8orMe_cMoQIIiH9Gw2anpQTC40,4717
 egse/resource.py,sha256=kzNI6kJOE6Jd5QKJs2MkVAycUpwpOTLi1qydh3NSRng,15345
 egse/response.py,sha256=F04uqOYv1ClpHgDLYZlKTuOCSldHs5TezI_4x6zf2Fw,2717
-egse/scpi.py,sha256=4OxgNc7HhQKZ7Gsg_tYstQKw_o4BxH8LVslG_X5ecz8,15965
-egse/settings.py,sha256=m95NuhLYdmRK4-SKZ4awhGp4X_6vCcb_yLvm7dmY-Dg,15656
+egse/scpi.py,sha256=DBTvB_p7yaGVW1aNJ6yhxGhWCuSe2uFzMCjFOy3XmZM,13375
+egse/settings.py,sha256=eiZ9eGydgF9lNBjHH8VqOgcFDxSdhO6dLs7pYA725lo,16849
 egse/settings.yaml,sha256=mz9O2QqmiptezsMvxJRLhnC1ROwIHENX0nbnhMaXUpE,190
 egse/setup.py,sha256=ezPYA3n1P3navdPR3qDxh0qJvZCzGl2bIREEP9n2w3Y,34116
 egse/signal.py,sha256=f5pyOiNW9iTSIxV_ce5stIfG0ub9MRbaekE85kQOVzs,7992
-egse/socketdevice.py,sha256=7Q1DstV94pgilOD_e5BnqprTGcXi-XNijdLTw4m4dRY,14726
 egse/state.py,sha256=HdU2MFOlYRbawYRZmizV6Y8MgnZrUF0bx4fXaYU-M_s,3023
-egse/system.py,sha256=3aycoK15UvNdk2yxQ8hx4N-s2Ag4BqTTPQ8eFuJa3Ko,76111
+egse/system.py,sha256=DWKOWkqz5HJMW3526VN7wbMAQv1_EuY3oNeavEydUak,77517
 egse/task.py,sha256=ODSLE05f31CgWsSVcVFFq1WYUZrJMb1LioPTx6VM824,2804
-egse/version.py,sha256=e9GvelUZ9mfCDlRju4MWEJeMHJW9kUzK6SKzJpyj91s,6156
+egse/version.py,sha256=vPUsCy9HYR7nKm0Sg6EDoq1JtkBKPCr3kYrt9QYM1B8,6602
 egse/zmq_ser.py,sha256=YJFupsxuvhI8TJMeS2Hem9oMMcVmSBx0rZv93gvN-hA,3263
-egse/plugins/metrics/duckdb.py,sha256=E2eeNo3I7ajRuByodaYiPNvC0Zwyc7hsIlhr1W_eXdo,16148
 egse/plugins/metrics/influxdb.py,sha256=WnAqTWRkAyMSd7W2ASwUAIEwFborrv55iX-umceevFA,8162
-egse/plugins/metrics/timescaledb.py,sha256=Ug0NWDV1Ky2VeFY6tDZL9xg6AFgnAEh2F_llVPnlRBA,21191
-cgse_common-0.17.1.dist-info/METADATA,sha256=DKZF-wlYPiRujjFleFHI1IIgWL2GdLDJ3ySq-gOK1xk,3068
-cgse_common-0.17.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cgse_common-0.17.1.dist-info/entry_points.txt,sha256=xJsPRIDjtADVgd_oEDHVW10wS5LG30Ox_3brVKeyCGw,168
-cgse_common-0.17.1.dist-info/RECORD,,
+cgse_common-0.17.3.dist-info/METADATA,sha256=tlkWJwh-TWW4AEBHyzl5lDiXk_awl34jJcDiD08bpuI,3068
+cgse_common-0.17.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cgse_common-0.17.3.dist-info/entry_points.txt,sha256=xJsPRIDjtADVgd_oEDHVW10wS5LG30Ox_3brVKeyCGw,168
+cgse_common-0.17.3.dist-info/RECORD,,

{cgse_common-0.17.1.dist-info → cgse_common-0.17.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

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'

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/).
 
 
     """

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.

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()

egse/exceptions.py

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

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