shepherd-core 2025.6.3__py3-none-any.whl → 2025.6.4__py3-none-any.whl

shepherd_core/data_models/task/observer_tasks.py

@@ -5,7 +5,6 @@ from datetime import datetime
 from pathlib import Path
 from pathlib import PurePosixPath
 from typing import Annotated
-from typing import Optional
 
 from pydantic import validate_call
 from typing_extensions import Self
@@ -29,20 +28,20 @@ class ObserverTasks(ShpModel):
     observer: NameStr
 
     # PRE PROCESS
-    time_prep: Optional[datetime] = None  # TODO: currently not used
+    time_prep: datetime | None = None  # TODO: currently not used
     root_path: Path
 
     # fw mod, store as hex-file and program
-    fw1_mod: Optional[FirmwareModTask] = None
-    fw2_mod: Optional[FirmwareModTask] = None
-    fw1_prog: Optional[ProgrammingTask] = None
-    fw2_prog: Optional[ProgrammingTask] = None
+    fw1_mod: FirmwareModTask | None = None
+    fw2_mod: FirmwareModTask | None = None
+    fw1_prog: ProgrammingTask | None = None
+    fw2_prog: ProgrammingTask | None = None
 
     # MAIN PROCESS
-    emulation: Optional[EmulationTask] = None
+    emulation: EmulationTask | None = None
 
     # deprecations, TODO: remove before public release
-    owner_id: Annotated[Optional[IdInt], deprecated("not needed anymore")] = None
+    owner_id: Annotated[IdInt | None, deprecated("not needed anymore")] = None
     abort_on_error: Annotated[bool, deprecated("has no effect")] = False
 
     # post_copy / cleanup, Todo: could also just intake emuTask

shepherd_core/data_models/task/programming.py

@@ -4,7 +4,6 @@ from collections.abc import Set as AbstractSet
 from pathlib import Path
 from pathlib import PurePosixPath
 from typing import Annotated
-from typing import Optional
 
 from pydantic import Field
 from pydantic import model_validator
@@ -60,7 +59,7 @@ class ProgrammingTask(ShpModel):
         tgt_id: IdInt,
         mcu_port: MCUPort,
         fw_path: Path,
-    ) -> Optional[Self]:
+    ) -> Self | None:
         obs = tb.get_observer(tgt_id)
         tgt_cfg = xp.get_target_config(tgt_id)
 

shepherd_core/data_models/task/testbed_tasks.py

@@ -4,14 +4,11 @@ from pathlib import Path
 from pathlib import PurePosixPath
 from typing import TYPE_CHECKING
 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
 from shepherd_core.data_models.base.shepherd import ShpModel
 from shepherd_core.data_models.experiment.experiment import Experiment
@@ -29,13 +26,9 @@ class TestbedTasks(ShpModel):
     name: NameStr
     observer_tasks: Annotated[list[ObserverTasks], Field(min_length=1, max_length=128)]
 
-    # 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
-    def from_xp(cls, xp: Experiment, tb: Optional[Testbed] = None) -> Self:
+    def from_xp(cls, xp: Experiment, tb: Testbed | None = None) -> Self:
         if tb is None:
             # TODO: is tb-argument really needed? prob. not
             tb = Testbed()  # this will query the first (and only) entry of client
@@ -47,7 +40,7 @@ class TestbedTasks(ShpModel):
             observer_tasks=obs_tasks,
         )
 
-    def get_observer_tasks(self, observer: str) -> Optional[ObserverTasks]:
+    def get_observer_tasks(self, observer: str) -> ObserverTasks | None:
         for tasks in self.observer_tasks:
             if observer == tasks.observer:
                 return tasks

shepherd_core/data_models/testbed/cape.py

@@ -4,8 +4,6 @@ from datetime import date
 from datetime import datetime
 from enum import Enum
 from typing import Any
-from typing import Optional
-from typing import Union
 
 from pydantic import Field
 from pydantic import model_validator
@@ -31,12 +29,12 @@ class Cape(ShpModel, title="Shepherd-Cape"):
     name: NameStr
     version: NameStr
     description: SafeStr
-    comment: Optional[SafeStr] = None
+    comment: SafeStr | None = None
     # TODO: wake_interval, calibration
 
     active: bool = True
-    created: Union[date, datetime] = Field(default_factory=datetime.now)
-    calibrated: Union[date, datetime, None] = None
+    created: date | datetime = Field(default_factory=datetime.now)
+    calibrated: date | datetime | None = None
 
     def __str__(self) -> str:
         return self.name

shepherd_core/data_models/testbed/gpio.py

@@ -3,7 +3,6 @@
 from enum import Enum
 from typing import Annotated
 from typing import Any
-from typing import Optional
 
 from pydantic import Field
 from pydantic import StringConstraints
@@ -30,16 +29,16 @@ class GPIO(ShpModel, title="GPIO of Observer Node"):
 
     id: IdInt
     name: NameStr
-    description: Optional[SafeStr] = None
-    comment: Optional[SafeStr] = None
+    description: SafeStr | None = None
+    comment: SafeStr | None = None
 
     direction: Direction = Direction.Input
-    dir_switch: Optional[Annotated[str, StringConstraints(max_length=32)]] = None
+    dir_switch: Annotated[str, StringConstraints(max_length=32)] | None = None
 
-    reg_pru: Optional[Annotated[str, StringConstraints(max_length=10)]] = None
-    pin_pru: Optional[Annotated[str, StringConstraints(max_length=10)]] = None
-    reg_sys: Optional[Annotated[int, Field(ge=0)]] = None
-    pin_sys: Optional[Annotated[str, StringConstraints(max_length=10)]] = None
+    reg_pru: Annotated[str, StringConstraints(max_length=10)] | None = None
+    pin_pru: Annotated[str, StringConstraints(max_length=10)] | None = None
+    reg_sys: Annotated[int, Field(ge=0)] | None = None
+    pin_sys: Annotated[str, StringConstraints(max_length=10)] | None = None
 
     def __str__(self) -> str:
         return self.name

shepherd_core/data_models/testbed/mcu.py

@@ -3,7 +3,6 @@
 from enum import Enum
 from typing import Annotated
 from typing import Any
-from typing import Optional
 
 from pydantic import Field
 from pydantic import model_validator
@@ -30,7 +29,7 @@ class MCU(ShpModel, title="Microcontroller of the Target Node"):
     id: IdInt
     name: NameStr
     description: SafeStr
-    comment: Optional[SafeStr] = None
+    comment: SafeStr | None = None
 
     platform: NameStr
     core: NameStr

shepherd_core/data_models/testbed/observer.py

@@ -3,7 +3,6 @@
 from datetime import datetime
 from typing import Annotated
 from typing import Any
-from typing import Optional
 
 from pydantic import Field
 from pydantic import IPvAnyAddress
@@ -33,7 +32,7 @@ class Observer(ShpModel, title="Shepherd-Sheep"):
     id: IdInt
     name: NameStr
     description: SafeStr
-    comment: Optional[SafeStr] = None
+    comment: SafeStr | None = None
 
     ip: IPvAnyAddress
     mac: MACStr
@@ -46,12 +45,12 @@ class Observer(ShpModel, title="Shepherd-Sheep"):
     """ ⤷ cfaed-floor"""
 
     active: bool = True
-    cape: Optional[Cape] = None
-    target_a: Optional[Target] = None
-    target_b: Optional[Target] = None
+    cape: Cape | None = None
+    target_a: Target | None = None
+    target_b: Target | None = None
 
     created: datetime = Field(default_factory=datetime.now)
-    alive_last: Optional[datetime] = None
+    alive_last: datetime | None = None
 
     def __str__(self) -> str:
         return self.name

shepherd_core/data_models/testbed/target.py

@@ -3,8 +3,6 @@
 from datetime import datetime
 from typing import Annotated
 from typing import Any
-from typing import Optional
-from typing import Union
 
 from pydantic import Field
 from pydantic import model_validator
@@ -30,15 +28,15 @@ class Target(ShpModel, title="Target Node (DuT)"):
     version: NameStr
     description: SafeStr
 
-    comment: Optional[SafeStr] = None
+    comment: SafeStr | None = None
 
     active: bool = True
     created: datetime = Field(default_factory=datetime.now)
 
-    testbed_id: Optional[IdInt16] = None
+    testbed_id: IdInt16 | None = None
     """ ⤷ is derived from ID (targets are still selected by id!)"""
-    mcu1: Union[MCU, NameStr]
-    mcu2: Union[MCU, NameStr, None] = None
+    mcu1: MCU | NameStr
+    mcu2: MCU | NameStr | None = None
 
     # TODO: programming pins per mcu should be here (or better in Cape)
 

shepherd_core/data_models/testbed/testbed.py

@@ -4,7 +4,6 @@ from datetime import timedelta
 from pathlib import Path
 from typing import Annotated
 from typing import Any
-from typing import Optional
 
 from pydantic import Field
 from pydantic import HttpUrl
@@ -29,9 +28,9 @@ class Testbed(ShpModel):
     id: IdInt
     name: NameStr
     description: SafeStr
-    comment: Optional[SafeStr] = None
+    comment: SafeStr | None = None
 
-    url: Optional[HttpUrl] = None
+    url: HttpUrl | None = None
 
     observers: Annotated[list[Observer], Field(min_length=1, max_length=128)]
 

shepherd_core/decoder_waveform/uart.py

@@ -23,8 +23,6 @@ https://sigrok.org/wiki/Protocol_decoder:Uart
 
 from enum import Enum
 from pathlib import Path
-from typing import Optional
-from typing import Union
 
 import numpy as np
 
@@ -51,12 +49,12 @@ class Uart:
 
     def __init__(
         self,
-        content: Union[Path, np.ndarray],
-        baud_rate: Optional[int] = None,
-        frame_length: Optional[int] = 8,
-        inversion: Optional[bool] = None,
-        parity: Optional[Parity] = Parity.no,
-        bit_order: Optional[BitOrder] = BitOrder.lsb_first,
+        content: Path | np.ndarray,
+        baud_rate: int | None = None,
+        frame_length: int | None = 8,
+        inversion: bool | None = None,
+        parity: Parity | None = Parity.no,
+        bit_order: BitOrder | None = BitOrder.lsb_first,
     ) -> None:
         """Provide a file with two columns: TS & Signal.
 
@@ -115,9 +113,9 @@ class Uart:
             log.error("Signal still inverted?!? Check parameters and input")
 
         # results
-        self.events_symbols: Optional[np.ndarray] = None
-        self.events_lines: Optional[np.ndarray] = None
-        self.text: Optional[str] = None
+        self.events_symbols: np.ndarray | None = None
+        self.events_lines: np.ndarray | None = None
+        self.text: str | None = None
 
     def _convert_analog2digital(self, *, invert: bool = False) -> None:
         """Divide dimension in two, divided by mean-value."""
@@ -208,9 +206,9 @@ class Uart:
         if self.events_symbols is not None:
             return self.events_symbols
 
-        pos_df: Optional[int] = None
+        pos_df: int | None = None
         symbol: int = 0
-        t_start: Optional[float] = None
+        t_start: float | None = None
         content: list = []
 
         for time, value, steps in self.events_sig:

shepherd_core/fw_tools/converter.py

@@ -4,7 +4,6 @@ import base64
 import hashlib
 import shutil
 from pathlib import Path
-from typing import Union
 
 import zstandard as zstd
 from pydantic import validate_call
@@ -81,7 +80,7 @@ def base64_to_hash(content: str) -> str:
 
 
 @validate_call
-def extract_firmware(data: Union[str, Path], data_type: FirmwareDType, file_path: Path) -> Path:
+def extract_firmware(data: str | Path, data_type: FirmwareDType, file_path: Path) -> Path:
     """Make embedded firmware-data usable in filesystem.
 
     - base64-string will be transformed to file

shepherd_core/fw_tools/converter_elf.py

@@ -2,7 +2,6 @@
 
 import subprocess
 from pathlib import Path
-from typing import Optional
 
 from pydantic import validate_call
 
@@ -10,7 +9,7 @@ from pydantic import validate_call
 
 
 @validate_call
-def elf_to_hex(file_elf: Path, file_hex: Optional[Path] = None) -> Path:
+def elf_to_hex(file_elf: Path, file_hex: Path | None = None) -> Path:
     """Convert ELF to hex file using objcopy."""
     if not file_elf.is_file():
         raise ValueError("Fn needs an existing file as input")

shepherd_core/fw_tools/patcher.py

@@ -2,7 +2,6 @@
 
 from pathlib import Path
 from typing import Annotated
-from typing import Optional
 
 from pydantic import Field
 from pydantic import validate_call
@@ -49,7 +48,7 @@ def find_symbol(file_elf: Path, symbol: str) -> bool:
 
 
 @validate_call
-def read_symbol(file_elf: Path, symbol: str, length: int) -> Optional[int]:
+def read_symbol(file_elf: Path, symbol: str, length: int) -> int | None:
     """Read value of symbol in ELF-File.
 
     Will be interpreted as int.
@@ -65,12 +64,12 @@ def read_symbol(file_elf: Path, symbol: str, length: int) -> Optional[int]:
     return int.from_bytes(bytes=value_raw, byteorder=elf.endian, signed=False)
 
 
-def read_uid(file_elf: Path) -> Optional[int]:
+def read_uid(file_elf: Path) -> int | None:
     """Read value of UID-symbol for shepherd testbed."""
     return read_symbol(file_elf, symbol=config.UID_NAME, length=config.UID_SIZE)
 
 
-def read_arch(file_elf: Path) -> Optional[str]:
+def read_arch(file_elf: Path) -> str | None:
     """Determine chip-architecture from elf-metadata."""
     if not is_elf(file_elf):
         return None
@@ -90,7 +89,7 @@ def modify_symbol_value(
     value: Annotated[int, Field(ge=0, lt=2 ** (8 * config.UID_SIZE))],
     *,
     overwrite: bool = False,
-) -> Optional[Path]:
+) -> Path | None:
     """Replace value of uint16-symbol in ELF-File.
 
     Hardcoded for uint16_t (2 byte).
@@ -129,6 +128,6 @@ def modify_symbol_value(
     return file_new
 
 
-def modify_uid(file_elf: Path, value: int) -> Optional[Path]:
+def modify_uid(file_elf: Path, value: int) -> Path | None:
     """Replace value of UID-symbol for shepherd testbed."""
     return modify_symbol_value(file_elf, symbol=config.UID_NAME, value=value, overwrite=True)

shepherd_core/inventory/python.py

@@ -3,7 +3,6 @@
 import platform
 from contextlib import suppress
 from importlib import import_module
-from typing import Optional
 
 from pydantic import ConfigDict
 from typing_extensions import Self
@@ -15,14 +14,14 @@ class PythonInventory(ShpModel):
     """Python related inventory model."""
 
     # program versions
-    h5py: Optional[str] = None
-    numpy: Optional[str] = None
-    pydantic: Optional[str] = None
-    python: Optional[str] = None
-    shepherd_core: Optional[str] = None
-    shepherd_sheep: Optional[str] = None
-    yaml: Optional[str] = None
-    zstandard: Optional[str] = None
+    h5py: str | None = None
+    numpy: str | None = None
+    pydantic: str | None = None
+    python: str | None = None
+    shepherd_core: str | None = None
+    shepherd_sheep: str | None = None
+    yaml: str | None = None
+    zstandard: str | None = None
 
     model_config = ConfigDict(str_min_length=0)
 

shepherd_core/inventory/system.py

@@ -9,7 +9,6 @@ from datetime import datetime
 from pathlib import Path
 from types import MappingProxyType
 from typing import Any
-from typing import Optional
 
 from typing_extensions import Self
 
@@ -41,7 +40,7 @@ class SystemInventory(ShpModel):
     machine: str
     processor: str
 
-    ptp: Optional[str] = None
+    ptp: str | None = None
 
     hostname: str
 

shepherd_core/inventory/target.py

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

shepherd_core/logger.py

@@ -2,7 +2,6 @@
 
 import logging
 import logging.handlers
-from typing import Union
 
 import chromalog
 
@@ -18,7 +17,7 @@ def get_verbose_level() -> int:
     return verbose_level
 
 
-def set_log_verbose_level(log_: Union[logging.Logger, logging.Handler], verbose: int) -> None:
+def set_log_verbose_level(log_: logging.Logger | logging.Handler, verbose: int) -> None:
     """Set log level of shepherd."""
     if verbose == 0:
         log_.setLevel(logging.ERROR)

shepherd_core/reader.py

@@ -12,10 +12,7 @@ from itertools import product
 from pathlib import Path
 from types import MappingProxyType
 from typing import TYPE_CHECKING
-from typing import Annotated
 from typing import Any
-from typing import Optional
-from typing import Union
 
 import h5py
 import numpy as np
@@ -91,8 +88,6 @@ class Reader:
         self.file_size: int = 0
         self.data_rate: float = 0
 
-        self.buffers_n: Annotated[int, deprecated("use .chunk_n instead")] = 0
-
         # open file (if not already done by writer)
         self._reader_opened: bool = False
         if not hasattr(self, "h5file"):
@@ -161,9 +156,9 @@ class Reader:
 
     def __exit__(
         self,
-        typ: Optional[type[BaseException]] = None,
-        exc: Optional[BaseException] = None,
-        tb: Optional[TracebackType] = None,
+        typ: type[BaseException] | None = None,
+        exc: BaseException | None = None,
+        tb: TracebackType | None = None,
         extra_arg: int = 0,
     ) -> None:
         if self._reader_opened:
@@ -193,7 +188,7 @@ class Reader:
             self.sample_interval_ns = round(10**9 * self.sample_interval_s)
             self.samplerate_sps = max(round((self.samples_n - 1) / duration_s), 1)
         self.runtime_s = round(self.samples_n / self.samplerate_sps, 1)
-        self.chunks_n = self.buffers_n = int(self.samples_n // self.CHUNK_SAMPLES_N)
+        self.chunks_n = int(self.samples_n // self.CHUNK_SAMPLES_N)
         if isinstance(self.file_path, Path):
             self.file_size = self.file_path.stat().st_size
         else:
@@ -203,8 +198,8 @@ class Reader:
     def read(
         self,
         start_n: int = 0,
-        end_n: Optional[int] = None,
-        n_samples_per_chunk: Optional[int] = None,
+        end_n: int | None = None,
+        n_samples_per_chunk: int | None = None,
         *,
         is_raw: bool = False,
         omit_timestamps: bool = False,
@@ -251,8 +246,8 @@ class Reader:
     def read_buffers(
         self,
         start_n: int = 0,
-        end_n: Optional[int] = None,
-        n_samples_per_buffer: Optional[int] = None,
+        end_n: int | None = None,
+        n_samples_per_buffer: int | None = None,
         *,
         is_raw: bool = False,
         omit_ts: bool = False,
@@ -265,7 +260,7 @@ class Reader:
             omit_timestamps=omit_ts,
         )
 
-    def get_time_start(self) -> Optional[datetime]:
+    def get_time_start(self) -> datetime | None:
         if self.samples_n < 1:
             return None
         return datetime.fromtimestamp(self._cal.time.raw_to_si(self.ds_time[0]), tz=local_tz())
@@ -297,7 +292,7 @@ class Reader:
             return self.h5file.attrs["hostname"]
         return "unknown"
 
-    def get_datatype(self) -> Optional[EnergyDType]:
+    def get_datatype(self) -> EnergyDType | None:
         try:
             if "datatype" in self.h5file["data"].attrs:
                 return EnergyDType[self.h5file["data"].attrs["datatype"]]
@@ -308,7 +303,7 @@ class Reader:
         else:
             return None
 
-    def get_voltage_step(self) -> Optional[float]:
+    def get_voltage_step(self) -> float | None:
         """Informs about the voltage step (in volts) used during harvesting the ivcurve.
 
         Options for figuring out the real step:
@@ -316,7 +311,7 @@ class Reader:
         - analyze recorded data for most often used delta
         - calculate with 'steps_n * (1 + wait_cycles)' (done for calculating window_size)
         """
-        voltage_step: Optional[float] = (
+        voltage_step: float | None = (
             self.get_config().get("virtual_harvester", {}).get("voltage_step_mV", None)
         )
         if voltage_step is None:
@@ -510,7 +505,7 @@ class Reader:
         return float(sum(energy_ws))
 
     def _dset_statistics(
-        self, dset: h5py.Dataset, cal: Optional[CalibrationPair] = None
+        self, dset: h5py.Dataset, cal: CalibrationPair | None = None
     ) -> dict[str, float]:
         """Create basic stats for a provided dataset.
 
@@ -615,7 +610,7 @@ class Reader:
 
     def get_metadata(
         self,
-        node: Union[h5py.Dataset, h5py.Group, None] = None,
+        node: h5py.Dataset | h5py.Group | None = None,
         *,
         minimal: bool = False,
     ) -> dict[str, dict]:
@@ -670,7 +665,7 @@ class Reader:
 
         return metadata
 
-    def save_metadata(self, node: Union[h5py.Dataset, h5py.Group, None] = None) -> dict:
+    def save_metadata(self, node: h5py.Dataset | h5py.Group | None = None) -> dict:
         """Get structure of file and dump content to yaml-file with same name as original.
 
         :param node: starting node, leave free to go through whole file
@@ -688,7 +683,7 @@ class Reader:
             metadata = {}
         return metadata
 
-    def get_gpio_pin_num(self, name: str) -> Optional[int]:
+    def get_gpio_pin_num(self, name: str) -> int | None:
         # reverse lookup in a 2D-dict: key1 are pin_num, key2 are descriptor-names
         if "gpio" not in self.h5file:
             return None
@@ -709,7 +704,7 @@ class Reader:
         data_1 = np.concatenate(([not data[0]], data[:-1]))
         return data != data_1
 
-    def gpio_to_waveforms(self, name: Optional[str] = None) -> dict:
+    def gpio_to_waveforms(self, name: str | None = None) -> dict:
         waveforms: dict[str, np.ndarray] = {}
         if "gpio" not in self.h5file:
             return waveforms
@@ -744,7 +739,7 @@ class Reader:
             for row in pin_wf:
                 csv.write(f"{row[0] / 1e9}{separator}{int(row[1])}\n")
 
-    def gpio_to_uart(self) -> Optional[np.ndarray]:
+    def gpio_to_uart(self) -> np.ndarray | None:
         wfs = self.gpio_to_waveforms("uart")
         if len(wfs) < 1:
             return None

shepherd_core/testbed_client/client_abc_fix.py

@@ -18,7 +18,6 @@ TODO: Comfort functions missing
 from abc import ABC
 from abc import abstractmethod
 from typing import Any
-from typing import Optional
 
 from shepherd_core.data_models.base.shepherd import ShpModel
 from shepherd_core.data_models.base.wrapper import Wrapper
@@ -49,9 +48,7 @@ class AbcClient(ABC):
         pass
 
     @abstractmethod
-    def query_item(
-        self, model_type: str, uid: Optional[int] = None, name: Optional[str] = None
-    ) -> dict:
+    def query_item(self, model_type: str, uid: int | None = None, name: str | None = None) -> dict:
         pass
 
     @abstractmethod
@@ -103,9 +100,7 @@ class FixturesClient(AbcClient):
     def query_names(self, model_type: str) -> list[str]:
         return list(self._fixtures[model_type].elements_by_name.keys())
 
-    def query_item(
-        self, model_type: str, uid: Optional[int] = None, name: Optional[str] = None
-    ) -> dict:
+    def query_item(self, model_type: str, uid: int | None = None, name: str | None = None) -> dict:
         if uid is not None:
             return self._fixtures[model_type].query_id(uid)
         if name is not None: