cgse-common 2023.1.5__tar.gz → 2024.1.4__tar.gz

cgse_common-2024.1.4/.gitignore

@@ -0,0 +1,35 @@
+# Python versions and environment
+
+__pycache__
+.python-version
+.envrc
+
+# Build systems
+
+build
+dist
+**/*.egg-info
+
+# Apple specific
+
+.DS_Store
+
+# Unit testing
+
+.pytest_cache
+.coverage
+htmlcov
+
+# Virtual environments
+
+.env
+.venv
+venv
+
+# PyCharm IDE
+
+.idea
+
+# Packaging
+
+uv.lock

{cgse_common-2023.1.5 → cgse_common-2024.1.4}/PKG-INFO

@@ -1,31 +1,35 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cgse-common
-Version: 2023.1.5
-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
-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)
+Version: 2024.1.4
+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>
+License-Expression: MIT
+Keywords: CGSE,Common-EGSE,hardware testing,software framework
+Requires-Python: >=3.9
+Requires-Dist: click>=8.1.8
+Requires-Dist: deepdiff>=8.1.1
+Requires-Dist: distro>=1.9.0
+Requires-Dist: gitpython>=3.1.44
+Requires-Dist: numpy==1.22.4
+Requires-Dist: pandas>=1.5.1
+Requires-Dist: pip>=24.3.1
+Requires-Dist: prometheus-client>=0.21.1
+Requires-Dist: psutil>=6.1.1
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pyzmq==23.2.1
+Requires-Dist: rich>=13.9.4
 Description-Content-Type: text/markdown
 
-# Generic Functionality used in the PLATO Common-EGSE
 
-This package 'cgse-common' contains functionality that is used by all `cgse` sub-packages, but it is designed to be a stand-alone generic package that can be used in any other project.
+![PyPI - Version](https://img.shields.io/pypi/v/cgse-common)
+![Supported OS](https://img.shields.io/badge/Supported%20OS-Linux%20%7C%20macOS-blue)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FIvS-KULeuven%2Fcgse%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/cgse-common)
+
+# Generic Functionality used in the Common-EGSE
+
+This package 'cgse-common' contains functionality that is used by all `cgse` sub-packages, but it is designed to be a stand-alone generic package that can be used also in any other project.
 
 
 ## Installation
@@ -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-2023.1.5 → cgse_common-2024.1.4}/README.md

@@ -1,6 +1,12 @@
-# Generic Functionality used in the PLATO Common-EGSE
 
-This package 'cgse-common' contains functionality that is used by all `cgse` sub-packages, but it is designed to be a stand-alone generic package that can be used in any other project.
+![PyPI - Version](https://img.shields.io/pypi/v/cgse-common)
+![Supported OS](https://img.shields.io/badge/Supported%20OS-Linux%20%7C%20macOS-blue)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FIvS-KULeuven%2Fcgse%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/cgse-common)
+
+# Generic Functionality used in the Common-EGSE
+
+This package 'cgse-common' contains functionality that is used by all `cgse` sub-packages, but it is designed to be a stand-alone generic package that can be used also in any other project.
 
 
 ## Installation

cgse_common-2024.1.4/pyproject.toml

@@ -0,0 +1,80 @@
+[project]
+name = "cgse-common"
+version = "2024.1.4"
+description = "Software framework to support hardware testing"
+authors = [
+    {name = "IVS KU Leuven"}
+]
+maintainers = [
+    {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.9"
+license = "MIT"
+keywords = [
+    "CGSE",
+    "Common-EGSE",
+    "hardware testing",
+    "software framework"
+]
+dependencies = [
+    "click>=8.1.8",
+    "deepdiff>=8.1.1",
+    "distro>=1.9.0",
+    "gitpython>=3.1.44",
+    "numpy==1.22.4",
+    "pandas>=1.5.1",
+    "pip>=24.3.1", # only used in setup
+    "prometheus-client>=0.21.1",
+    "psutil>=6.1.1",
+    "pyyaml>=6.0.2",
+    "pyzmq == 23.2.1",
+    "rich>=13.9.4",
+]
+
+[project.entry-points."cgse.version"]
+cgse-common = 'egse'
+
+[tool.pytest.ini_options]
+pythonpath = "src"
+testpaths = ["tests"]
+addopts = "-ra --cov --cov-report html"
+filterwarnings = [
+    "ignore::DeprecationWarning"
+]
+
+[tool.coverage.run]
+omit = [
+    "tests/*",
+]
+
+[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 = ["E", "W"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+    "pytest-cov>=6.0.0",
+    "pytest-mock>=3.14.0",
+    "ruff>=0.9.0",
+]

{cgse_common-2023.1.5 → cgse_common-2024.1.4}/src/egse/bits.py

@@ -1,6 +1,7 @@
 """
 This module contains a number of convenience functions to work with bits, bytes and integers.
 """
+
 import ctypes
 from typing import Union
 
@@ -111,7 +112,7 @@ def bits_set(value: int, *args) -> bool:
     return all([bit_set(value, bit) for bit in args])
 
 
-def beautify_binary(value: int, sep: str = ' ', group: int = 8, prefix: str = '', size: int = 0):
+def beautify_binary(value: int, sep: str = " ", group: int = 8, prefix: str = "", size: int = 0):
     """
     Returns a binary representation of the given value. The bits are presented
     in groups of 8 bits for clarity by default (can be changed with the `group` keyword).
@@ -136,9 +137,9 @@ def beautify_binary(value: int, sep: str = ' ', group: int = 8, prefix: str = ''
         while value > 2**size - 1:
             size += 8
 
-    b_str = f'{value:0{size}b}'
+    b_str = f"{value:0{size}b}"
 
-    return prefix + sep.join([b_str[i:i + group] for i in range(0, len(b_str), group)])
+    return prefix + sep.join([b_str[i : i + group] for i in range(0, len(b_str), group)])
 
 
 def humanize_bytes(n: int, base: Union[int, str] = 2, precision: int = 3) -> str:
@@ -174,11 +175,11 @@ def humanize_bytes(n: int, base: Union[int, str] = 2, precision: int = 3) -> str
     # By default we assume base == 2 or base == "binary"
 
     one_kilo = 1024
-    units = ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB']
+    units = ["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "YiB"]
 
-    if base == 10 or base == 'decimal':
+    if base == 10 or base == "decimal":
         one_kilo = 1000
-        units = ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
+        units = ["kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
 
     _n = n
     if _n < one_kilo:
@@ -193,38 +194,262 @@ def humanize_bytes(n: int, base: Union[int, str] = 2, precision: int = 3) -> str
 
 
 CRC_TABLE = [
-    0x00, 0x91, 0xe3, 0x72, 0x07, 0x96, 0xe4, 0x75,
-    0x0e, 0x9f, 0xed, 0x7c, 0x09, 0x98, 0xea, 0x7b,
-    0x1c, 0x8d, 0xff, 0x6e, 0x1b, 0x8a, 0xf8, 0x69,
-    0x12, 0x83, 0xf1, 0x60, 0x15, 0x84, 0xf6, 0x67,
-    0x38, 0xa9, 0xdb, 0x4a, 0x3f, 0xae, 0xdc, 0x4d,
-    0x36, 0xa7, 0xd5, 0x44, 0x31, 0xa0, 0xd2, 0x43,
-    0x24, 0xb5, 0xc7, 0x56, 0x23, 0xb2, 0xc0, 0x51,
-    0x2a, 0xbb, 0xc9, 0x58, 0x2d, 0xbc, 0xce, 0x5f,
-    0x70, 0xe1, 0x93, 0x02, 0x77, 0xe6, 0x94, 0x05,
-    0x7e, 0xef, 0x9d, 0x0c, 0x79, 0xe8, 0x9a, 0x0b,
-    0x6c, 0xfd, 0x8f, 0x1e, 0x6b, 0xfa, 0x88, 0x19,
-    0x62, 0xf3, 0x81, 0x10, 0x65, 0xf4, 0x86, 0x17,
-    0x48, 0xd9, 0xab, 0x3a, 0x4f, 0xde, 0xac, 0x3d,
-    0x46, 0xd7, 0xa5, 0x34, 0x41, 0xd0, 0xa2, 0x33,
-    0x54, 0xc5, 0xb7, 0x26, 0x53, 0xc2, 0xb0, 0x21,
-    0x5a, 0xcb, 0xb9, 0x28, 0x5d, 0xcc, 0xbe, 0x2f,
-    0xe0, 0x71, 0x03, 0x92, 0xe7, 0x76, 0x04, 0x95,
-    0xee, 0x7f, 0x0d, 0x9c, 0xe9, 0x78, 0x0a, 0x9b,
-    0xfc, 0x6d, 0x1f, 0x8e, 0xfb, 0x6a, 0x18, 0x89,
-    0xf2, 0x63, 0x11, 0x80, 0xf5, 0x64, 0x16, 0x87,
-    0xd8, 0x49, 0x3b, 0xaa, 0xdf, 0x4e, 0x3c, 0xad,
-    0xd6, 0x47, 0x35, 0xa4, 0xd1, 0x40, 0x32, 0xa3,
-    0xc4, 0x55, 0x27, 0xb6, 0xc3, 0x52, 0x20, 0xb1,
-    0xca, 0x5b, 0x29, 0xb8, 0xcd, 0x5c, 0x2e, 0xbf,
-    0x90, 0x01, 0x73, 0xe2, 0x97, 0x06, 0x74, 0xe5,
-    0x9e, 0x0f, 0x7d, 0xec, 0x99, 0x08, 0x7a, 0xeb,
-    0x8c, 0x1d, 0x6f, 0xfe, 0x8b, 0x1a, 0x68, 0xf9,
-    0x82, 0x13, 0x61, 0xf0, 0x85, 0x14, 0x66, 0xf7,
-    0xa8, 0x39, 0x4b, 0xda, 0xaf, 0x3e, 0x4c, 0xdd,
-    0xa6, 0x37, 0x45, 0xd4, 0xa1, 0x30, 0x42, 0xd3,
-    0xb4, 0x25, 0x57, 0xc6, 0xb3, 0x22, 0x50, 0xc1,
-    0xba, 0x2b, 0x59, 0xc8, 0xbd, 0x2c, 0x5e, 0xcf,
+    0x00,
+    0x91,
+    0xE3,
+    0x72,
+    0x07,
+    0x96,
+    0xE4,
+    0x75,
+    0x0E,
+    0x9F,
+    0xED,
+    0x7C,
+    0x09,
+    0x98,
+    0xEA,
+    0x7B,
+    0x1C,
+    0x8D,
+    0xFF,
+    0x6E,
+    0x1B,
+    0x8A,
+    0xF8,
+    0x69,
+    0x12,
+    0x83,
+    0xF1,
+    0x60,
+    0x15,
+    0x84,
+    0xF6,
+    0x67,
+    0x38,
+    0xA9,
+    0xDB,
+    0x4A,
+    0x3F,
+    0xAE,
+    0xDC,
+    0x4D,
+    0x36,
+    0xA7,
+    0xD5,
+    0x44,
+    0x31,
+    0xA0,
+    0xD2,
+    0x43,
+    0x24,
+    0xB5,
+    0xC7,
+    0x56,
+    0x23,
+    0xB2,
+    0xC0,
+    0x51,
+    0x2A,
+    0xBB,
+    0xC9,
+    0x58,
+    0x2D,
+    0xBC,
+    0xCE,
+    0x5F,
+    0x70,
+    0xE1,
+    0x93,
+    0x02,
+    0x77,
+    0xE6,
+    0x94,
+    0x05,
+    0x7E,
+    0xEF,
+    0x9D,
+    0x0C,
+    0x79,
+    0xE8,
+    0x9A,
+    0x0B,
+    0x6C,
+    0xFD,
+    0x8F,
+    0x1E,
+    0x6B,
+    0xFA,
+    0x88,
+    0x19,
+    0x62,
+    0xF3,
+    0x81,
+    0x10,
+    0x65,
+    0xF4,
+    0x86,
+    0x17,
+    0x48,
+    0xD9,
+    0xAB,
+    0x3A,
+    0x4F,
+    0xDE,
+    0xAC,
+    0x3D,
+    0x46,
+    0xD7,
+    0xA5,
+    0x34,
+    0x41,
+    0xD0,
+    0xA2,
+    0x33,
+    0x54,
+    0xC5,
+    0xB7,
+    0x26,
+    0x53,
+    0xC2,
+    0xB0,
+    0x21,
+    0x5A,
+    0xCB,
+    0xB9,
+    0x28,
+    0x5D,
+    0xCC,
+    0xBE,
+    0x2F,
+    0xE0,
+    0x71,
+    0x03,
+    0x92,
+    0xE7,
+    0x76,
+    0x04,
+    0x95,
+    0xEE,
+    0x7F,
+    0x0D,
+    0x9C,
+    0xE9,
+    0x78,
+    0x0A,
+    0x9B,
+    0xFC,
+    0x6D,
+    0x1F,
+    0x8E,
+    0xFB,
+    0x6A,
+    0x18,
+    0x89,
+    0xF2,
+    0x63,
+    0x11,
+    0x80,
+    0xF5,
+    0x64,
+    0x16,
+    0x87,
+    0xD8,
+    0x49,
+    0x3B,
+    0xAA,
+    0xDF,
+    0x4E,
+    0x3C,
+    0xAD,
+    0xD6,
+    0x47,
+    0x35,
+    0xA4,
+    0xD1,
+    0x40,
+    0x32,
+    0xA3,
+    0xC4,
+    0x55,
+    0x27,
+    0xB6,
+    0xC3,
+    0x52,
+    0x20,
+    0xB1,
+    0xCA,
+    0x5B,
+    0x29,
+    0xB8,
+    0xCD,
+    0x5C,
+    0x2E,
+    0xBF,
+    0x90,
+    0x01,
+    0x73,
+    0xE2,
+    0x97,
+    0x06,
+    0x74,
+    0xE5,
+    0x9E,
+    0x0F,
+    0x7D,
+    0xEC,
+    0x99,
+    0x08,
+    0x7A,
+    0xEB,
+    0x8C,
+    0x1D,
+    0x6F,
+    0xFE,
+    0x8B,
+    0x1A,
+    0x68,
+    0xF9,
+    0x82,
+    0x13,
+    0x61,
+    0xF0,
+    0x85,
+    0x14,
+    0x66,
+    0xF7,
+    0xA8,
+    0x39,
+    0x4B,
+    0xDA,
+    0xAF,
+    0x3E,
+    0x4C,
+    0xDD,
+    0xA6,
+    0x37,
+    0x45,
+    0xD4,
+    0xA1,
+    0x30,
+    0x42,
+    0xD3,
+    0xB4,
+    0x25,
+    0x57,
+    0xC6,
+    0xB3,
+    0x22,
+    0x50,
+    0xC1,
+    0xBA,
+    0x2B,
+    0x59,
+    0xC8,
+    0xBD,
+    0x2C,
+    0x5E,
+    0xCF,
 ]
 
 
@@ -251,10 +476,10 @@ def crc_calc(data, start: int, len: int) -> int:
     # and the individual elements have then type 'bytes'.
 
     if isinstance(data[0], bytes):
-        for idx in range(start, start+len):
-            crc = CRC_TABLE[crc ^ (int.from_bytes(data[idx], byteorder='big') & 0xFF)]
+        for idx in range(start, start + len):
+            crc = CRC_TABLE[crc ^ (int.from_bytes(data[idx], byteorder="big") & 0xFF)]
     elif isinstance(data[0], int):
-        for idx in range(start, start+len):
+        for idx in range(start, start + len):
             crc = CRC_TABLE[crc ^ (data[idx] & 0xFF)]
 
     return crc