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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-common
-Version: 0.17.1
+Version: 0.17.2
 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.2.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/decorators.py,sha256=ZJgXKP8IEniOFd8nHljNeUNpQLAB2Z9q4UiQsnLFzhA,27204
 egse/device.py,sha256=Ga5MNE96ERuPLDzmb0HF7UfjrTqfp0f_r3NDVZY9l28,13595
 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
@@ -25,21 +25,21 @@ 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=N4R9w7mN_cDBBaIT_cMLD6XLckndPNfOeOPvCgIOUK0,16231
+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/socketdevice.py,sha256=gcte_MRx7zZNmGPw9iHCiCjqkEyZ0Iyz6U5BiIozjPQ,14730
 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.2.dist-info/METADATA,sha256=YtL6AJnAcG0svnDmWhjTTZ37wDuXPJPb6pfaGyK56VU,3068
+cgse_common-0.17.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cgse_common-0.17.2.dist-info/entry_points.txt,sha256=xJsPRIDjtADVgd_oEDHVW10wS5LG30Ox_3brVKeyCGw,168
+cgse_common-0.17.2.dist-info/RECORD,,

{cgse_common-0.17.1.dist-info → cgse_common-0.17.2.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/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

egse/scpi.py

@@ -9,12 +9,15 @@ from egse.device import AsyncDeviceTransport
 from egse.device import DeviceConnectionError
 from egse.device import DeviceError
 from egse.device import DeviceTimeoutError
+from egse.env import bool_env
 from egse.log import logger
 
 DEFAULT_READ_TIMEOUT = 1.0  # seconds
 DEFAULT_CONNECT_TIMEOUT = 3.0  # seconds
 IDENTIFICATION_QUERY = "*IDN?"
 
+VERBOSE_DEBUG = bool_env("VERBOSE_DEBUG")
+
 SEPARATOR = b"\n"
 SEPARATOR_STR = SEPARATOR.decode()
 
@@ -75,8 +78,7 @@ class AsyncSCPIInterface(AsyncDeviceInterface, AsyncDeviceTransport):
         self._connect_lock = asyncio.Lock()
         """Prevents multiple, simultaneous connect or disconnect attempts."""
         self._io_lock = asyncio.Lock()
-        """Prevents multiple coroutines from attempting to read, write or query from the same stream
-        at the same time."""
+        """Prevents multiple coroutines from attempting to read, write or query from the same stream at the same time."""
 
     def is_simulator(self) -> bool:
         return False
@@ -166,6 +168,10 @@ class AsyncSCPIInterface(AsyncDeviceInterface, AsyncDeviceTransport):
 
                 self._is_connection_open = True
 
+                response = await self.read_string()
+                if VERBOSE_DEBUG:
+                    logger.debug(f"Response after connection: {response}")
+
                 logger.debug(f"Successfully connected to {self._device_name}.")
 
             except asyncio.TimeoutError as exc:
@@ -338,23 +344,23 @@ class AsyncSCPIInterface(AsyncDeviceInterface, AsyncDeviceTransport):
                 if not self._is_connection_open or self._writer is None:
                     raise DeviceConnectionError(self._device_name, "Device not connected, use connect() first")
 
-                # Ensure command ends with newline
+                # Ensure command ends with the required terminator
                 if not command.endswith(SEPARATOR_STR):
                     command += SEPARATOR_STR
 
-                logger.info(f"-----> {command}")
+                logger.info(f"-----> {command=}")
                 self._writer.write(command.encode())
                 await self._writer.drain()
 
-                # First, small delay to allow device to prepare response
+                # First, small delay to allow the device to prepare a response
                 await asyncio.sleep(0.01)
 
-                # Try to read until newline (common SCPI terminator)
+                # Try to read until the required separator (common SCPI terminator)
                 try:
                     response = await asyncio.wait_for(
                         self._reader.readuntil(separator=SEPARATOR), timeout=self.read_timeout
                     )
-                    logger.info(f"<----- {response}")
+                    logger.info(f"<----- {response=}")
                     return response
 
                 except asyncio.IncompleteReadError as exc:

egse/settings.py

@@ -380,6 +380,37 @@ class Settings:
 
         return msg.rstrip()
 
+    @classmethod
+    def from_string(cls, yaml_string: str, group: str | None = None) -> attrdict:
+        """
+        Creates a Settings object from a YAML string.
+
+        Args:
+            yaml_string (str): the YAML configuration as a string
+
+        Returns:
+            An attribute dictionary with all the settings from the given string.
+        """
+        try:
+            yaml_document = yaml.load(yaml_string, Loader=SAFE_LOADER)
+            settings = attrdict({name: value for name, value in yaml_document.items()}, label="Settings")
+        except yaml.YAMLError as exc:
+            logger.error(exc)
+            raise SettingsError("Error loading YAML document from string") from exc
+
+        if not settings:
+            logger.warning(
+                "The Settings YAML string is empty. No local settings were loaded, an empty dictionary is returned."
+            )
+
+        if group:
+            if group in settings:
+                settings = attrdict({name: value for name, value in settings[group].items()}, label=group)
+            else:
+                raise SettingsError(f"Group name '{group}' is not defined in the provided YAML string.")
+
+        return settings
+
 
 def main(args: list | None = None):  # pragma: no cover
     # We provide convenience to inspect the settings by calling this module directly from Python.

egse/socketdevice.py

@@ -155,7 +155,7 @@ class SocketDevice(DeviceConnectionInterface, DeviceTransport):
 
         try:
             while True:
-                # compute remaining timeout for select, this is needed because we read in different parts
+                # compute the remaining timeout for select, this is needed because we read in different parts
                 # until ETX is received, and we want to receive the complete messages including ETX within
                 # the read timeout.
                 if end_time is None:

egse/system.py

@@ -10,8 +10,6 @@ The module has external dependencies to:
 
 """
 
-from __future__ import annotations
-
 import asyncio
 import builtins
 import collections
@@ -30,6 +28,7 @@ import os
 import platform  # For getting the operating system name
 import re
 import shutil
+import signal
 import socket
 import subprocess  # For executing a shell command
 import sys
@@ -60,7 +59,6 @@ from rich.text import Text
 from rich.tree import Tree
 from typer.core import TyperCommand
 
-import signal
 from egse.log import logger
 
 EPOCH_1958_1970 = 378691200
@@ -107,7 +105,7 @@ class Periodic:
         interval: float,
         *,
         name: str | None = None,
-        callback: Callable = None,
+        callback: Callable | None = None,
         repeat: int | None = None,
         skip: bool = True,
         pause: bool = False,
@@ -202,7 +200,7 @@ class Periodic:
         """Triggers the Timer's action: either call its callback, or logs a message."""
 
         if self._callback is None:
-            self._logger.warning(f"Periodic – No callback provided for interval timer {self.name}.")
+            self._logger.warning(f"Periodic - No callback provided for interval timer {self.name}.")
             return
 
         try:
@@ -211,7 +209,7 @@ class Periodic:
             self._logger.debug("Caught CancelledError on callback function in Periodic.")
             raise
         except Exception as exc:
-            self._logger.error(f"{type(exc).__name__} caught: {exc}")
+            self._logger.error(f"{type_name(exc)} caught: {exc}")
 
     @property
     def interval(self):
@@ -370,8 +368,8 @@ def ignore_m_warning(modules=None):
         modules = [modules]
 
     try:
-        import warnings
         import re
+        import warnings
 
         msg = "'{module}' found in sys.modules after import of package"
         for module in modules:
@@ -390,7 +388,10 @@ def now(utc: bool = True):
 
 
 def format_datetime(
-    dt: Union[str, datetime.datetime] = None, fmt: str = None, width: int = 6, precision: int = 3
+    dt: str | datetime.datetime | datetime.date | None = None,
+    fmt: str | None = None,
+    width: int = 6,
+    precision: int = 3,
 ) -> str:
     """Format a datetime as YYYY-mm-ddTHH:MM:SS.μs+0000.
 
@@ -452,6 +453,10 @@ def format_datetime(
     if fmt:
         timestamp = dt.strftime(fmt)
     else:
+        # If dt is a date (not datetime), convert to datetime at midnight
+        if isinstance(dt, datetime.date) and not isinstance(dt, datetime.datetime):
+            dt = datetime.datetime.combine(dt, datetime.time.min)
+
         width = min(width, precision)
         timestamp = (
             f"{dt.strftime('%Y-%m-%dT%H:%M')}:"
@@ -727,18 +732,29 @@ def get_host_ip() -> Optional[str]:
     return None
 
 
-def get_current_location():
+def get_current_location() -> tuple[str, int, str]:
     """
     Returns the location where this function is called, i.e. the filename, line number, and function name.
+
+    If the location cannot be determined, ("", 0, "") is returned.
     """
-    frame = inspect.currentframe().f_back
+    frame = inspect.currentframe()
+    logger.debug(f"{frame = }")
+    if frame is None:
+        return "", 0, ""
 
-    filename = inspect.getframeinfo(frame).filename
-    line_number = inspect.getframeinfo(frame).lineno
-    function_name = inspect.getframeinfo(frame).function
+    previous_frame = frame.f_back
+    logger.debug(f"{previous_frame = }")
+    if previous_frame is None:
+        return "", 0, ""
+
+    filename = inspect.getframeinfo(previous_frame).filename
+    line_number = inspect.getframeinfo(previous_frame).lineno
+    function_name = inspect.getframeinfo(previous_frame).function
 
     # Clean up to prevent reference cycles
     del frame
+    del previous_frame
 
     return filename, line_number, function_name
 
@@ -1364,7 +1380,7 @@ def chdir(dirname=None):
 
 
 @contextlib.contextmanager
-def env_var(**kwargs: dict[str, str]):
+def env_var(**kwargs: str):
     """
     Context manager to run some code that need alternate settings for environment variables.
 
@@ -1540,6 +1556,7 @@ def read_last_lines(filename: str | Path, num_lines: int) -> List[str]:
     sanity_check(num_lines >= 0, "the number of lines to read shall be a positive number or zero.")
 
     if not filename.exists():
+        logger.warning(f"File does not exist: {filename}")
         return []
 
     # Declaring variable to implement exponential search
@@ -2321,22 +2338,44 @@ def caffeinate(pid: int = None):
         subprocess.Popen([shutil.which("caffeinate"), "-i", "-w", str(pid)])
 
 
-def redirect_output_to_log(output_fn: str, append: bool = False) -> TextIO:
+def redirect_output_to_log(output_fn: str, append: bool = False, overwrite=True) -> TextIO:
     """
-    Open file in the log folder where process output will be redirected.
-
+    Open the file in the log folder where the current process output will be redirected.
     When no location can be determined, the user's home directory will be used.
 
-    The file is opened in text mode at the given location and the stream (file descriptor) will be returned.
+    The file will be opened in text mode.
+
+    Args:
+        output_fn: the name of the output file
+        append: True to append to the file, False to overwrite
+        overwrite: when False and the file exists, an exception is raised
+
+    Returns:
+        The file stream (TextIO) where output can be redirected to.
+
+    Raises:
+        FileExistsError: when the output file exists, append is False and overwrite is False.
     """
 
-    try:
-        from egse.env import get_log_file_location
+    if Path(output_fn).is_absolute():
+        output_path = Path(output_fn)
+    else:
+        try:
+            from egse.env import get_log_file_location
+
+            location = get_log_file_location()
+            output_path = Path(location, output_fn).expanduser()
+        except ValueError:
+            output_path = Path.home() / output_fn
 
-        location = get_log_file_location()
-        output_path = Path(location, output_fn).expanduser()
-    except ValueError:
-        output_path = Path.home() / output_fn
+    output_path.parent.mkdir(parents=True, exist_ok=True)
+
+    if output_path.exists() and not append:
+        if not overwrite:
+            raise FileExistsError(
+                f"Output file {output_path!s} already exists and will be overwritten. "
+                f"Use overwrite=True to allow overwriting."
+            )
 
     out = open(output_path, "a" if append else "w")
 

egse/version.py

@@ -31,7 +31,7 @@ __all__ = [
 ]
 
 
-def get_version_from_settings_file_raw(group_name: str, location: Path | str = None) -> str:
+def get_version_from_settings_file_raw(group_name: str, location: Path | str | None = None) -> str:
     """
     Reads the VERSION field from the `settings.yaml` file in raw mode, meaning the file
     is not read using the PyYAML module, but using the `readline()` function of the file
@@ -66,7 +66,7 @@ def get_version_from_settings_file_raw(group_name: str, location: Path | str = N
     return version
 
 
-def get_version_from_settings(group_name: str, location: Path = None):
+def get_version_from_settings(group_name: str, location: Path | None = None, yaml_string: str | None = None) -> str:
     """
     Reads the VERSION field from the `settings.yaml` file. This function first tries to load the proper Settings
     and Group and if that fails uses the raw method.
@@ -74,6 +74,7 @@ def get_version_from_settings(group_name: str, location: Path = None):
     Args:
         group_name: major group name that contains the VERSION field, i.e. Common-EGSE or PLATO_TEST_SCRIPTS.
         location: the location of the `settings.yaml` file or None in which case the location of this file is used.
+        yaml_string: optional YAML string to read the settings from instead of a file.
 
     Raises:
         A RuntimeError when the group_name is incorrect and unknown or the VERSION field is not found.
@@ -81,10 +82,14 @@ def get_version_from_settings(group_name: str, location: Path = None):
     Returns:
         The version from the `settings.yaml` file as a string.
     """
-    from egse.settings import Settings, SettingsError
+    from egse.settings import Settings
+    from egse.settings import SettingsError
 
     try:
-        settings = Settings.load(group_name, location=location)
+        if location is None and yaml_string is not None:
+            settings = Settings.from_string(yaml_string, group=group_name)
+        else:
+            settings = Settings.load(group_name, location=location)
         version = settings.VERSION
     except (ModuleNotFoundError, SettingsError):
         version = get_version_from_settings_file_raw(group_name, location=location)
@@ -92,7 +97,7 @@ def get_version_from_settings(group_name: str, location: Path = None):
     return version
 
 
-def get_version_from_git(location: str = None):
+def get_version_from_git(location: str | Path | None = None) -> str:
     """
     Returns the Git version number for the repository at the given location.
 
@@ -121,12 +126,12 @@ def get_version_from_git(location: str = None):
             proc = subprocess.run(
                 ["git", "describe", "--tags", "--long", "--always"], stderr=subprocess.PIPE, stdout=subprocess.PIPE
             )
-            if proc.stderr:
-                version = None
             if proc.stdout:
                 version = proc.stdout.strip().decode("ascii")
+            else:
+                version = "0.0.0"
         except subprocess.CalledProcessError:
-            version = None
+            version = "0.0.0"
 
     return version
 
@@ -144,12 +149,13 @@ def get_version_installed(package_name: str) -> str:
     from egse.system import chdir
 
     with chdir(Path(__file__).parent):
-        from importlib.metadata import version, PackageNotFoundError
+        from importlib.metadata import PackageNotFoundError
+        from importlib.metadata import version as get_version
 
         try:
-            version = version(package_name)
+            version = get_version(package_name)
         except PackageNotFoundError:
-            version = None
+            version = "0.0.0"
 
     return version
 
@@ -162,11 +168,12 @@ VERSION = get_version_installed("cgse-common")
 # The __PYPI_VERSION__ is the version number that will be used for the installation.
 # The version will appear in PyPI and also as the `installed version`.
 
-__PYPI_VERSION__ = VERSION.split("+")[0]
+__PYPI_VERSION__ = VERSION.split("+")[0] if VERSION else "0.0.0"
 
 
-if __name__ == "__main__":
+def main():
     import rich
+
     from egse.plugin import entry_points
 
     if VERSION:
@@ -178,3 +185,7 @@ if __name__ == "__main__":
     for ep in entry_points("cgse.version"):
         if installed_version := get_version_installed(ep.name):
             rich.print(f"Installed version for {ep.name}= [bold default]{installed_version}[/]")
+
+
+if __name__ == "__main__":
+    main()