cgse-common 0.16.1__tar.gz → 0.16.2__tar.gz

{cgse_common-0.16.1 → cgse_common-0.16.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-common
-Version: 0.16.1
+Version: 0.16.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.16.1 → cgse_common-0.16.2}/pyproject.toml

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

{cgse_common-0.16.1 → cgse_common-0.16.2}/src/egse/env.py

@@ -384,7 +384,7 @@ def set_log_file_location(location: str | Path | None):
     _env.set("LOG_FILE_LOCATION", location)
 
 
-def get_log_file_location(site_id: str = None) -> str:
+def get_log_file_location(site_id: str = None, check_exists: bool = False) -> str:
     """
     Returns the full path of the location of the log files. The log file location is read from the environment
     variable `${PROJECT}_LOG_FILE_LOCATION`. The location shall be independent of any setting that is subject to change.
@@ -392,8 +392,12 @@ def get_log_file_location(site_id: str = None) -> str:
     If the environment variable is not set, a default log file location is created from the data storage location as
     follows: `<PROJECT>_DATA_STORAGE_LOCATION/<SITE_ID>/log`.
 
+    There is no check for the existence of the returned location. The caller function shall check if the
+    returned value is a directory and if it exists.
+
     Args:
         site_id: the site identifier
+        check_exists: check if the location that will be returned is a directory and exists
 
     Returns:
         The full path of location of the log files as a string.
@@ -417,6 +421,10 @@ def get_log_file_location(site_id: str = None) -> str:
         data_root = data_root.rstrip("/")
         log_data_root = f"{data_root}/log"
 
+    if check_exists:
+        if not Path(log_data_root).is_dir():
+            raise ValueError(f"The location that was constructed doesn't exist: {log_data_root}")
+
     return log_data_root
 
 

{cgse_common-0.16.1 → cgse_common-0.16.2}/src/egse/system.py

@@ -48,6 +48,7 @@ from typing import Callable
 from typing import Iterable
 from typing import List
 from typing import Optional
+from typing import TextIO
 from typing import Tuple
 from typing import Type
 from typing import Union
@@ -60,6 +61,7 @@ from rich.tree import Tree
 from typer.core import TyperCommand
 
 import signal
+from egse.env import get_log_file_location
 from egse.log import logger
 
 EPOCH_1958_1970 = 378691200
@@ -2307,6 +2309,28 @@ 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:
+    """
+    Open file in the log folder where 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.
+    """
+
+    try:
+        location = get_log_file_location()
+        output_path = Path(location, output_fn).expanduser()
+    except ValueError:
+        output_path = Path.home() / output_fn
+
+    out = open(output_path, "a" if append else "w")
+
+    logger.info(f"Output will be redirected to {output_path!s}")
+
+    return out
+
+
 ignore_m_warning("egse.system")
 
 if __name__ == "__main__":