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

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:

shepherd_core/testbed_client/client_web.py

@@ -3,8 +3,6 @@
 from importlib import import_module
 from pathlib import Path
 from typing import Any
-from typing import Optional
-from typing import Union
 
 from pydantic import validate_call
 
@@ -28,7 +26,7 @@ class WebClient(AbcClient):
 
     testbed_server_default = "https://shepherd.cfaed.tu-dresden.de:8000/testbed"
 
-    def __init__(self, server: Optional[str] = None, token: Union[str, Path, None] = None) -> None:
+    def __init__(self, server: str | None = None, token: str | Path | None = None) -> None:
         """Connect to Testbed-Server with optional token and server-address.
 
         server: optional address to shepherd-server-endpoint
@@ -39,8 +37,8 @@ class WebClient(AbcClient):
             # add default values
             self._token: str = "basic_public_access"  # noqa: S105
             self._server: str = config.TESTBED_SERVER
-            self._user: Optional[User] = None
-            self._key: Optional[str] = None
+            self._user: User | None = None
+            self._key: str | None = None
             self._connected: bool = False
             self._req = None
 
@@ -66,9 +64,7 @@ class WebClient(AbcClient):
     def query_names(self, model_type: str) -> list[str]:
         raise NotImplementedError("TODO")
 
-    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:
         raise NotImplementedError("TODO")
 
     def try_inheritance(
@@ -88,7 +84,7 @@ class WebClient(AbcClient):
     # Below are extra FNs not in ABC
 
     @validate_call
-    def _connect(self, server: Optional[str] = None, token: Union[str, Path, None] = None) -> bool:
+    def _connect(self, server: str | None = None, token: str | Path | None = None) -> bool:
         """Establish connection to testbed-server.
 
         TODO: totally not finished

shepherd_core/testbed_client/fixtures.py

@@ -8,8 +8,6 @@ from datetime import datetime
 from datetime import timedelta
 from pathlib import Path
 from typing import Any
-from typing import Optional
-from typing import Union
 
 import yaml
 from pydantic import validate_call
@@ -57,7 +55,7 @@ class Fixture:
         # update iterator
         self._iter_list: list[dict[str, Any]] = list(self.elements_by_name.values())
 
-    def __getitem__(self, key: Union[str, int]) -> dict[str, Any]:
+    def __getitem__(self, key: str | int) -> dict[str, Any]:
         original_key = key
         if isinstance(key, str):
             key = key.lower()
@@ -89,7 +87,7 @@ class Fixture:
         return {_i["id"]: _i["name"] for _i in self.elements_by_id.values()}
 
     def inheritance(
-        self, values: dict[str, Any], chain: Optional[list[str]] = None
+        self, values: dict[str, Any], chain: list[str] | None = None
     ) -> tuple[dict[str, Any], list[str]]:
         if chain is None:
             chain = []
@@ -177,7 +175,7 @@ class Fixtures:
     suffix = ".yaml"
 
     @validate_call
-    def __init__(self, file_path: Optional[Path] = None, *, reset: bool = False) -> None:
+    def __init__(self, file_path: Path | None = None, *, reset: bool = False) -> None:
         if file_path is None:
             self.file_path = Path(__file__).parent.parent.resolve() / "data_models"
         else:

shepherd_core/testbed_client/user_model.py

@@ -4,7 +4,6 @@ import secrets
 from hashlib import pbkdf2_hmac
 from typing import Annotated
 from typing import Any
-from typing import Optional
 
 from pydantic import EmailStr
 from pydantic import Field
@@ -44,14 +43,14 @@ class User(ShpModel):
         default_factory=id_default,
     )
     name: NameStr
-    description: Optional[SafeStr] = None
-    comment: Optional[SafeStr] = None
+    description: SafeStr | None = None
+    comment: SafeStr | None = None
 
-    name_full: Optional[NameStr] = None
+    name_full: NameStr | None = None
     group: NameStr
     email: EmailStr
 
-    pw_hash: Optional[SecretBytes] = None
+    pw_hash: SecretBytes | None = None
     # ⤷ was hash_password("this_will_become_a_salted_slow_hash") -> slowed BBB down
     # ⤷ TODO (min_length=128, max_length=512)
 

shepherd_core/version.py

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

shepherd_core/vsource/virtual_converter_model.py

@@ -15,7 +15,6 @@ Compromises:
 """
 
 import math
-from typing import Optional
 
 from shepherd_core.data_models import CalibrationEmulator
 from shepherd_core.data_models.content.virtual_source import LUT_SIZE
@@ -32,7 +31,7 @@ class PruCalibration:
     RESIDUE_MAX_nA: int = NOISE_ESTIMATE_nA * RESIDUE_SIZE_FACTOR
     negative_residue_nA = 0
 
-    def __init__(self, cal_emu: Optional[CalibrationEmulator] = None) -> None:
+    def __init__(self, cal_emu: CalibrationEmulator | None = None) -> None:
         self.cal = cal_emu if cal_emu else CalibrationEmulator()
 
     def conv_adc_raw_to_nA(self, current_raw: int) -> float:

shepherd_core/vsource/virtual_harvester_simulation.py

@@ -9,7 +9,6 @@ The output file can be analyzed and plotted with shepherds tool suite.
 
 from contextlib import ExitStack
 from pathlib import Path
-from typing import Optional
 
 from tqdm import tqdm
 
@@ -23,7 +22,7 @@ from .virtual_harvester_model import VirtualHarvesterModel
 
 
 def simulate_harvester(
-    config: VirtualHarvesterConfig, path_input: Path, path_output: Optional[Path] = None
+    config: VirtualHarvesterConfig, path_input: Path, path_output: Path | None = None
 ) -> float:
     """Simulate behavior of virtual harvester algorithms.
 

shepherd_core/vsource/virtual_source_model.py

@@ -10,8 +10,6 @@ NOTE: DO NOT OPTIMIZE -> stay close to original code-base
 
 """
 
-from typing import Optional
-
 from shepherd_core.data_models.base.calibration import CalibrationEmulator
 from shepherd_core.data_models.content.energy_environment import EnergyDType
 from shepherd_core.data_models.content.virtual_harvester import HarvesterPRUConfig
@@ -28,11 +26,11 @@ class VirtualSourceModel:
 
     def __init__(
         self,
-        vsrc: Optional[VirtualSourceConfig],
+        vsrc: VirtualSourceConfig | None,
         cal_emu: CalibrationEmulator,
         dtype_in: EnergyDType = EnergyDType.ivsample,
-        window_size: Optional[int] = None,
-        voltage_step_V: Optional[float] = None,
+        window_size: int | None = None,
+        voltage_step_V: float | None = None,
         *,
         log_intermediate: bool = False,
     ) -> None:

shepherd_core/vsource/virtual_source_simulation.py

@@ -9,7 +9,6 @@ The output file can be analyzed and plotted with shepherds tool suite.
 
 from contextlib import ExitStack
 from pathlib import Path
-from typing import Optional
 
 import numpy as np
 from tqdm import tqdm
@@ -28,7 +27,7 @@ def simulate_source(
     config: VirtualSourceConfig,
     target: TargetABC,
     path_input: Path,
-    path_output: Optional[Path] = None,
+    path_output: Path | None = None,
     *,
     monitor_internals: bool = False,
 ) -> float:
@@ -66,7 +65,7 @@ def simulate_source(
         stats_internal = np.empty((round(file_inp.runtime_s * file_inp.samplerate_sps), 11))
         try:
             # keep dependencies low
-            from matplotlib import pyplot as plt
+            from matplotlib import pyplot as plt  # noqa: PLC0415
         except ImportError:
             log.warning("Matplotlib not installed, plotting of internals disabled")
             stats_internal = None

shepherd_core/writer.py

@@ -9,8 +9,6 @@ from itertools import product
 from pathlib import Path
 from types import TracebackType
 from typing import Any
-from typing import Optional
-from typing import Union
 
 import h5py
 import numpy as np
@@ -32,7 +30,7 @@ from .reader import Reader
 
 # copy of core/models/base/shepherd - needed also here
 def path2str(
-    dumper: SafeDumper, data: Union[pathlib.Path, pathlib.WindowsPath, pathlib.PosixPath]
+    dumper: SafeDumper, data: pathlib.Path | pathlib.WindowsPath | pathlib.PosixPath
 ) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:str", str(data.as_posix()))
@@ -49,7 +47,7 @@ yaml.add_representer(pathlib.Path, path2str, SafeDumper)
 yaml.add_representer(timedelta, time2int, SafeDumper)
 
 
-def unique_path(base_path: Union[str, Path], suffix: str) -> Path:
+def unique_path(base_path: str | Path, suffix: str) -> Path:
     """Find an unused filename in case it already exists.
 
     :param base_path: file-path to test
@@ -100,11 +98,11 @@ class Writer(Reader):
     def __init__(
         self,
         file_path: Path,
-        mode: Optional[str] = None,
-        datatype: Union[str, EnergyDType, None] = None,
-        window_samples: Optional[int] = None,
-        cal_data: Union[CalSeries, CalEmu, CalHrv, None] = None,
-        compression: Optional[Compression] = Compression.default,
+        mode: str | None = None,
+        datatype: str | EnergyDType | None = None,
+        window_samples: int | None = None,
+        cal_data: CalSeries | CalEmu | CalHrv | None = None,
+        compression: Compression | None = Compression.default,
         *,
         modify_existing: bool = False,
         force_overwrite: bool = False,
@@ -210,9 +208,9 @@ class Writer(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:
         self._align()
@@ -279,7 +277,7 @@ class Writer(Reader):
 
     def append_iv_data_raw(
         self,
-        timestamp: Union[np.ndarray, float, int],  # noqa: PYI041
+        timestamp: np.ndarray | float | int,  # noqa: PYI041
         voltage: np.ndarray,
         current: np.ndarray,
     ) -> None:
@@ -318,7 +316,7 @@ class Writer(Reader):
 
     def append_iv_data_si(
         self,
-        timestamp: Union[np.ndarray, float],
+        timestamp: np.ndarray | float,
         voltage: np.ndarray,
         current: np.ndarray,
     ) -> None:

{shepherd_core-2025.6.3.dist-info → shepherd_core-2025.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shepherd_core
-Version: 2025.6.3
+Version: 2025.8.1
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Author-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
 Maintainer-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
@@ -18,7 +18,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -26,7 +25,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Natural Language :: English
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: h5py
 Requires-Dist: numpy
@@ -44,15 +43,12 @@ Requires-Dist: pwntools-elf-only; extra == "elf"
 Provides-Extra: inventory
 Requires-Dist: psutil; extra == "inventory"
 Provides-Extra: dev
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: pyright; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: coverage; extra == "test"
+Provides-Extra: all
+Requires-Dist: shepherd-core[dev,elf,inventory,test]; extra == "all"
 
 # Core Library