shepherd-core 2025.2.2__py3-none-any.whl → 2025.4.2__py3-none-any.whl

shepherd_core/data_models/experiment/target_config.py

@@ -1,20 +1,20 @@
 """Configuration related to Target Nodes (DuT)."""
 
-from typing import List
+from typing import Annotated
 from typing import Optional
 
 from pydantic import Field
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ..base.content import IdInt
-from ..base.shepherd import ShpModel
-from ..content.energy_environment import EnergyEnvironment
-from ..content.firmware import Firmware
-from ..content.virtual_source import VirtualSourceConfig
-from ..testbed.target import IdInt16
-from ..testbed.target import Target
+from shepherd_core.data_models.base.content import IdInt
+from shepherd_core.data_models.base.shepherd import ShpModel
+from shepherd_core.data_models.content.energy_environment import EnergyEnvironment
+from shepherd_core.data_models.content.firmware import Firmware
+from shepherd_core.data_models.content.virtual_source import VirtualSourceConfig
+from shepherd_core.data_models.testbed.target import IdInt16
+from shepherd_core.data_models.testbed.target import Target
+
 from .observer_features import GpioActuation
 from .observer_features import GpioTracing
 from .observer_features import PowerTracing
@@ -23,15 +23,15 @@ from .observer_features import PowerTracing
 class TargetConfig(ShpModel, title="Target Config"):
     """Configuration related to Target Nodes (DuT)."""
 
-    target_IDs: Annotated[List[IdInt], Field(min_length=1, max_length=128)]
-    custom_IDs: Optional[Annotated[List[IdInt16], Field(min_length=1, max_length=128)]] = None
+    target_IDs: Annotated[list[IdInt], Field(min_length=1, max_length=128)]
+    custom_IDs: Optional[Annotated[list[IdInt16], Field(min_length=1, max_length=128)]] = None
     # ⤷ will replace 'const uint16_t SHEPHERD_NODE_ID' in firmware
     #   if no custom ID is provided, the original ID of target is used
 
     energy_env: EnergyEnvironment  # alias: input
     virtual_source: VirtualSourceConfig = VirtualSourceConfig(name="neutral")
     target_delays: Optional[
-        Annotated[List[Annotated[int, Field(ge=0)]], Field(min_length=1, max_length=128)]
+        Annotated[list[Annotated[int, Field(ge=0)]], Field(min_length=1, max_length=128)]
     ] = None
     # ⤷ individual starting times -> allows to use the same environment
     # TODO: delays not used ATM

shepherd_core/data_models/readme.md

@@ -46,6 +46,7 @@
 - these do not work
 
 ```Python
+from typing import Dict
 from pydantic import Field
 from shepherd_core.data_models import ShpModel
 
@@ -54,7 +55,7 @@ class Experiment(ShpModel, title="Config of an Experiment"):
         super().__init__()
         self.Config.fields["output_path"].description = "test description"
     class Config:
-        fields: dict[str, Field] = {}
+        fields: Dict[str, Field] = {}
         fields["output_path"] = Field(description="test description")
 ```
 

shepherd_core/data_models/task/__init__.py

@@ -4,15 +4,15 @@ These models import externally from all other model-modules!
 """
 
 from pathlib import Path
-from typing import List
 from typing import Optional
 from typing import Union
 
 import yaml
 
-from ...logger import logger
-from ..base.shepherd import ShpModel
-from ..base.wrapper import Wrapper
+from shepherd_core.data_models.base.shepherd import ShpModel
+from shepherd_core.data_models.base.wrapper import Wrapper
+from shepherd_core.logger import logger
+
 from .emulation import Compression
 from .emulation import EmulationTask
 from .firmware_mod import FirmwareModTask
@@ -74,7 +74,7 @@ def prepare_task(config: Union[ShpModel, Path, str], observer: Optional[str] = N
     return shp_wrap
 
 
-def extract_tasks(shp_wrap: Wrapper, *, no_task_sets: bool = True) -> List[ShpModel]:
+def extract_tasks(shp_wrap: Wrapper, *, no_task_sets: bool = True) -> list[ShpModel]:
     """Make the individual task-sets usable for each observer."""
     if shp_wrap.datatype == ObserverTasks.__name__:
         obt = ObserverTasks(**shp_wrap.parameters)

shepherd_core/data_models/task/emulation.py

@@ -5,26 +5,26 @@ from datetime import datetime
 from datetime import timedelta
 from enum import Enum
 from pathlib import Path
+from typing import Annotated
 from typing import Optional
 from typing import Union
 
 from pydantic import Field
 from pydantic import model_validator
 from pydantic import validate_call
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ..base.content import IdInt
-from ..base.shepherd import ShpModel
-from ..base.timezone import local_tz
-from ..content.virtual_source import VirtualSourceConfig
-from ..experiment.experiment import Experiment
-from ..experiment.observer_features import GpioActuation
-from ..experiment.observer_features import GpioTracing
-from ..experiment.observer_features import PowerTracing
-from ..experiment.observer_features import SystemLogging
-from ..testbed import Testbed
-from ..testbed.cape import TargetPort
+from shepherd_core.data_models.base.content import IdInt
+from shepherd_core.data_models.base.shepherd import ShpModel
+from shepherd_core.data_models.base.timezone import local_tz
+from shepherd_core.data_models.content.virtual_source import VirtualSourceConfig
+from shepherd_core.data_models.experiment.experiment import Experiment
+from shepherd_core.data_models.experiment.observer_features import GpioActuation
+from shepherd_core.data_models.experiment.observer_features import GpioTracing
+from shepherd_core.data_models.experiment.observer_features import PowerTracing
+from shepherd_core.data_models.experiment.observer_features import SystemLogging
+from shepherd_core.data_models.testbed import Testbed
+from shepherd_core.data_models.testbed.cape import TargetPort
 
 
 class Compression(str, Enum):
@@ -111,9 +111,8 @@ class EmulationTask(ShpModel):
     @model_validator(mode="after")
     def post_validation(self) -> Self:
         # TODO: limit paths
-        has_time = self.time_start is not None
         time_now = datetime.now().astimezone()
-        if has_time and self.time_start < time_now:
+        if self.time_start is not None and self.time_start < time_now:
             msg = (
                 "Start-Time for Emulation can't be in the past "
                 f"('{self.time_start}' vs '{time_now}'."

shepherd_core/data_models/task/firmware_mod.py

@@ -2,6 +2,7 @@
 
 import copy
 from pathlib import Path
+from typing import Annotated
 from typing import Optional
 from typing import TypedDict
 from typing import Union
@@ -9,20 +10,19 @@ from typing import Union
 from pydantic import Field
 from pydantic import model_validator
 from pydantic import validate_call
-from typing_extensions import Annotated
 from typing_extensions import Self
 from typing_extensions import Unpack
 
-from ...logger import logger
-from ..base.content import IdInt
-from ..base.shepherd import ShpModel
-from ..content.firmware import Firmware
-from ..content.firmware import FirmwareDType
-from ..content.firmware import FirmwareStr
-from ..experiment.experiment import Experiment
-from ..testbed import Testbed
-from ..testbed.target import IdInt16
-from ..testbed.target import MCUPort
+from shepherd_core.data_models.base.content import IdInt
+from shepherd_core.data_models.base.shepherd import ShpModel
+from shepherd_core.data_models.content.firmware import Firmware
+from shepherd_core.data_models.content.firmware import FirmwareDType
+from shepherd_core.data_models.content.firmware import FirmwareStr
+from shepherd_core.data_models.experiment.experiment import Experiment
+from shepherd_core.data_models.testbed import Testbed
+from shepherd_core.data_models.testbed.target import IdInt16
+from shepherd_core.data_models.testbed.target import MCUPort
+from shepherd_core.logger import logger
 
 
 class FirmwareModTask(ShpModel):

shepherd_core/data_models/task/harvest.py

@@ -3,18 +3,19 @@
 from datetime import datetime
 from datetime import timedelta
 from pathlib import Path
+from typing import Annotated
 from typing import Optional
 
 from pydantic import Field
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ..base.shepherd import ShpModel
-from ..base.timezone import local_tz
-from ..content.virtual_harvester import VirtualHarvesterConfig
-from ..experiment.observer_features import PowerTracing
-from ..experiment.observer_features import SystemLogging
+from shepherd_core.data_models.base.shepherd import ShpModel
+from shepherd_core.data_models.base.timezone import local_tz
+from shepherd_core.data_models.content.virtual_harvester import VirtualHarvesterConfig
+from shepherd_core.data_models.experiment.observer_features import PowerTracing
+from shepherd_core.data_models.experiment.observer_features import SystemLogging
+
 from .emulation import Compression
 
 

shepherd_core/data_models/task/observer_tasks.py

@@ -3,17 +3,17 @@
 from datetime import datetime
 from datetime import timedelta
 from pathlib import Path
-from typing import List
 from typing import Optional
 
 from pydantic import validate_call
 from typing_extensions import Self
 
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.shepherd import ShpModel
-from ..experiment.experiment import Experiment
-from ..testbed.testbed import Testbed
+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
+from shepherd_core.data_models.testbed.testbed import Testbed
+
 from .emulation import EmulationTask
 from .firmware_mod import FirmwareModTask
 from .programming import ProgrammingTask
@@ -78,7 +78,7 @@ class ObserverTasks(ShpModel):
             emulation=EmulationTask.from_xp(xp, tb, tgt_id, root_path),
         )
 
-    def get_tasks(self) -> List[ShpModel]:
+    def get_tasks(self) -> list[ShpModel]:
         task_names = ["fw1_mod", "fw2_mod", "fw1_prog", "fw2_prog", "emulation"]
         tasks = []
 

shepherd_core/data_models/task/programming.py

@@ -2,24 +2,24 @@
 
 import copy
 from pathlib import Path
+from typing import Annotated
 from typing import Optional
 
 from pydantic import Field
 from pydantic import model_validator
 from pydantic import validate_call
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ..base.content import IdInt
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
-from ..content.firmware import suffix_to_DType
-from ..content.firmware_datatype import FirmwareDType
-from ..experiment.experiment import Experiment
-from ..testbed.cape import TargetPort
-from ..testbed.mcu import ProgrammerProtocol
-from ..testbed.target import MCUPort
-from ..testbed.testbed import Testbed
+from shepherd_core.data_models.base.content import IdInt
+from shepherd_core.data_models.base.content import SafeStr
+from shepherd_core.data_models.base.shepherd import ShpModel
+from shepherd_core.data_models.content.firmware import suffix_to_DType
+from shepherd_core.data_models.content.firmware_datatype import FirmwareDType
+from shepherd_core.data_models.experiment.experiment import Experiment
+from shepherd_core.data_models.testbed.cape import TargetPort
+from shepherd_core.data_models.testbed.mcu import ProgrammerProtocol
+from shepherd_core.data_models.testbed.target import MCUPort
+from shepherd_core.data_models.testbed.testbed import Testbed
 
 
 class ProgrammingTask(ShpModel):

shepherd_core/data_models/task/testbed_tasks.py

@@ -1,18 +1,18 @@
 """Collection of tasks for all observers included in experiment."""
 
-from typing import List
+from typing import Annotated
 from typing import Optional
 
 from pydantic import Field
 from pydantic import validate_call
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.shepherd import ShpModel
-from ..experiment.experiment import Experiment
-from ..testbed.testbed import Testbed
+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
+from shepherd_core.data_models.testbed.testbed import Testbed
+
 from .observer_tasks import ObserverTasks
 
 
@@ -20,7 +20,7 @@ class TestbedTasks(ShpModel):
     """Collection of tasks for all observers included in experiment."""
 
     name: NameStr
-    observer_tasks: Annotated[List[ObserverTasks], Field(min_length=1, max_length=128)]
+    observer_tasks: Annotated[list[ObserverTasks], Field(min_length=1, max_length=128)]
 
     # POST PROCESS
     email_results: bool = False

shepherd_core/data_models/testbed/cape.py

@@ -3,17 +3,18 @@
 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
 
-from ...testbed_client import tb_client
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
+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.testbed_client import tb_client
 
 
 class TargetPort(str, Enum):
@@ -42,6 +43,6 @@ class Cape(ShpModel, title="Shepherd-Cape"):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         return values

shepherd_core/data_models/testbed/gpio.py

@@ -1,19 +1,20 @@
 """meta-data representation of a testbed-component (physical object)."""
 
 from enum import Enum
+from typing import Annotated
+from typing import Any
 from typing import Optional
 
 from pydantic import Field
 from pydantic import StringConstraints
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ...testbed_client import tb_client
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
+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.testbed_client import tb_client
 
 
 class Direction(str, Enum):
@@ -45,7 +46,7 @@ class GPIO(ShpModel, title="GPIO of Observer Node"):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         return values
 

shepherd_core/data_models/testbed/mcu.py

@@ -1,17 +1,18 @@
 """meta-data representation of a testbed-component (physical object)."""
 
 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
-from typing_extensions import Annotated
 
-from ...testbed_client import tb_client
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
+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.testbed_client import tb_client
 
 
 class ProgrammerProtocol(str, Enum):
@@ -45,6 +46,6 @@ class MCU(ShpModel, title="Microcontroller of the Target Node"):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         return values

shepherd_core/data_models/testbed/observer.py

@@ -1,20 +1,22 @@
 """meta-data representation of a testbed-component (physical object)."""
 
 from datetime import datetime
+from typing import Annotated
+from typing import Any
 from typing import Optional
 
 from pydantic import Field
 from pydantic import IPvAnyAddress
 from pydantic import StringConstraints
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ...testbed_client import tb_client
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
+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.testbed_client import tb_client
+
 from .cape import Cape
 from .cape import TargetPort
 from .target import Target
@@ -56,7 +58,7 @@ class Observer(ShpModel, title="Shepherd-Sheep"):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         return values
 

shepherd_core/data_models/testbed/target.py

@@ -1,18 +1,20 @@
 """meta-data representation of a testbed-component (physical object)."""
 
 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
-from typing_extensions import Annotated
 
-from ...testbed_client import tb_client
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
+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.testbed_client import tb_client
+
 from .mcu import MCU
 
 IdInt16 = Annotated[int, Field(ge=0, lt=2**16)]
@@ -45,7 +47,7 @@ class Target(ShpModel, title="Target Node (DuT)"):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
 
         # post correction

shepherd_core/data_models/testbed/testbed.py

@@ -2,21 +2,22 @@
 
 from datetime import timedelta
 from pathlib import Path
-from typing import List
+from typing import Annotated
+from typing import Any
 from typing import Optional
 
 from pydantic import Field
 from pydantic import HttpUrl
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 
-from ... import logger
-from ...testbed_client import tb_client
-from ..base.content import IdInt
-from ..base.content import NameStr
-from ..base.content import SafeStr
-from ..base.shepherd import ShpModel
+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
 
 
@@ -30,7 +31,7 @@ class Testbed(ShpModel):
 
     url: Optional[HttpUrl] = None
 
-    observers: Annotated[List[Observer], Field(min_length=1, max_length=128)]
+    observers: Annotated[list[Observer], Field(min_length=1, max_length=128)]
 
     shared_storage: bool = True
     data_on_server: Path
@@ -42,7 +43,7 @@ class Testbed(ShpModel):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         # allow instantiating an empty Testbed
         #   -> query the first (and only) entry of client
         if len(values) == 0:

shepherd_core/decoder_waveform/uart.py

@@ -28,7 +28,7 @@ from typing import Union
 
 import numpy as np
 
-from ..logger import logger
+from shepherd_core.logger import logger
 
 
 class Parity(str, Enum):
@@ -208,10 +208,10 @@ class Uart:
         if self.events_symbols is not None:
             return self.events_symbols
 
-        pos_df = None
-        symbol = 0
-        t_start = None
-        content = []
+        pos_df: Optional[int] = None
+        symbol: int = 0
+        t_start: Optional[float] = None
+        content: list = []
 
         for time, value, steps in self.events_sig:
             if steps > self.frame_length:

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
@@ -85,10 +86,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)):