cgse-common 2023.1.4__tar.gz → 2024.1.0__tar.gz

cgse_common-2024.1.0/.gitignore

@@ -0,0 +1,18 @@
+.python-version
+.envrc
+
+build
+dist
+
+.DS_Store
+
+__pycache__
+.pytest_cache
+
+.env
+.venv
+venv
+
+.idea
+
+**/*.egg-info

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/PKG-INFO

@@ -1,26 +1,30 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cgse-common
-Version: 2023.1.4
-Summary: Software framework to support testing hardware
-Author: Rik Huygen
-Author-email: rik.huygen@kuleuven.be
-Requires-Python: >=3.8,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: GitPython (>=3.1.40,<4.0.0)
-Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
-Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: deepdiff (>=6.6.1,<7.0.0)
-Requires-Dist: distro (>=1.8.0,<2.0.0)
-Requires-Dist: numpy
+Version: 2024.1.0
+Summary: Software framework to support hardware testing
+Author-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
+License-Expression: MIT
+Keywords: CGSE,Common-EGSE,hardware testing,software framework
+Requires-Python: >=3.8
+Requires-Dist: click
+Requires-Dist: deepdiff
+Requires-Dist: distro
+Requires-Dist: gitpython
+Requires-Dist: numpy==1.22.4
 Requires-Dist: pandas
-Requires-Dist: prometheus-client (>=0.17.1,<0.18.0)
-Requires-Dist: psutil (>=5.9.6,<6.0.0)
-Requires-Dist: pyzmq (>=25.1.1,<26.0.0)
-Requires-Dist: rich (>=13.6.0,<14.0.0)
+Requires-Dist: prometheus-client
+Requires-Dist: psutil
+Requires-Dist: pyyaml
+Requires-Dist: pyzmq==23.2.1
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: pipdeptree; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: tomlkit; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
 Description-Content-Type: text/markdown
 
 # Generic Functionality used in the PLATO Common-EGSE
@@ -56,4 +60,3 @@ A non-comprehensive list of available functionality:
 * **egse.resource**: provides convenience functions to use resources in your code without the need to specify an absolute path
 * **egse.system**: defines convenience functions that provide information on system specific functionality like, file system interactions, timing, operating system interactions, etc.
 * **egse.version**: functionality to retrieve the package version information
-

cgse_common-2024.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "cgse-common"
+version = "2024.1.0"
+description = "Software framework to support hardware testing"
+authors = [
+    {name = "Rik Huygen", email = "rik.huygen@kuleuven.be"},
+    {name = "Sara Regibo", email = "sara.regibo@kuleuven.be"}
+]
+readme = {"file" = "README.md", "content-type" = "text/markdown"}
+requires-python = ">=3.8"
+license = "MIT"
+keywords = [
+    "CGSE",
+    "Common-EGSE",
+    "hardware testing",
+    "software framework"
+]
+dependencies = [
+    "click",
+    "deepdiff",
+    "distro",
+    "gitpython",
+    "numpy == 1.22.4",  # only used in setup
+    "pandas",  # only used in setup
+    "prometheus-client",
+    "psutil",
+    "pyyaml",
+    "pyzmq == 23.2.1",
+    "rich",
+]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-mock", "pytest-cov"]
+dev = ["pipdeptree", "tomlkit", "ruff"]
+
+[project.entry-points."cgse.version"]
+cgse-common = 'egse'
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/tests",
+    "/pytest.ini",
+    "/.gitignore",
+    "/*poetry*",
+    "/*setuptools*",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/egse"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = ["E501"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/config.py

@@ -4,13 +4,9 @@ and to find paths and resources.
 """
 from __future__ import annotations
 
-import errno
 import fnmatch
 import logging
 import os
-from functools import lru_cache
-from os.path import exists
-from os.path import join
 from pathlib import Path
 from pathlib import PurePath
 from typing import List
@@ -18,10 +14,8 @@ from typing import Optional
 from typing import Tuple
 from typing import Union
 
-import git
-
-HERE = Path(__file__).parent.resolve()
-MODULE_LOGGER = logging.getLogger(__name__)
+_HERE = Path(__file__).parent.resolve()
+_LOGGER = logging.getLogger(__name__)
 
 
 def find_first_occurrence_of_dir(pattern: str, root: Path | str = None) -> Optional[Path]:
@@ -43,7 +37,7 @@ def find_first_occurrence_of_dir(pattern: str, root: Path | str = None) -> Optio
     """
     import fnmatch
 
-    root = Path(root).resolve() if root else HERE
+    root = Path(root).resolve() if root else _HERE
     if not root.is_dir():
         root = root.parent
 
@@ -171,7 +165,7 @@ def find_files(pattern: str, root: str = None, in_dir: str = None):
 
 def find_file(name: str, root: str = None, in_dir: str = None) -> Optional[Path]:
     """
-    Find the path to the given file starting from the root directory of the Common-EGSE
+    Find the path to the given file starting from the root directory of the
     distribution.
 
     Note that if there are more files with the given name found in the distribution,
@@ -239,122 +233,6 @@ def find_root(
     return Path(default) if default is not None else None
 
 
-@lru_cache(maxsize=16)
-def get_common_egse_root(path: Union[str, PurePath] = None) -> Optional[PurePath]:
-    """
-    Returns the absolute path to the installation directory for the Common-EGSE.
-
-    The algorithm first tries to determine the path from the environment variable
-    ``PLATO_COMMON_EGSE_PATH``. If this environment variable doesn't exist, the algorithm
-    tries to determine the path automatically from (1) the git root if it is a git repository,
-    or (2) from the location of this module assuming the installation is done from the
-    GitHub distribution.
-
-    When the optional argument ``path`` is given, that directory will be used to start the
-    search for the root folder.
-
-    At this moment the algorithm does not cache the ``egse_path`` in order to speed up
-    the successive calls to this function.
-
-    Args:
-        path (str or Path): a directory as a Path or str [optional]
-
-    Returns:
-        Path: the absolute path to the Common-EGSE installation directory or None
-    """
-    _TEST_NAMES = ("pyproject.toml", "setup.py")
-    if path is not None:
-        return find_root(path, tests=_TEST_NAMES)
-
-    egse_path: Union[str, PurePath, None] = os.getenv("PLATO_COMMON_EGSE_PATH")
-
-    if egse_path is None:
-
-        # The root of the plato-common-egse installation shall be determined from the location
-        # of this config module using git commands to find the git root folder.
-        # This assumes the user has installed from git/GitHub (which is not always true)!
-        #
-        # Alternatively, the root directory can be determined from the location of this module
-        # by going back in the directory structure until the ``setup.py`` module is found.
-
-        _THIS_FILE_PATH = Path(__file__).resolve()
-        _THIS_FILE_LOCATION = _THIS_FILE_PATH.parent
-
-        try:
-            git_repo = git.Repo(_THIS_FILE_PATH, search_parent_directories=True)
-            git_root = git_repo.git.rev_parse("--show-toplevel")
-            egse_path = git_root
-        except (git.exc.InvalidGitRepositoryError, git.exc.NoSuchPathError):
-            MODULE_LOGGER.info("no git repository found, assuming installation from distribution.")
-            egse_path = find_root(_THIS_FILE_LOCATION, tests=_TEST_NAMES)
-
-        MODULE_LOGGER.debug(f"Common-EGSE location is automatically determined: {egse_path}.")
-
-    else:
-        MODULE_LOGGER.debug(
-            f"Common-EGSE location determined from environment variable "
-            f"PLATO_COMMON_EGSE_PATH: {egse_path}"
-        )
-
-    return Path(egse_path)
-
-
-def get_resource_dirs(root_dir: Union[str, PurePath] = None) -> List[Path]:
-    """
-    Define directories that contain resources like images, icons, and data files.
-
-    Resource directories can have the following names: `resources`, `data`, `icons`, or `images`.
-    This function checks if any of the resource directories exist in the project root directory,
-    in the `root_dir` that is given as an argument or in the `src/egse` sub-folder.
-
-    So, the directories that are searched for the resource folders are:
-
-    * `root_dir` or the project's root directory
-    * the `src/egse` sub-folder of one of the above
-
-    For all existing directories the function returns the absolute path.
-
-    Args:
-        root_dir (str): the directory to search for resource folders
-
-    Returns:
-        a list of absolute Paths.
-    """
-    project_dir = Path(root_dir).resolve() if root_dir else get_common_egse_root()
-    result = []
-    for dir_ in ["resources", "data", "icons", "images"]:
-        if (project_dir / dir_).is_dir():
-            result.append(Path(project_dir, dir_).resolve())
-        if (project_dir / "src" / "egse" / dir_).is_dir():
-            result.append(Path(project_dir, "src", "egse", dir_).resolve())
-    return result
-
-
-def get_resource_path(name: str, resource_root_dir: Union[str, PurePath] = None) -> PurePath:
-    """
-    Searches for a data file (resource) with the given name.
-
-    When `resource_root_dir` is not given, the search for resources will start at the root
-    folder of the project (using the function `get_common_egse_root()`). Any other root
-    directory can be given, e.g. if you want to start the search from the location of your
-    source code file, use `Path(__file__).parent` as the `resource_root_dir` argument.
-
-    Args:
-        name (str): the name of the resource that is requested
-        resource_root_dir (str): the root directory where the search for resources should be started
-
-    Returns:
-        the absolute path of the data file with the given name. The first name that matches
-        is returned. If no file with the given name or path exists, a FileNotFoundError is raised.
-
-    """
-    for resource_dir in get_resource_dirs(resource_root_dir):
-        resource_path = join(resource_dir, name)
-        if exists(resource_path):
-            return Path(resource_path).absolute()
-    raise FileNotFoundError(errno.ENOENT, f"Could not locate resource '{name}'")
-
-
 def set_logger_levels(logger_levels: List[Tuple] = None):
     """
     Set the logging level for the given loggers.
@@ -368,7 +246,8 @@ def set_logger_levels(logger_levels: List[Tuple] = None):
 
 
 class WorkingDirectory:
-    """WorkingDirectory is a context manager to temporarily change the working directory while
+    """
+    WorkingDirectory is a context manager to temporarily change the working directory while
     executing some code.
 
     This context manager has a property `path` which returns the absolute path of the
@@ -402,7 +281,7 @@ class WorkingDirectory:
         try:
             os.chdir(self._current_dir)
         except OSError as exc:
-            MODULE_LOGGER.warning(f"Change back to previous directory failed: {exc}")
+            _LOGGER.warning(f"Change back to previous directory failed: {exc}")
 
     @property
     def path(self):

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/control.py

@@ -5,7 +5,6 @@ import abc
 import logging
 import pickle
 import threading
-import time
 from typing import Any
 
 import zmq

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/decorators.py

@@ -13,7 +13,7 @@ from typing import Optional
 from egse.settings import Settings
 from egse.system import get_caller_info
 
-MODULE_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(__name__)
 
 
 def static_vars(**kwargs):
@@ -95,7 +95,7 @@ def timer(*, level: int = logging.INFO, precision: int = 4):
             value = func(*args, **kwargs)
             end_time = time.perf_counter()
             run_time = end_time - start_time
-            MODULE_LOGGER.log(level, f"Finished {func.__name__!r} in {run_time:.{precision}f} secs")
+            _LOGGER.log(level, f"Finished {func.__name__!r} in {run_time:.{precision}f} secs")
             return value
 
         return wrapper_timer
@@ -160,9 +160,9 @@ def debug(func):
             args_repr = [repr(a) for a in args]
             kwargs_repr = [f"{k}={v!r}" for k, v in kwargs.items()]
             signature = ", ".join(args_repr + kwargs_repr)
-            MODULE_LOGGER.debug(f"Calling {func.__name__}({signature})")
+            _LOGGER.debug(f"Calling {func.__name__}({signature})")
             value = func(*args, **kwargs)
-            MODULE_LOGGER.debug(f"{func.__name__!r} returned {value!r}")
+            _LOGGER.debug(f"{func.__name__!r} returned {value!r}")
         else:
             value = func(*args, **kwargs)
         return value
@@ -240,10 +240,10 @@ def profile(func):
             signature = ", ".join(args_repr + kwargs_repr)
             caller = get_caller_info(level=2)
             prefix = f"PROFILE[{profile.counter}]: "
-            MODULE_LOGGER.info(f"{prefix}Calling {func.__name__}({signature})")
-            MODULE_LOGGER.info(f"{prefix}    from {caller.filename} at {caller.lineno}.")
+            _LOGGER.info(f"{prefix}Calling {func.__name__}({signature})")
+            _LOGGER.info(f"{prefix}    from {caller.filename} at {caller.lineno}.")
             value = func(*args, **kwargs)
-            MODULE_LOGGER.info(f"{prefix}{func.__name__!r} returned {value!r}")
+            _LOGGER.info(f"{prefix}{func.__name__!r} returned {value!r}")
             profile.counter -= 1
         else:
             value = func(*args, **kwargs)
@@ -257,7 +257,7 @@ def to_be_implemented(func):
 
     @functools.wraps(func)
     def wrapper_tbi(*args, **kwargs):
-        MODULE_LOGGER.warning(f"The function/method {func.__name__} is not yet implemented.")
+        _LOGGER.warning(f"The function/method {func.__name__} is not yet implemented.")
         return func(*args, **kwargs)
 
     return wrapper_tbi

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/env.py

@@ -191,14 +191,6 @@ if __name__ == "__main__":
     rich.print("Generated locations and filenames")
 
     with all_logging_disabled():
-        try:
-            rich.print(f"    {get_common_egse_root() = !s}", flush=True)
-            location = get_common_egse_root()
-            if not Path(location).exists():
-                rich.print("[red]ERROR: The generated Common-EGSE location doesn't exist![/]")
-        except ValueError as exc:
-            rich.print(f"    get_common_egse_path() = [red]{exc}[/]")
-
         try:
             rich.print(f"    {get_data_storage_location() = }", flush=True)
             location = get_data_storage_location()

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/monitoring.py

@@ -90,6 +90,7 @@ def monitoring(hostname: str, port: int, subscribe: str, multipart: bool, use_pi
     receiver.close(linger=0)
     context.term()
 
+
 if __name__ == "__main__":
     multiprocessing.current_process().name = "Monitoring"
     monitoring()

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/resource.py

@@ -75,20 +75,25 @@ their functionality is fully replaced by this `egse.resource` module.
 
 """
 
+import errno
 import logging
 import re
 from pathlib import Path
+from pathlib import PurePath
 from typing import Dict
 from typing import List
 from typing import Union
 
+from os.path import exists
+from os.path import join
+
 from egse.config import find_first_occurrence_of_dir
 from egse.config import find_files
 from egse.exceptions import InternalError
 from egse.plugin import entry_points
 from egse.system import get_package_location
 
-LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(__name__)
 
 
 class ResourceError(Exception):
@@ -106,6 +111,8 @@ class NoSuchFileError(ResourceError):
 __all__ = [
     "get_resource",
     "get_resource_locations",
+    "get_resource_dirs",
+    "get_resource_path",
     "add_resource_id",
     "initialise_resources",
     "ResourceError",
@@ -129,6 +136,8 @@ DEFAULT_RESOURCES = {
     "data": "/data",
 }
 
+_RESOURCE_DIRS = ["resources", "icons", "images", "styles", "data"]
+
 resources = {}
 
 
@@ -180,6 +189,65 @@ def get_resource_locations() -> Dict[str, List[Path]]:
     return resources.copy()
 
 
+def get_resource_dirs(root_dir: Union[str, PurePath]) -> List[Path]:
+    """
+    Define directories that contain resources like images, icons, and data files.
+
+    Resource directories can have the following names: `resources`, `data`, `icons`, or `images`.
+    This function checks if any of the resource directories exist in the `root_dir` that is given as an argument.
+
+    For all existing directories the function returns the absolute path.
+
+    If the argument root_dir is None, an empty list will be returned and a warning message will be issued.
+
+    Args:
+        root_dir (str): the directory to search for resource folders
+
+    Returns:
+        a list of absolute Paths.
+    """
+
+    if root_dir is None:
+        _LOGGER.warning("The argument root_dir can not be None, an empty list is returned.")
+        return []
+
+    root_dir = Path(root_dir).resolve()
+    if not root_dir.is_dir():
+        root_dir = root_dir.parent
+
+    result = []
+    for dir_ in _RESOURCE_DIRS:
+        if (root_dir / dir_).is_dir():
+            result.append(Path(root_dir, dir_).resolve())
+
+    return result
+
+
+def get_resource_path(name: str, resource_root_dir: Union[str, PurePath] = None) -> PurePath:
+    """
+    Searches for a data file (resource) with the given name.
+
+    When `resource_root_dir` is not given, the search for resources will start at the root
+    folder of the project (using the function `get_common_egse_root()`). Any other root
+    directory can be given, e.g. if you want to start the search from the location of your
+    source code file, use `Path(__file__).parent` as the `resource_root_dir` argument.
+
+    Args:
+        name (str): the name of the resource that is requested
+        resource_root_dir (str): the root directory w_HERE the search for resources should be started
+
+    Returns:
+        the absolute path of the data file with the given name. The first name that matches
+        is returned. If no file with the given name or path exists, a FileNotFoundError is raised.
+
+    """
+    for resource_dir in get_resource_dirs(resource_root_dir):
+        resource_path = join(resource_dir, name)
+        if exists(resource_path):
+            return Path(resource_path).absolute()
+    raise FileNotFoundError(errno.ENOENT, f"Could not locate resource '{name}'")
+
+
 def initialise_resources(root: Union[Path, str] = Path(__file__).parent):
     """
     Initialise the default resources and any resource published by a package entry point.
@@ -215,7 +283,7 @@ def initialise_resources(root: Union[Path, str] = Path(__file__).parent):
             if location not in x:
                 x.append(location)
 
-    LOGGER.debug(f"Resources have been initialised: {resources = }")
+    _LOGGER.debug(f"Resources have been initialised: {resources = }")
 
 
 def print_resources():

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/settings.yaml

@@ -8,7 +8,7 @@ SITE:
     SSH_PORT:                       22         # The TCP/IP port on which the SSH server is listening
 
 REPO:
-    PLATO_CGSE_CONF:   ENV['PLATO_CONF_REPO_LOCATION']
+    CGSE_CONF:  ENV['CGSE_CONF_REPO_LOCATION']
 
 DSI:
 
@@ -308,6 +308,7 @@ Logging Control Server:                        # LG_CS
     COMMANDING_PORT:             7001
     METRICS_PORT:                7003          # The HTTP port where Prometheus will connect to for retrieving metrics
     FILE_STORAGE_LOCATION: ENV['PLATO_LOG_FILE_LOCATION']
+    FILENAME:             general.log          # The name used for the log file in the logging manager
     MAX_NR_LOG_FILES:              20          # The maximum number of log files that will be maintained in a roll-over
     MAX_SIZE_LOG_FILES:            20          # The maximum size one log file can become
     CUTELOG_IP_ADDRESS:     127.0.0.1          # The IP address of the cutelog listening server

{cgse_common-2023.1.4 → cgse_common-2024.1.0}/src/egse/system.py

@@ -1064,7 +1064,7 @@ def read_last_line(filename: str | Path, max_line_length=5000):
             return ""
 
 
-def read_last_lines(filename: str, num_lines: int):
+def read_last_lines(filename: str | Path, num_lines: int):
     """Return the last lines of a text file.
 
     Args:

cgse_common-2023.1.4/pyproject.toml

@@ -1,51 +0,0 @@
-[tool.poetry]
-name = "cgse-common"
-version = "2023.1.4"
-description = "Software framework to support testing hardware"
-authors = [
-    "Rik Huygen <rik.huygen@kuleuven.be>",
-    "Sara Regibo <sara.regibo@kuleuven.be>",
-]
-readme = "README.md"
-packages = [
-    { include = "egse", from = "src" }
-]
-
-[tool.poetry.dependencies]
-python = "^3.8"
-click = "^8.1.7"
-deepdiff = "^6.6.1"
-distro = "^1.8.0"
-GitPython = "^3.1.40"
-numpy = "*"
-pandas = "*"
-prometheus-client = "^0.17.1"
-psutil = "^5.9.6"
-PyYAML = "^6.0.1"
-pyzmq = "^25.1.1"
-rich = "^13.6.0"
-
-[tool.poetry.group.test.dependencies]
-pytest = "^7.4.2"
-pytest-mock = "^3.11.1"
-pytest-cov = "^4.1.0"
-
-[tool.poetry.group.dev.dependencies]
-pipdeptree = "^2.13.0"
-ruff = "^0.1.6"
-
-[tool.poetry.plugins."cgse.version"]
-cgse-common = 'egse'
-
-[tool.ruff]
-line-length = 120
-
-[tool.ruff.lint]
-# Add the `line-too-long` rule to the enforced rule set. By default, Ruff omits rules that
-# overlap with the use of a formatter, like Black, but we can override this behavior by
-# explicitly adding the rule.
-extend-select = ["E501"]
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"