shepherd-core 2025.4.1__py3-none-any.whl → 2025.5.2__py3-none-any.whl

shepherd_core/fw_tools/converter.py

@@ -9,7 +9,8 @@ from typing import Union
 import zstandard as zstd
 from pydantic import validate_call
 
-from ..data_models.content.firmware_datatype import FirmwareDType
+from shepherd_core.data_models.content.firmware_datatype import FirmwareDType
+
 from .converter_elf import elf_to_hex
 from .validation import is_elf
 from .validation import is_hex
@@ -27,7 +28,8 @@ def firmware_to_hex(file_path: Path) -> Path:
         return elf_to_hex(file_path)
     if is_hex(file_path):
         return file_path
-    raise FileNotFoundError("FW2Hex: unknown file '%s', it should be ELF or HEX", file_path.name)
+    msg = (f"FW2Hex: unknown file '{file_path.name}', it should be ELF or HEX",)
+    raise FileNotFoundError(msg)
 
 
 @validate_call
@@ -85,10 +87,10 @@ def extract_firmware(data: Union[str, Path], data_type: FirmwareDType, file_path
     - base64-string will be transformed to file
     - if data is a path the file will be copied to the destination.
     """
-    if data_type == FirmwareDType.base64_elf:
+    if data_type == FirmwareDType.base64_elf and isinstance(data, str):
         file = file_path.with_suffix(".elf")
         base64_to_file(data, file)
-    elif data_type == FirmwareDType.base64_hex:
+    elif data_type == FirmwareDType.base64_hex and isinstance(data, str):
         file = file_path.with_suffix(".hex")
         base64_to_file(data, file)
     elif isinstance(data, (Path, str)):
@@ -97,10 +99,12 @@ def extract_firmware(data: Union[str, Path], data_type: FirmwareDType, file_path
         elif data_type == FirmwareDType.path_hex:
             file = file_path.with_suffix(".hex")
         else:
-            raise ValueError("FW-Extraction failed due to unknown datatype '%s'", data_type)
+            msg = "FW-Extraction failed due to unknown datatype '{data_type}'"
+            raise ValueError(msg)
         if not file.parent.exists():
             file.parent.mkdir(parents=True)
         shutil.copy(data, file)
     else:
-        raise ValueError("FW-Extraction failed due to unknown data-type '%s'", type(data))
+        msg = f"FW-Extraction failed due to unknown data-type '{type(data)}'"
+        raise ValueError(msg)
     return file

shepherd_core/fw_tools/patcher.py

@@ -1,15 +1,16 @@
 """Read and modify symbols in ELF-files."""
 
 from pathlib import Path
+from typing import Annotated
 from typing import Optional
 
 from pydantic import Field
 from pydantic import validate_call
-from typing_extensions import Annotated
 
-from ..commons import uid_len_default
-from ..commons import uid_str_default
-from ..logger import logger
+from shepherd_core.commons import UID_NAME
+from shepherd_core.commons import UID_SIZE
+from shepherd_core.logger import logger
+
 from .validation import is_elf
 
 try:
@@ -49,7 +50,7 @@ def find_symbol(file_elf: Path, symbol: str) -> bool:
 
 
 @validate_call
-def read_symbol(file_elf: Path, symbol: str, length: int = uid_len_default) -> Optional[int]:
+def read_symbol(file_elf: Path, symbol: str, length: int = UID_SIZE) -> Optional[int]:
     """Read value of symbol in ELF-File.
 
     Will be interpreted as int.
@@ -67,7 +68,7 @@ def read_symbol(file_elf: Path, symbol: str, length: int = uid_len_default) -> O
 
 def read_uid(file_elf: Path) -> Optional[int]:
     """Read value of UID-symbol for shepherd testbed."""
-    return read_symbol(file_elf, symbol=uid_str_default, length=uid_len_default)
+    return read_symbol(file_elf, symbol=UID_NAME, length=UID_SIZE)
 
 
 def read_arch(file_elf: Path) -> Optional[str]:
@@ -87,7 +88,7 @@ def read_arch(file_elf: Path) -> Optional[str]:
 def modify_symbol_value(
     file_elf: Path,
     symbol: str,
-    value: Annotated[int, Field(ge=0, lt=2 ** (8 * uid_len_default))],
+    value: Annotated[int, Field(ge=0, lt=2 ** (8 * UID_SIZE))],
     *,
     overwrite: bool = False,
 ) -> Optional[Path]:
@@ -105,20 +106,18 @@ def modify_symbol_value(
         raise RuntimeError(elf_error_text)
     elf = ELF(path=file_elf)
     addr = elf.symbols[symbol]
-    value_raw = elf.read(address=addr, count=uid_len_default)[-uid_len_default:]
+    value_raw = elf.read(address=addr, count=UID_SIZE)[-UID_SIZE:]
     # ⤷ cutting needed -> msp produces 4b instead of 2
     value_old = int.from_bytes(bytes=value_raw, byteorder=elf.endian, signed=False)
-    value_raw = value.to_bytes(length=uid_len_default, byteorder=elf.endian, signed=False)
+    value_raw = value.to_bytes(length=UID_SIZE, byteorder=elf.endian, signed=False)
+
     try:
         elf.write(address=addr, data=value_raw)
     except AttributeError:
         logger.warning("ELF-Modifier failed @%s for symbol '%s'", f"0x{addr:X}", symbol)
         return None
-    if overwrite:
-        file_new = file_elf
-    else:
-        file_new = file_elf.with_name(file_elf.stem + "_" + str(value) + file_elf.suffix)
-        # could be simplified, but py3.8-- doesn't know .with_stem()
+
+    file_new = file_elf if overwrite else file_elf.with_stem(file_elf.stem + "_" + str(value))
     elf.save(path=file_new)
     elf.close()
     logger.debug(
@@ -133,4 +132,4 @@ def modify_symbol_value(
 
 def modify_uid(file_elf: Path, value: int) -> Optional[Path]:
     """Replace value of UID-symbol for shepherd testbed."""
-    return modify_symbol_value(file_elf, symbol=uid_str_default, value=value, overwrite=True)
+    return modify_symbol_value(file_elf, symbol=UID_NAME, value=value, overwrite=True)

shepherd_core/fw_tools/validation.py

@@ -12,8 +12,9 @@ from intelhex import IntelHex
 from intelhex import IntelHexError
 from pydantic import validate_call
 
-from ..data_models.content.firmware_datatype import FirmwareDType
-from ..logger import logger
+from shepherd_core.data_models.content.firmware_datatype import FirmwareDType
+from shepherd_core.logger import logger
+
 from .converter_elf import elf_to_hex
 
 try:
@@ -136,7 +137,8 @@ def determine_type(file: Path) -> FirmwareDType:
         return FirmwareDType.path_hex
     if is_elf(file):
         return FirmwareDType.path_elf
-    raise ValueError("Type of file '%s' could not be determined", file.name)
+    msg = f"Type of file '{file.name}' could not be determined"
+    raise ValueError(msg)
 
 
 def determine_arch(file: Path) -> str:
@@ -147,11 +149,14 @@ def determine_arch(file: Path) -> str:
             return "msp430"
         if is_elf_nrf52(file):
             return "nrf52"
-        raise ValueError("Arch of ELF '%s' could not be determined", file.name)
+        msg = f"Arch of ELF '{file.name}' could not be determined"
+        raise ValueError(msg)
     if file_t == FirmwareDType.path_hex:
         if is_hex_msp430(file):
             return "msp430"
         if is_hex_nrf52(file):
             return "nrf52"
-        raise ValueError("Arch of HEX '%s' could not be determined", file.name)
-    raise ValueError("Arch of file '%s' could not be determined", file.name)
+        msg = f"Arch of HEX '{file.name}' could not be determined"
+        raise ValueError(msg)
+    msg = f"Arch of file '{file.name}' could not be determined"
+    raise ValueError(msg)

shepherd_core/inventory/__init__.py

@@ -9,13 +9,13 @@ This will collect:
 from datetime import datetime
 from datetime import timedelta
 from pathlib import Path
-from typing import List
+from typing import Annotated
 
 from pydantic import Field
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ..data_models import ShpModel
+from shepherd_core.data_models import ShpModel
+
 from .python import PythonInventory
 from .system import SystemInventory
 from .target import TargetInventory
@@ -55,7 +55,7 @@ class Inventory(PythonInventory, SystemInventory, TargetInventory):
 class InventoryList(ShpModel):
     """Collection of inventories for several devices."""
 
-    elements: Annotated[List[Inventory], Field(min_length=1)]
+    elements: Annotated[list[Inventory], Field(min_length=1)]
 
     def to_csv(self, path: Path) -> None:
         """Generate a CSV.
@@ -82,8 +82,8 @@ class InventoryList(ShpModel):
             if (_e.created.timestamp() - ts_earl) > 10:
                 warnings["time_delta"] = f"[{self.hostname}] time-sync has failed"
 
-        # turn  Dict[hostname][type] = val
-        # to    Dict[type][val] = List[hostnames]
+        # turn  dict[hostname][type] = val
+        # to    dict[type][val] = list[hostnames]
         _inp = {
             _e.hostname: _e.model_dump(exclude_unset=True, exclude_defaults=True)
             for _e in self.elements

shepherd_core/inventory/python.py

@@ -8,7 +8,7 @@ from typing import Optional
 from pydantic import ConfigDict
 from typing_extensions import Self
 
-from ..data_models import ShpModel
+from shepherd_core.data_models import ShpModel
 
 
 class PythonInventory(ShpModel):

shepherd_core/inventory/system.py

@@ -3,15 +3,18 @@
 import platform
 import subprocess
 import time
+from collections.abc import Mapping
+from collections.abc import Sequence
 from datetime import datetime
 from pathlib import Path
-from typing import List
+from types import MappingProxyType
+from typing import Any
 from typing import Optional
 
 from typing_extensions import Self
 
-from ..data_models.base.timezone import local_now
-from ..logger import logger
+from shepherd_core.data_models.base.timezone import local_now
+from shepherd_core.logger import logger
 
 try:
     import psutil
@@ -21,7 +24,7 @@ except ImportError:
 from pydantic import ConfigDict
 from pydantic.types import PositiveInt
 
-from ..data_models import ShpModel
+from shepherd_core.data_models import ShpModel
 
 
 class SystemInventory(ShpModel):
@@ -30,7 +33,7 @@ class SystemInventory(ShpModel):
     uptime: PositiveInt
     # ⤷ seconds
     timestamp: datetime
-    # time_delta: timedelta = timedelta(0)  # noqa: ERA001
+    # time_delta: timedelta = timedelta(seconds=0)  # noqa: ERA001
     # ⤷ lag behind earliest observer, TODO: wrong place
 
     system: str
@@ -44,13 +47,13 @@ class SystemInventory(ShpModel):
 
     hostname: str
 
-    interfaces: dict = {}  # noqa: RUF012
+    interfaces: Mapping[str, Any] = MappingProxyType({})
     # ⤷ tuple with
     #   ip IPvAnyAddress
     #   mac MACStr
 
-    fs_root: List[str] = None
-    beagle: List[str] = None
+    fs_root: Sequence[str] = ()
+    beagle: Sequence[str] = ()
 
     model_config = ConfigDict(str_min_length=0)
 

shepherd_core/inventory/target.py

@@ -1,19 +1,19 @@
 """Hardware related inventory model."""
 
-from typing import List
+from collections.abc import Sequence
 from typing import Optional
 
 from pydantic import ConfigDict
 from typing_extensions import Self
 
-from ..data_models import ShpModel
+from shepherd_core.data_models import ShpModel
 
 
 class TargetInventory(ShpModel):
     """Hardware related inventory model."""
 
     cape: Optional[str] = None
-    targets: List[str] = []  # noqa: RUF012
+    targets: Sequence[str] = ()
 
     model_config = ConfigDict(str_min_length=0)
 

shepherd_core/logger.py

@@ -33,8 +33,8 @@ def set_log_verbose_level(log_: Union[logging.Logger, logging.Handler], verbose:
     if verbose < 3:
         # reduce log-overhead when not debugging, also more user-friendly exceptions
         logging._srcfile = None  # noqa: SLF001
-        logging.logThreads = 0
-        logging.logProcesses = 0
+        logging.logThreads = False
+        logging.logProcesses = False
 
     if verbose > 2:
         chromalog.basicConfig(format="%(name)s %(levelname)s: %(message)s")