cgse-common 0.16.10__tar.gz → 0.16.12__tar.gz

{cgse_common-0.16.10 → cgse_common-0.16.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-common
-Version: 0.16.10
+Version: 0.16.12
 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>
@@ -22,6 +22,7 @@ Requires-Dist: pandas>=2.2.0; python_version >= '3.10'
 Requires-Dist: prometheus-client>=0.21.1
 Requires-Dist: psutil>=6.1.1
 Requires-Dist: psycopg>=3.2.9
+Requires-Dist: python-dotenv>=1.1.1
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: pyzmq==23.2.1; python_version == '3.9'
 Requires-Dist: pyzmq>=25.1.0; python_version >= '3.10'

{cgse_common-0.16.10 → cgse_common-0.16.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.16.10"
+version = "0.16.12"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}
@@ -43,6 +43,7 @@ dependencies = [
     "duckdb>=1.3.1",
     "requests>=2.32.4",
     "psycopg>=3.2.9",
+    "python-dotenv>=1.1.1",
 ]
 
 [project.scripts]

{cgse_common-0.16.10 → cgse_common-0.16.12}/src/egse/env.py

@@ -42,6 +42,7 @@ locations and settings.
 from __future__ import annotations
 
 __all__ = [
+    "bool_env",
     "env_var",
     "get_conf_data_location",
     "get_conf_data_location_env_name",

{cgse_common-0.16.10 → cgse_common-0.16.12}/src/egse/setup.py

@@ -117,6 +117,7 @@ from __future__ import annotations
 __all__ = [
     "Setup",
     "setup_ctx",
+    "disentangle_filename",
     "navdict",  # noqa: ignore typo
     "list_setups",
     "load_setup_from_disk",

{cgse_common-0.16.10 → cgse_common-0.16.12}/src/egse/system.py

@@ -71,19 +71,32 @@ TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%f%z"
 class Periodic:
     """A timer that periodically invokes a function in the background.
 
-    If no callback is provided, a warning message will be logged. In a future, we might send out an event to the
-    application (will need an event handler).
+    This class schedules a callback to be executed at regular intervals using asyncio.
+    If no callback is provided, a warning message will be logged. If the callback execution
+    takes longer than the interval, and `skip` is True (default), the timer will skip missed
+    intervals to maintain the schedule.
 
-    When the function execution takes longer then the interval there re several options:
-
-    - if skip is True (default) the interval will take precedence and the
     Args:
-        interval: The time between timer events, in seconds.
-        name: A name to assign the event (for debugging), defaults to `Periodic#`.
-        callback: A optional callback to invoke when the event is handled.
-        repeat: The number of times to repeat the timer, or None to repeat forever.
-        skip: Enable skipping of scheduled function calls that couldn't be sent in time.
-        pause: Start the timer paused. Use `resume()` to activate the timer.
+        interval (float): The time between timer events, in seconds.
+        name (str, optional): A name to assign the event (for debugging), defaults to `Periodic#`.
+        callback (Callable, optional): A callback to invoke when the event is handled.
+        repeat (int, optional): The number of times to repeat the timer, or None to repeat forever.
+        skip (bool, optional): Enable skipping of scheduled function calls that couldn't be sent in time.
+        pause (bool, optional): Start the timer paused. Use `resume()` to activate the timer.
+
+    Methods:
+        start(): Start the timer.
+        stop(): Stop the timer.
+        is_running(): Return True if the timer is running.
+        is_paused(): Return True if the timer is paused.
+        pause(): Pause the timer.
+        reset(): Reset the timer to start from the beginning.
+        resume(): Resume a paused timer.
+
+    Note:
+        The timer runs asynchronously and is suitable for use in asyncio-based applications.
+        If the callback is a coroutine, it will be awaited.
+
     """
 
     _periodic_count: int = 0

{cgse_common-0.16.10 → cgse_common-0.16.12}/src/egse/zmq_ser.py

@@ -44,17 +44,26 @@ def recv_zipped_pickle(socket, flags=0, protocol=-1):
     return pickle.loads(p)
 
 
-def get_port_number(socket: zmq.Socket) -> int | None:
+def get_port_number(socket: zmq.Socket | None) -> int:
     """
-    Returns the port number associated with this socket. Returns None for sockets
-    that do not bind to a TCP or IPC transport.
+    Returns the port number associated with this socket.
+
+    If the socket is bound to a TCP or IPC transport, the port number is extracted from the
+    LAST_ENDPOINT socket option.
+
+    Returns:
+        - 0 for sockets that do not bound to a TCP or IPC transport.
+        - 0 if the socket is None.
     """
+    if socket is None:
+        return 0
+
     endpoint = socket.getsockopt(zmq.LAST_ENDPOINT)
-    if endpoint:
+    if endpoint and isinstance(endpoint, bytes):
         port = endpoint.decode("utf-8").split(":")[-1]
         return int(port)
     else:
-        return None
+        return 0
 
 
 def zmq_string_request(request: str) -> list: