cgse-common 2024.1.1__py3-none-any.whl

egse/version.py

@@ -0,0 +1,178 @@
+"""
+This module defines the version for the Common-EGSE release. Whenever a version number
+or the release number is needed, this module shall be imported. The version and release
+number is then available as:
+
+    >>> import egse.version
+    >>> print(f"version = {egse.version.VERSION}")
+
+The actual numbers are updated for each release in the `settings.yaml` configuration file.
+
+"""
+from __future__ import annotations
+
+# WARNING: Make sure you are not importing any `egse` packages at the module level.
+# This module is magically loaded by pip to determine the VERSION number before the
+# package has been installed (see pyproject.py).
+# Any imports from an 'egse' package will result in a ModuleNotFound error.
+
+import os
+import subprocess
+from pathlib import Path
+
+from egse.system import get_package_location
+
+HERE = Path(__file__).parent.resolve()
+
+__all__ = [
+    "get_version_installed",
+    "get_version_from_git",
+    "get_version_from_settings",
+    "VERSION",
+]
+
+
+def get_version_from_settings_file_raw(group_name: str, location: Path | str = 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
+    descriptor.
+
+    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.
+
+    Raises:
+        A RuntimeError when the group_name is incorrect and unknown or the VERSION field is not found.
+
+    Returns:
+        The version from the `settings.yaml` file as a string.
+    """
+    basedir = location or os.path.dirname(__file__)
+
+    with open(os.path.join(basedir, "settings.yaml"), mode="r") as yaml_fd:
+        line = yaml_fd.readline()
+        if not line.startswith(group_name):
+            raise RuntimeError(f"Incompatible format for the settings.yaml file, should start with '{group_name}'")
+
+        line = yaml_fd.readline().lstrip()
+        if not line.startswith("VERSION"):
+            raise RuntimeError("Incompatible format for the settings.yaml file, no VERSION found.")
+        _, version = line.split(":")
+
+        # remove possible trailing comment starting with '#'
+        version, *_ = version.split("#")
+        version = version.strip()
+
+    return version
+
+
+def get_version_from_settings(group_name: str, location: Path = None):
+    """
+    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.
+
+    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.
+
+    Raises:
+        A RuntimeError when the group_name is incorrect and unknown or the VERSION field is not found.
+
+    Returns:
+        The version from the `settings.yaml` file as a string.
+    """
+    from egse.settings import Settings, SettingsError
+
+    try:
+        settings = Settings.load(group_name, location=location)
+        version = settings.VERSION
+    except (ModuleNotFoundError, SettingsError):
+        version = get_version_from_settings_file_raw(group_name, location=location)
+
+    return version
+
+
+def get_version_from_git(location: str = None):
+    """
+    Returns the Git version number for the repository at the given location.
+
+    The returned string has the following format: YYYY.X.Y+REPO.TH-N-HASH, where:
+
+    * YYYY is the year
+    * X is the major version number and equal to the week number of the release
+    * Y is the minor version patch number
+    * REPO is the name of the repository, i.e. CGSE or TS
+    * TH is the name of the test house, i.e. CSL1, CSL2, IAS, INTA, SRON
+    * N is the number of commits since the release
+    * HASH is the Git hash number of the commit
+
+    Args:
+        location: The absolute path of the root or a sub-folder of the repo.
+
+    Returns:
+        The Git version number.
+    """
+    from egse.system import chdir
+
+    location = location or Path().cwd()
+
+    with chdir(location):
+        try:
+            std_out = subprocess.check_output(
+                ["git", "describe", "--tags", "--long", "--always"], stderr=subprocess.PIPE
+            )
+            version = std_out.strip().decode("ascii")
+            if "cgse" not in version.lower() and "ts" not in version.lower():
+                version = None
+        except subprocess.CalledProcessError as exc:
+            version = None
+
+    return version
+
+
+def get_version_installed(package_name: str) -> str:
+    """
+    Returns the version that is installed, i.e. read from the metadata in the import lib.
+
+    Args:
+        package_name: the name of the installed package, e.g. cgse or cgse-ts
+
+    Returns:
+        The version of the installed repo.
+    """
+    from egse.system import chdir
+
+    with chdir(Path(__file__).parent):
+        from importlib.metadata import version, PackageNotFoundError
+
+        try:
+            version = version(package_name)
+        except PackageNotFoundError as exc:
+            version = None
+
+    return version
+
+
+VERSION = get_version_from_settings_file_raw("Common-EGSE", location=HERE)
+
+# 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]
+
+
+if __name__ == "__main__":
+    import rich
+    from egse.system import get_module_location
+    from egse.plugin import entry_points
+
+    if VERSION:
+        rich.print(f"CGSE version in Settings: [bold default]{VERSION}[/]")
+
+    if git_version := get_version_from_git(os.getcwd()):
+        rich.print(f"git version (current project) = [bold default]{git_version}[/]")
+
+    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}[/]")

egse/zmq_ser.py

@@ -0,0 +1,69 @@
+import pickle
+import zlib
+from enum import IntEnum
+
+
+def connect_address(transport, address, port):
+    """Returns a properly formatted URL to connect to."""
+    return f"{transport}://{address}:{port}"
+
+
+def bind_address(transport, port):
+    """Returns a properly formatted url to bind a socket to."""
+    return f"{transport}://*:{port}"
+
+
+def set_address_port(url: str, port: int):
+    """Returns a url where the 'port' part is replaced with the given port."""
+    transport, address, old_port = split_address(url)
+
+    return f"{transport}://{address}:{port}"
+
+
+def split_address(url: str):
+
+    transport, address, port = url.split(":")
+    if address.startswith("//"):
+        address = address[2:]
+    return transport, address, port
+
+
+def send_zipped_pickle(socket, obj, flags=0, protocol=-1):
+    """pickle an object, and zip the pickle before sending it"""
+    p = pickle.dumps(obj, protocol)
+    z = zlib.compress(p)
+    return socket.send(z, flags=flags)
+
+
+def recv_zipped_pickle(socket, flags=0, protocol=-1):
+    """inverse of send_zipped_pickle"""
+    z = socket.recv(flags)
+    p = zlib.decompress(z)
+    return pickle.loads(p)
+
+
+class MessageIdentifier(IntEnum):
+    """
+    The first item in a multipart message that can be used to subscribe, filter and identify
+    messages.
+    """
+
+    # ALL shall not be used in the multipart message itself, but exists as an indicator for
+    # subscribing to all messages. The ALL shall be converted into b'' when subscribing.
+
+    ALL = 0x00
+
+    # Synchronisation to DPU Processor at time of reception
+
+    SYNC_TIMECODE = 0x80
+    SYNC_HK_PACKET = 0x81
+    SYNC_DATA_PACKET = 0x82
+    SYNC_ERROR_FLAGS = 0x85
+    SYNC_HK_DATA = 0x86
+
+    N_FEE_REGISTER_MAP = 0x83
+    NUM_CYCLES = 0x84
+
+    # Sending out all kinds of information
+
+    HDF5_FILENAMES = 0x90