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

shepherd_core/data_models/task/firmware_mod.py

@@ -34,7 +34,7 @@ class FirmwareModTask(ShpModel):
     firmware_file: Path
 
     verbose: Annotated[int, Field(ge=0, le=4)] = 2
-    # ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug
+    """ ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug"""
 
     @model_validator(mode="after")
     def post_validation(self) -> Self:

shepherd_core/data_models/task/harvest.py

@@ -9,6 +9,7 @@ from typing import Optional
 from pydantic import Field
 from pydantic import model_validator
 from typing_extensions import Self
+from typing_extensions import deprecated
 
 from shepherd_core.data_models.base.shepherd import ShpModel
 from shepherd_core.data_models.base.timezone import local_tz
@@ -24,34 +25,35 @@ class HarvestTask(ShpModel):
 
     # General config
     output_path: Path
-    # ⤷ dir- or file-path for storing the recorded data:
-    #   - providing a directory -> file is named hrv_timestamp.h5
-    #   - for a complete path the filename is not changed except it exists and
-    #     overwrite is disabled -> name#num.h5
+    """ ⤷ dir- or file-path for storing the recorded data:
+
+    - providing a directory -> file is named hrv_timestamp.h5
+    - for a complete path the filename is not changed except it exists and
+      overwrite is disabled -> name#num.h5
+    """
     force_overwrite: bool = False
-    # ⤷ Overwrite existing file
+    """ ⤷ Overwrite existing file"""
     output_compression: Optional[Compression] = Compression.default
-    # ⤷ should be 1 (level 1 gzip), lzf, or None (order of recommendation)
+    """ ⤷ should be 1 (level 1 gzip), lzf, or None (order of recommendation)"""
 
     time_start: Optional[datetime] = None
-    # timestamp or unix epoch time, None = ASAP
+    """ timestamp or unix epoch time, None = ASAP"""
     duration: Optional[timedelta] = None
-    # ⤷ Duration of recording in seconds, None = till EOF
-    abort_on_error: bool = False
+    """ ⤷ Duration of recording in seconds, None = till EOFSys"""
+    abort_on_error: Annotated[bool, deprecated("has no effect")] = False
 
     # emulation-specific
     use_cal_default: bool = False
-    # ⤷ Use default calibration values, skip loading from EEPROM
+    """ ⤷ Use default calibration values, skip loading from EEPROM"""
 
     virtual_harvester: VirtualHarvesterConfig = VirtualHarvesterConfig(name="mppt_opt")
-    # ⤷ Choose one of the predefined virtual harvesters
-    #   or configure a new one
-
+    """ ⤷ Choose one of the predefined virtual harvesters or configure a new one
+    """
     power_tracing: PowerTracing = PowerTracing()
     sys_logging: Optional[SystemLogging] = SystemLogging()
 
     verbose: Annotated[int, Field(ge=0, le=4)] = 2
-    # ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug
+    """ ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug"""
 
     # TODO: there is an unused DAC-Output patched to the harvesting-port
 

shepherd_core/data_models/task/observer_tasks.py

@@ -3,10 +3,12 @@
 from datetime import datetime
 from datetime import timedelta
 from pathlib import Path
+from typing import Annotated
 from typing import Optional
 
 from pydantic import validate_call
 from typing_extensions import Self
+from typing_extensions import deprecated
 
 from shepherd_core.data_models.base.content import IdInt
 from shepherd_core.data_models.base.content import NameStr
@@ -23,12 +25,10 @@ class ObserverTasks(ShpModel):
     """Collection of tasks for selected observer included in experiment."""
 
     observer: NameStr
-    owner_id: Optional[IdInt]  # TODO: set to optional for now, shouldn't be
 
     # PRE PROCESS
     time_prep: datetime  # TODO: should be optional
     root_path: Path
-    abort_on_error: bool
 
     # fw mod, store as hex-file and program
     fw1_mod: Optional[FirmwareModTask] = None
@@ -39,6 +39,10 @@ class ObserverTasks(ShpModel):
     # MAIN PROCESS
     emulation: Optional[EmulationTask] = None
 
+    # deprecations, TODO: remove before public release
+    owner_id: Annotated[Optional[IdInt], deprecated("not needed anymore")] = None
+    abort_on_error: Annotated[bool, deprecated("has no effect")] = False
+
     # post_copy / cleanup, Todo: could also just intake emuTask
     #  - delete firmwares
     #  - decode uart
@@ -67,10 +71,8 @@ class ObserverTasks(ShpModel):
 
         return cls(
             observer=obs.name,
-            owner_id=xp.owner_id,
             time_prep=t_start - tb.prep_duration,
             root_path=root_path,
-            abort_on_error=xp.abort_on_error,
             fw1_mod=FirmwareModTask.from_xp(xp, tb, tgt_id, 1, fw_paths[0]),
             fw2_mod=FirmwareModTask.from_xp(xp, tb, tgt_id, 2, fw_paths[1]),
             fw1_prog=ProgrammingTask.from_xp(xp, tb, tgt_id, 1, fw_paths[0]),
@@ -91,8 +93,8 @@ class ObserverTasks(ShpModel):
             tasks.append(task)
         return tasks
 
-    def get_output_paths(self) -> dict:
-        values = {}
+    def get_output_paths(self) -> dict[str, Path]:
+        values: dict[str, Path] = {}
         if isinstance(self.emulation, EmulationTask):
             if self.emulation.output_path is None:
                 raise ValueError("Emu-Task should have a valid output-path")

shepherd_core/data_models/task/programming.py

@@ -29,15 +29,16 @@ class ProgrammingTask(ShpModel):
     target_port: TargetPort = TargetPort.A
     mcu_port: MCUPort = 1
     mcu_type: SafeStr
-    # ⤷ must be either "nrf52" or "msp430" ATM, TODO: clean xp to tasks
+    """ ⤷ must be either "nrf52" or "msp430" ATM, TODO: clean xp to tasks"""
     voltage: Annotated[float, Field(ge=1, lt=5)] = 3
     datarate: Annotated[int, Field(gt=0, le=1_000_000)] = 200_000
     protocol: ProgrammerProtocol
+    # TODO: eradicate - should not exist. derive protocol from mcu_type
 
     simulate: bool = False
 
     verbose: Annotated[int, Field(ge=0, le=4)] = 2
-    # ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug
+    """ ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug"""
 
     @model_validator(mode="after")
     def post_validation(self) -> Self:

shepherd_core/data_models/task/testbed_tasks.py

@@ -1,11 +1,13 @@
 """Collection of tasks for all observers included in experiment."""
 
+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 Self
+from typing_extensions import deprecated
 
 from shepherd_core.data_models.base.content import IdInt
 from shepherd_core.data_models.base.content import NameStr
@@ -22,11 +24,9 @@ class TestbedTasks(ShpModel):
     name: NameStr
     observer_tasks: Annotated[list[ObserverTasks], Field(min_length=1, max_length=128)]
 
-    # POST PROCESS
-    email_results: bool = False
-    owner_id: Optional[IdInt]
-    # TODO: had real email previously, does it really need these at all?
-    #  DB stores experiment and knows when to email
+    # deprecated, TODO: remove before public release
+    email_results: Annotated[Optional[bool], deprecated("not needed anymore")] = False
+    owner_id: Annotated[Optional[IdInt], deprecated("not needed anymore")] = None
 
     @classmethod
     @validate_call
@@ -40,8 +40,6 @@ class TestbedTasks(ShpModel):
         return cls(
             name=xp.name,
             observer_tasks=obs_tasks,
-            email_results=xp.email_results,
-            owner_id=xp.owner_id,
         )
 
     def get_observer_tasks(self, observer: str) -> Optional[ObserverTasks]:
@@ -50,11 +48,11 @@ class TestbedTasks(ShpModel):
                 return tasks
         return None
 
-    def get_output_paths(self) -> dict:
+    def get_output_paths(self) -> dict[str, Path]:
         # TODO: computed field preferred, but they don't work here, as
         #  - they are always stored in yaml despite "repr=False"
         #  - solution will shift to some kind of "result"-datatype that is combinable
-        values = {}
+        values: dict[str, Path] = {}
         for obt in self.observer_tasks:
             values = {**values, **obt.get_output_paths()}
         return values

shepherd_core/data_models/testbed/cape_fixture.yaml

@@ -1,7 +1,7 @@
 ---
 
 # more human-readable test-protocol @
-# https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/Cape_pre-deployment-tests.xlsx
+# https://github.com/orgua/shepherd-v2-planning/blob/main/doc_testbed/Cape_pre-deployment-tests.xlsx
 - datatype: cape
   parameters:
     id: 1270051
@@ -92,3 +92,11 @@
     id: 1270065
     name: cape65
     comment: only 220u/440uF on 5V
+- datatype: cape
+  parameters:
+    id: 42000
+    name: unit_testing_cape
+    version: none
+    description: for unit testing
+    created: 2025-04-29
+    calibrated: 2025-04-29

shepherd_core/data_models/testbed/gpio.py

@@ -65,3 +65,10 @@ class GPIO(ShpModel, title="GPIO of Observer Node"):
 
     def user_controllable(self) -> bool:
         return ("gpio" in self.name.lower()) and (self.direction in {"IO", "OUT"})
+
+    def user_recordable(self) -> bool:
+        return (
+            ("gpio" in self.name.lower())
+            and (self.direction in {"IO", "IN"})
+            and (self.pin_pru is not None)
+        )

shepherd_core/data_models/testbed/observer.py

@@ -43,7 +43,7 @@ class Observer(ShpModel, title="Shepherd-Sheep"):
 
     latitude: Annotated[float, Field(ge=-90, le=90)] = 51.026573
     longitude: Annotated[float, Field(ge=-180, le=180)] = 13.723291
-    # ⤷ cfaed-floor
+    """ ⤷ cfaed-floor"""
 
     active: bool = True
     cape: Optional[Cape] = None

shepherd_core/data_models/testbed/observer_fixture.yaml

@@ -1,6 +1,6 @@
 ---
-# observer-cape-target-relation: https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/Cape_pre-deployment-tests.xlsx
-# network data: https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/ethernet_MAC_addresses_bbones.ods
+# observer-cape-target-relation: https://github.com/orgua/shepherd-v2-planning/blob/main/doc_testbed/Cape_pre-deployment-tests.xlsx
+# network data: https://github.com/orgua/shepherd-v2-planning/blob/main/doc_testbed/ethernet_MAC_addresses_bbones.ods
 - datatype: observer
   parameters:
     id: 0
@@ -221,3 +221,20 @@
     target_a:
       name: nRF52_FRAM_1392_390
     created: 2023-09-22 12:12:12
+- datatype: observer
+  parameters:
+    id: 42
+    name: unit_testing_sheep
+    ip: 0.0.0.0
+    mac: 00:00:00:00:00:00
+    room: none
+    eth_port: none
+    description: unit testing
+    longitude: 0
+    latitude: 0
+    cape:
+      name: unit_testing_cape
+    target_a:
+      name: unit_testing_target
+    created: 2025-04-29 13:07:00
+    active: true

shepherd_core/data_models/testbed/target.py

@@ -36,7 +36,7 @@ class Target(ShpModel, title="Target Node (DuT)"):
     created: datetime = Field(default_factory=datetime.now)
 
     testbed_id: Optional[IdInt16] = None
-    # ⤷ is derived from ID (targets are still selected by id!)
+    """ ⤷ is derived from ID (targets are still selected by id!)"""
     mcu1: Union[MCU, NameStr]
     mcu2: Union[MCU, NameStr, None] = None
 

shepherd_core/data_models/testbed/target_fixture.old1

@@ -1,6 +1,6 @@
 ---
 # more human-readable test-protocol @
-# https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/Target_pre-deployment-tests.xlsx
+# https://github.com/orgua/shepherd-v2-planning/blob/main/doc_testbed/Target_pre-deployment-tests.xlsx
 - datatype: target
   parameters:
     id: 6  # Outer ID - selected by user for XP - can be rearranged

shepherd_core/data_models/testbed/target_fixture.yaml

@@ -1,6 +1,6 @@
 ---
 # more human-readable test-protocol @
-# https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/Target_pre-deployment-tests.xlsx
+# https://github.com/orgua/shepherd-v2-planning/blob/main/doc_testbed/Target_pre-deployment-tests.xlsx
 - datatype: target
   parameters:
     id: 2  # Outer ID - selected by user for XP - can be rearranged
@@ -161,3 +161,16 @@
       name: nRF52
     mcu2: null
     created: 2022-12-12 12:12:12
+
+- datatype: target
+  parameters:
+    id: 42
+    name: unit_testing_target
+    version: v0
+    description: for unit testing
+    comment: no comment
+    created: 2025-04-29
+    mcu1:
+      name: nRF52
+    mcu2:
+      name: MSP430FR

shepherd_core/data_models/testbed/testbed.py

@@ -11,15 +11,17 @@ from pydantic import HttpUrl
 from pydantic import model_validator
 from typing_extensions import Self
 
+from shepherd_core.config import config
 from shepherd_core.data_models.base.content import IdInt
 from shepherd_core.data_models.base.content import NameStr
 from shepherd_core.data_models.base.content import SafeStr
 from shepherd_core.data_models.base.shepherd import ShpModel
-from shepherd_core.logger import logger
 from shepherd_core.testbed_client import tb_client
 
 from .observer import Observer
 
+duration_5min = timedelta(minutes=5)
+
 
 class Testbed(ShpModel):
     """meta-data representation of a testbed-component (physical object)."""
@@ -36,21 +38,18 @@ class Testbed(ShpModel):
     shared_storage: bool = True
     data_on_server: Path
     data_on_observer: Path
-    # ⤷ storage layout: root_path/content_type/group/owner/[object]
+    """ ⤷ storage layout: root_path/content_type/group/owner/[object]"""
+    # TODO: we might need individual paths for experiments & content
 
-    prep_duration: timedelta = timedelta(minutes=5)
+    prep_duration: timedelta = duration_5min
     # TODO: one BBone is currently time-keeper
 
     @model_validator(mode="before")
     @classmethod
     def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
-        # allow instantiating an empty Testbed
-        #   -> query the first (and only) entry of client
+        # allow instantiating an empty Testbed, take default in config
         if len(values) == 0:
-            ids = tb_client.query_ids(cls.__name__)
-            if len(ids) > 1:
-                logger.warning("More than one testbed defined?!?")
-            values = {"id": ids[0]}
+            values = {"name": config.TESTBED}
 
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         return values

shepherd_core/data_models/testbed/testbed_fixture.yaml

@@ -23,3 +23,14 @@
       - name: sheep12
       - name: sheep13
       - name: sheep14
+
+- datatype: testbed
+  parameters:
+    id: 42
+    name: unit_testing_testbed
+    description: "Artificial Testbed used in unit testing"
+    shared_storage: true
+    data_on_server: /tmp/
+    data_on_observer: /tmp/
+    observers:
+      - name: unit_testing_sheep

shepherd_core/fw_tools/patcher.py

@@ -7,8 +7,7 @@ from typing import Optional
 from pydantic import Field
 from pydantic import validate_call
 
-from shepherd_core.commons import UID_NAME
-from shepherd_core.commons import UID_SIZE
+from shepherd_core.config import config
 from shepherd_core.logger import logger
 
 from .validation import is_elf
@@ -50,7 +49,7 @@ def find_symbol(file_elf: Path, symbol: str) -> bool:
 
 
 @validate_call
-def read_symbol(file_elf: Path, symbol: str, length: int = UID_SIZE) -> Optional[int]:
+def read_symbol(file_elf: Path, symbol: str, length: int) -> Optional[int]:
     """Read value of symbol in ELF-File.
 
     Will be interpreted as int.
@@ -68,7 +67,7 @@ def read_symbol(file_elf: Path, symbol: str, length: int = UID_SIZE) -> Optional
 
 def read_uid(file_elf: Path) -> Optional[int]:
     """Read value of UID-symbol for shepherd testbed."""
-    return read_symbol(file_elf, symbol=UID_NAME, length=UID_SIZE)
+    return read_symbol(file_elf, symbol=config.UID_NAME, length=config.UID_SIZE)
 
 
 def read_arch(file_elf: Path) -> Optional[str]:
@@ -88,7 +87,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_SIZE))],
+    value: Annotated[int, Field(ge=0, lt=2 ** (8 * config.UID_SIZE))],
     *,
     overwrite: bool = False,
 ) -> Optional[Path]:
@@ -106,10 +105,10 @@ 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_SIZE)[-UID_SIZE:]
+    value_raw = elf.read(address=addr, count=config.UID_SIZE)[-config.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_SIZE, byteorder=elf.endian, signed=False)
+    value_raw = value.to_bytes(length=config.UID_SIZE, byteorder=elf.endian, signed=False)
 
     try:
         elf.write(address=addr, data=value_raw)
@@ -132,4 +131,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_NAME, value=value, overwrite=True)
+    return modify_symbol_value(file_elf, symbol=config.UID_NAME, value=value, overwrite=True)

shepherd_core/inventory/system.py

@@ -31,10 +31,8 @@ class SystemInventory(ShpModel):
     """System / OS related inventory model."""
 
     uptime: PositiveInt
-    # ⤷ seconds
+    """ ⤷ seconds"""
     timestamp: datetime
-    # time_delta: timedelta = timedelta(seconds=0)  # noqa: ERA001
-    # ⤷ lag behind earliest observer, TODO: wrong place
 
     system: str
     release: str

shepherd_core/reader.py

@@ -7,6 +7,7 @@ import errno
 import logging
 import math
 import os
+from datetime import datetime
 from itertools import product
 from pathlib import Path
 from types import MappingProxyType
@@ -24,9 +25,10 @@ from tqdm import trange
 from typing_extensions import Self
 from typing_extensions import deprecated
 
-from .commons import SAMPLERATE_SPS_DEFAULT
+from .config import config
 from .data_models.base.calibration import CalibrationPair
 from .data_models.base.calibration import CalibrationSeries
+from .data_models.base.timezone import local_tz
 from .data_models.content.energy_environment import EnergyDType
 from .decoder_waveform import Uart
 
@@ -75,7 +77,7 @@ class Reader:
             self._logger.setLevel(logging.DEBUG if verbose else logging.INFO)
 
         if not hasattr(self, "samplerate_sps"):
-            self.samplerate_sps: int = SAMPLERATE_SPS_DEFAULT
+            self.samplerate_sps: int = config.SAMPLERATE_SPS
         self.sample_interval_ns: int = round(10**9 // self.samplerate_sps)
         self.sample_interval_s: float = 1 / self.samplerate_sps
 
@@ -263,6 +265,11 @@ class Reader:
             omit_timestamps=omit_ts,
         )
 
+    def get_time_start(self) -> Optional[datetime]:
+        if self.samples_n < 1:
+            return None
+        return datetime.fromtimestamp(self._cal.time.raw_to_si(self.ds_time[0]), tz=local_tz())
+
     def get_calibration_data(self) -> CalibrationSeries:
         """Read calibration-data from hdf5 file.
 
@@ -412,19 +419,20 @@ class Reader:
                 self.file_path.name,
             )
         # same length of datasets:
-        for dset in ["current", "time"]:
+        samples_n = self.h5file["data"]["time"].shape[0]
+        for dset in ["voltage", "current"]:
             ds_size = self.h5file["data"][dset].shape[0]
-            if ds_size != self.samples_n:
+            if ds_size != samples_n:
                 self._logger.warning(
                     "[FileValidation] dataset '%s' has different size (=%d), "
-                    "compared to smallest set (=%d), in '%s'",
+                    "compared to time (=%d), in '%s'",
                     dset,
                     ds_size,
-                    self.samples_n,
+                    samples_n,
                     self.file_path.name,
                 )
         # dataset-length should be multiple of chunk-size
-        remaining_size = self.samples_n % self.CHUNK_SAMPLES_N
+        remaining_size = samples_n % self.CHUNK_SAMPLES_N
         if remaining_size != 0:
             self._logger.warning(
                 "[FileValidation] datasets are not aligned with chunk-size in '%s'",

shepherd_core/testbed_client/cache_path.py

@@ -14,4 +14,4 @@ def _get_xdg_path(variable_name: str, default_path: Path) -> Path:
 user_path = Path("~").expanduser()
 
 cache_xdg_path = _get_xdg_path("XDG_CACHE_HOME", user_path / ".cache")
-cache_user_path = cache_xdg_path / "shepherd_datalib"
+cache_user_path = cache_xdg_path / "shepherd"

shepherd_core/testbed_client/client_web.py

@@ -8,7 +8,7 @@ from typing import Union
 
 from pydantic import validate_call
 
-from shepherd_core.commons import TESTBED_SERVER_URI
+from shepherd_core.config import config
 from shepherd_core.data_models.base.shepherd import ShpModel
 from shepherd_core.data_models.base.wrapper import Wrapper
 
@@ -38,7 +38,7 @@ class WebClient(AbcClient):
         if not hasattr(self, "_token"):
             # add default values
             self._token: str = "basic_public_access"  # noqa: S105
-            self._server: str = TESTBED_SERVER_URI
+            self._server: str = config.TESTBED_SERVER
             self._user: Optional[User] = None
             self._key: Optional[str] = None
             self._connected: bool = False

shepherd_core/testbed_client/fixtures.py

@@ -2,6 +2,7 @@
 
 import copy
 import pickle
+from collections.abc import Iterable
 from collections.abc import Mapping
 from datetime import datetime
 from datetime import timedelta
@@ -34,11 +35,11 @@ class Fixture:
 
     def __init__(self, model_type: str) -> None:
         self.model_type: str = model_type.lower()
-        self.elements_by_name: dict[str, dict] = {}
-        self.elements_by_id: dict[int, dict] = {}
+        self.elements_by_name: dict[str, dict[str, Any]] = {}
+        self.elements_by_id: dict[int, dict[str, Any]] = {}
         # Iterator reset
         self._iter_index: int = 0
-        self._iter_list: list = list(self.elements_by_name.values())
+        self._iter_list: list[dict[str, Any]] = list(self.elements_by_name.values())
 
     def insert(self, data: Wrapper) -> None:
         # ⤷ TODO: could get easier
@@ -54,9 +55,10 @@ class Fixture:
         self.elements_by_name[name] = data_model
         self.elements_by_id[_id] = data_model
         # update iterator
-        self._iter_list = list(self.elements_by_name.values())
+        self._iter_list: list[dict[str, Any]] = list(self.elements_by_name.values())
 
-    def __getitem__(self, key: Union[str, int]) -> dict:
+    def __getitem__(self, key: Union[str, int]) -> dict[str, Any]:
+        original_key = key
         if isinstance(key, str):
             key = key.lower()
             if key in self.elements_by_name:
@@ -65,7 +67,7 @@ class Fixture:
                 key = int(key)
         if key in self.elements_by_id:
             return self.elements_by_id[int(key)]
-        msg = f"{self.model_type} '{key}' not found!"
+        msg = f"{self.model_type} '{original_key}' not found!"
         raise ValueError(msg)
 
     def __iter__(self) -> Self:
@@ -73,14 +75,14 @@ class Fixture:
         self._iter_list = list(self.elements_by_name.values())
         return self
 
-    def __next__(self) -> Any:
+    def __next__(self) -> dict[str, Any]:
         if self._iter_index < len(self._iter_list):
             member = self._iter_list[self._iter_index]
             self._iter_index += 1
             return member
         raise StopIteration
 
-    def keys(self):  # noqa: ANN201
+    def keys(self) -> Iterable[str]:
         return self.elements_by_name.keys()
 
     def refs(self) -> dict:
@@ -149,13 +151,13 @@ class Fixture:
             base[key] = value
         return base
 
-    def query_id(self, _id: int) -> dict:
+    def query_id(self, _id: int) -> dict[str, Any]:
         if isinstance(_id, int) and _id in self.elements_by_id:
             return self.elements_by_id[_id]
         msg = f"Initialization of {self.model_type} by ID failed - {_id} is unknown!"
         raise ValueError(msg)
 
-    def query_name(self, name: str) -> dict:
+    def query_name(self, name: str) -> dict[str, Any]:
         if isinstance(name, str) and name.lower() in self.elements_by_name:
             return self.elements_by_name[name.lower()]
         msg = f"Initialization of {self.model_type} by name failed - {name} is unknown!"
@@ -239,7 +241,7 @@ class Fixtures:
         msg = f"Component '{key}' not found!"
         raise ValueError(msg)
 
-    def keys(self):  # noqa: ANN201
+    def keys(self) -> Iterable[str]:
         return self.components.keys()
 
     @staticmethod

shepherd_core/testbed_client/user_model.py

@@ -5,10 +5,7 @@ from hashlib import pbkdf2_hmac
 from typing import Annotated
 from typing import Any
 from typing import Optional
-from typing import Union
-from uuid import uuid4
 
-from pydantic import UUID4
 from pydantic import EmailStr
 from pydantic import Field
 from pydantic import SecretBytes
@@ -19,6 +16,7 @@ from pydantic import validate_call
 
 from shepherd_core.data_models.base.content import NameStr
 from shepherd_core.data_models.base.content import SafeStr
+from shepherd_core.data_models.base.content import id_default
 from shepherd_core.data_models.base.shepherd import ShpModel
 
 
@@ -41,10 +39,9 @@ def hash_password(pw: Annotated[str, StringConstraints(min_length=20, max_length
 class User(ShpModel):
     """meta-data representation of a testbed-component (physical object)."""
 
-    # id: UUID4 = Field(  # TODO: db-migration - temp fix for documentation
-    id: Union[UUID4, int] = Field(
+    id: int = Field(
         description="Unique ID",
-        default_factory=uuid4,
+        default_factory=id_default,
     )
     name: NameStr
     description: Optional[SafeStr] = None

shepherd_core/version.py

@@ -1,3 +1,3 @@
 """Separated string avoids circular imports."""
 
-version: str = "2025.05.2"
+version: str = "2025.06.1"