shepherd-core 2025.5.3__py3-none-any.whl → 2025.6.2__py3-none-any.whl

shepherd_core/data_models/experiment/observer_features.py

@@ -13,9 +13,12 @@ from pydantic import model_validator
 from typing_extensions import Self
 from typing_extensions import deprecated
 
-from shepherd_core import logger
 from shepherd_core.data_models.base.shepherd import ShpModel
 from shepherd_core.data_models.testbed.gpio import GPIO
+from shepherd_core.logger import log
+
+# defaults (pre-init complex types)
+zero_duration = timedelta(seconds=0)
 
 
 class PowerTracing(ShpModel, title="Config for Power-Tracing"):
@@ -25,19 +28,27 @@ class PowerTracing(ShpModel, title="Config for Power-Tracing"):
     """
 
     intermediate_voltage: bool = False
-    # ⤷ for EMU: record storage capacitor instead of output (good for V_out = const)
-    #            this also includes current!
-
+    """
+    ⤷ for EMU: record storage capacitor instead of output (good for V_out = const)
+               this also includes current!
+    """
     # time
-    delay: timedelta = timedelta(seconds=0)
+    delay: timedelta = zero_duration
+    """start recording after experiment started"""
     duration: Optional[timedelta] = None  # till EOF
+    """duration of recording after delay starts the process.
+
+    default is None, recording till EOF"""
 
     # post-processing
     calculate_power: bool = False
-    samplerate: Annotated[int, Field(ge=10, le=100_000)] = 100_000  # down-sample
+    """ ⤷ reduce file-size by calculating power -> not implemented ATM"""
+    samplerate: Annotated[int, Field(ge=10, le=100_000)] = 100_000
+    """ ⤷ reduce file-size by down-sampling -> not implemented ATM"""
     discard_current: bool = False
+    """ ⤷ reduce file-size by omitting current -> not implemented ATM"""
     discard_voltage: bool = False
-    # ⤷ reduce file-size by omitting current / voltage
+    """ ⤷ reduce file-size by omitting voltage -> not implemented ATM"""
 
     @model_validator(mode="after")
     def post_validation(self) -> Self:
@@ -163,11 +174,12 @@ class GpioTracing(ShpModel, title="Config for GPIO-Tracing"):
     """
 
     # time
-    delay: timedelta = timedelta(seconds=0)
+    delay: timedelta = zero_duration
     duration: Optional[timedelta] = None  # till EOF
 
     # post-processing,
     uart_decode: bool = False
+    """Automatic decoding from gpio-trace not implemented ATM."""
     uart_pin: GPIO = GPIO(name="GPIO8")
     uart_baudrate: Annotated[int, Field(ge=2_400, le=1_152_000)] = 115_200
 
@@ -178,7 +190,7 @@ class GpioTracing(ShpModel, title="Config for GPIO-Tracing"):
         if self.duration and self.duration.total_seconds() < 0:
             raise ValueError("Duration can't be negative.")
         if self.uart_decode:
-            logger.error(
+            log.error(
                 "Feature GpioTracing.uart_decode reserved for future use. "
                 "Use UartLogging or manually decode serial with the provided waveform decoder."
             )
@@ -205,12 +217,14 @@ class GpioEvent(ShpModel, title="Config for a GPIO-Event"):
     """Configuration for a single GPIO-Event (Actuation)."""
 
     delay: PositiveFloat
-    # ⤷ from start_time
-    # ⤷ resolution 10 us (guaranteed, but finer steps are possible)
+    """ ⤷ from start_time
+
+    - resolution 10 us (guaranteed, but finer steps are possible)
+    """
     gpio: GPIO
     level: GpioLevel
     period: Annotated[float, Field(ge=10e-6)] = 1
-    # ⤷ time base of periodicity in s
+    """ ⤷ time base of periodicity in s"""
     count: Annotated[int, Field(ge=1, le=4096)] = 1
 
     @model_validator(mode="after")
@@ -233,6 +247,11 @@ class GpioActuation(ShpModel, title="Config for GPIO-Actuation"):
 
     events: Annotated[list[GpioEvent], Field(min_length=1, max_length=1024)]
 
+    @model_validator(mode="after")
+    def post_validation(self) -> Self:
+        msg = "not implemented ATM"
+        raise ValueError(msg)
+
     def get_gpios(self) -> set:
         return {_ev.gpio for _ev in self.events}
 
@@ -245,7 +264,7 @@ class SystemLogging(ShpModel, title="Config for System-Logging"):
     sheep: bool = True
     sys_util: bool = True
 
-    # TODO: remove lines below in 2026
+    # deprecated, TODO: remove lines below before public release
     dmesg: Annotated[bool, deprecated("for sheep v0.9.0+, use 'kernel' instead")] = True
     ptp: Annotated[bool, deprecated("for sheep v0.9.0+, use 'time_sync' instead")] = True
     shepherd: Annotated[bool, deprecated("for sheep v0.9.0+, use 'sheep' instead")] = True

shepherd_core/data_models/experiment/target_config.py

@@ -20,26 +20,36 @@ from .observer_features import GpioTracing
 from .observer_features import PowerTracing
 from .observer_features import UartLogging
 
+# defaults (pre-init complex types)
+vsrc_neutral = VirtualSourceConfig(name="neutral")
+
 
 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
-    # ⤷ will replace 'const uint16_t SHEPHERD_NODE_ID' in firmware
-    #   if no custom ID is provided, the original ID of target is used
+    """ ⤷ custom ID 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")
+    energy_env: EnergyEnvironment
+    """ input for the virtual source """
+    virtual_source: VirtualSourceConfig = vsrc_neutral
     target_delays: Optional[
         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
+    """ ⤷ individual starting times
+
+    - allows to use the same environment
+    - not implemented ATM
+    """
 
     firmware1: Firmware
+    """ ⤷ omitted FW gets set to neutral deep-sleep"""
     firmware2: Optional[Firmware] = None
-    # ⤷ omitted FW gets set to neutral deep-sleep
+    """ ⤷ omitted FW gets set to neutral deep-sleep"""
 
     power_tracing: Optional[PowerTracing] = None
     gpio_tracing: Optional[GpioTracing] = None

shepherd_core/data_models/task/__init__.py

@@ -3,6 +3,7 @@
 These models import externally from all other model-modules!
 """
 
+import pickle
 from pathlib import Path
 from typing import Optional
 from typing import Union
@@ -11,7 +12,7 @@ import yaml
 
 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 shepherd_core.logger import log
 
 from .emulation import Compression
 from .emulation import EmulationTask
@@ -44,7 +45,10 @@ def prepare_task(config: Union[ShpModel, Path, str], observer: Optional[str] = N
     if isinstance(config, str):
         config = Path(config)
 
-    if isinstance(config, Path):
+    if isinstance(config, Path) and config.exists() and config.suffix.lower() == ".pickle":
+        with config.resolve().open("rb") as shp_file:
+            shp_wrap = pickle.load(shp_file, fix_imports=True)  # noqa: S301
+    elif isinstance(config, Path) and config.exists() and config.suffix.lower() == ".yaml":
         with config.resolve().open() as shp_file:
             shp_dict = yaml.safe_load(shp_file)
         shp_wrap = Wrapper(**shp_dict)
@@ -59,12 +63,12 @@ def prepare_task(config: Union[ShpModel, Path, str], observer: Optional[str] = N
 
     if shp_wrap.datatype == TestbedTasks.__name__:
         if observer is None:
-            logger.debug(
+            log.debug(
                 "Task-Set contained TestbedTasks & no observer was provided -> will return TB-Tasks"
             )
             return shp_wrap
         tbt = TestbedTasks(**shp_wrap.parameters)
-        logger.debug("Loading Testbed-Tasks %s for %s", tbt.name, observer)
+        log.debug("Loading Testbed-Tasks %s for %s", tbt.name, observer)
         obt = tbt.get_observer_tasks(observer)
         if obt is None:
             msg = f"Observer '{observer}' is not in TestbedTask-Set"

shepherd_core/data_models/task/emulation.py

@@ -1,10 +1,12 @@
 """Configuration for the Observer in Emulation-Mode."""
 
 import copy
+from collections.abc import Set as AbstractSet
 from datetime import datetime
 from datetime import timedelta
 from enum import Enum
 from pathlib import Path
+from pathlib import PurePosixPath
 from typing import Annotated
 from typing import Optional
 from typing import Union
@@ -25,9 +27,12 @@ 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.experiment.observer_features import UartLogging
+from shepherd_core.data_models.experiment.target_config import vsrc_neutral
 from shepherd_core.data_models.testbed import Testbed
 from shepherd_core.data_models.testbed.cape import TargetPort
-from shepherd_core.logger import logger
+from shepherd_core.logger import log
+
+from .helper_paths import path_posix
 
 
 class Compression(str, Enum):
@@ -49,46 +54,55 @@ class EmulationTask(ShpModel):
 
     # General config
     input_path: Path
-    # ⤷ hdf5 file containing harvesting data
+    """ ⤷ hdf5 file containing harvesting data"""
     output_path: Optional[Path] = None
-    # ⤷ dir- or file-path for storing the recorded data:
-    #   - providing a directory -> file is named emu_timestamp.h5
-    #   - for a complete path the filename is not changed except it exists and
-    #     overwrite is disabled -> emu#num.h5
-    # TODO: should the output-path be mandatory?
+    """ ⤷ dir- or file-path for storing the recorded data:
+
+    - providing a directory -> file is named emu_timestamp.h5
+    - for a complete path the filename is not changed except it exists and
+      overwrite is disabled -> emu#num.h5
+    TODO: should the output-path be mandatory?
+    """
     force_overwrite: bool = False
-    # ⤷ Overwrite existing file
+    """ ⤷ Overwrite existing file"""
     output_compression: Optional[Compression] = Compression.default
-    # ⤷ should be lzf, 1 (gzip level 1) or None (order of recommendation)
+    """ ⤷ should be lzf, 1 (gzip level 1) 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
+    """ ⤷ Duration of recording in seconds, None = till EOF"""
     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"""
 
     enable_io: bool = True
     # TODO: add direction of pins! also it seems error-prone when only setting _tracing
-    # ⤷ Switch the GPIO level converter to targets on/off
-    #   pre-req for sampling gpio / uart,
+    """ ⤷ Switch the GPIO level converter to targets on/off
+
+    pre-req for sampling gpio / uart,
+    """
     io_port: TargetPort = TargetPort.A
-    # ⤷ Either Port A or B that gets connected to IO
+    """ ⤷ Either Port A or B that gets connected to IO"""
     pwr_port: TargetPort = TargetPort.A
-    # ⤷ chosen port will be current-monitored (main, connected to virtual Source),
-    #   the other port is aux
-    voltage_aux: Union[Annotated[float, Field(ge=0, le=4.5)], str] = 0
-    # ⤷ aux_voltage options:
-    #   - 0-4.5 for specific const Voltage (0 V = disabled),
-    #   - "buffer" will output intermediate voltage (storage cap of vsource),
-    #   - "main" will mirror main target voltage
+    """ ⤷ selected port will be current-monitored
 
+    - main channel is nnected to virtual Source
+    - the other port is aux
+    """
+    voltage_aux: Union[Annotated[float, Field(ge=0, le=4.5)], str] = 0
+    """ ⤷ aux_voltage options
+    - 0-4.5 for specific const Voltage (0 V = disabled),
+    - "buffer" will output intermediate voltage (storage cap of vsource),
+    - "main" will mirror main target voltage
+    """
     # sub-elements, could be partly moved to emulation
-    virtual_source: VirtualSourceConfig = VirtualSourceConfig(name="neutral")
-    # ⤷ Use the desired setting for the virtual source,
-    #   provide parameters or name like BQ25570
+    virtual_source: VirtualSourceConfig = vsrc_neutral
+    """ ⤷ Use the desired setting for the virtual source,
+
+    provide parameters or name like BQ25570
+    """
 
     power_tracing: Optional[PowerTracing] = PowerTracing()
     gpio_tracing: Optional[GpioTracing] = GpioTracing()
@@ -97,7 +111,10 @@ class EmulationTask(ShpModel):
     sys_logging: Optional[SystemLogging] = SystemLogging()
 
     verbose: Annotated[int, Field(ge=0, le=4)] = 2
-    # ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug, TODO: just bool now, systemwide
+    """ ⤷ 0=Errors, 1=Warnings, 2=Info, 3=Debug,
+
+    TODO: just bool now, systemwide
+    """
 
     @model_validator(mode="before")
     @classmethod
@@ -136,9 +153,9 @@ class EmulationTask(ShpModel):
             _io is not None for _io in (self.gpio_actuation, self.gpio_tracing, self.uart_logging)
         )
         if self.enable_io and not io_requested:
-            logger.warning("Target IO enabled, but no feature requested IO")
+            log.warning("Target IO enabled, but no feature requested IO")
         if not self.enable_io and io_requested:
-            logger.warning("Target IO not enabled, but a feature requested IO")
+            log.warning("Target IO not enabled, but a feature requested IO")
         return self
 
     @classmethod
@@ -152,8 +169,8 @@ class EmulationTask(ShpModel):
         )
 
         return cls(
-            input_path=tgt_cfg.energy_env.data_path,
-            output_path=root_path / f"emu_{obs.name}.h5",
+            input_path=path_posix(tgt_cfg.energy_env.data_path),
+            output_path=path_posix(root_path / f"emu_{obs.name}.h5"),
             time_start=copy.copy(xp.time_start),
             duration=xp.duration,
             enable_io=io_requested,
@@ -167,6 +184,11 @@ class EmulationTask(ShpModel):
             sys_logging=xp.sys_logging,
         )
 
+    def is_contained(self, paths: AbstractSet[PurePosixPath]) -> bool:
+        all_ok = any(self.input_path.is_relative_to(path) for path in paths)
+        all_ok &= any(self.output_path.is_relative_to(path) for path in paths)
+        return all_ok
+
 
 # TODO: herdConfig
 #  - store if path is remote (read & write)

shepherd_core/data_models/task/firmware_mod.py

@@ -1,7 +1,8 @@
 """Config for Task that adds the custom ID to the firmware & stores it into a file."""
 
-import copy
+from collections.abc import Set as AbstractSet
 from pathlib import Path
+from pathlib import PurePosixPath
 from typing import Annotated
 from typing import Optional
 from typing import TypedDict
@@ -22,7 +23,9 @@ 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
+from shepherd_core.logger import log
+
+from .helper_paths import path_posix
 
 
 class FirmwareModTask(ShpModel):
@@ -34,7 +37,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:
@@ -42,7 +45,7 @@ class FirmwareModTask(ShpModel):
             FirmwareDType.base64_hex,
             FirmwareDType.path_hex,
         }:
-            logger.warning("Firmware is scheduled to get custom-ID but is not in elf-format")
+            log.warning("Firmware is scheduled to get custom-ID but is not in elf-format")
         return self
 
     @classmethod
@@ -68,10 +71,10 @@ class FirmwareModTask(ShpModel):
             fw_id = obs.get_target(tgt_id).testbed_id
 
         return cls(
-            data=fw.data,
+            data=path_posix(fw.data) if isinstance(fw.data, Path) else fw.data,
             data_type=fw.data_type,
             custom_id=fw_id,
-            firmware_file=copy.copy(fw_path),
+            firmware_file=path_posix(fw_path),
         )
 
     @classmethod
@@ -90,3 +93,9 @@ class FirmwareModTask(ShpModel):
             path_new: Path = path / fw.name
             kwargs["firmware_file"] = path_new.with_suffix(".hex")
         return cls(**kwargs)
+
+    def is_contained(self, paths: AbstractSet[PurePosixPath]) -> bool:
+        all_ok = any(self.firmware_file.is_relative_to(path) for path in paths)
+        if isinstance(self.data, Path):
+            all_ok = any(self.data.is_relative_to(path) for path in paths)
+        return all_ok

shepherd_core/data_models/task/harvest.py

@@ -1,8 +1,10 @@
 """Config for the Observer in Harvest-Mode to record IV data from a harvesting-source."""
 
+from collections.abc import Set as AbstractSet
 from datetime import datetime
 from datetime import timedelta
 from pathlib import Path
+from pathlib import PurePosixPath
 from typing import Annotated
 from typing import Optional
 
@@ -25,34 +27,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 EOFSys
+    """ ⤷ 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
 
@@ -83,3 +86,6 @@ class HarvestTask(ShpModel):
         if self.duration and self.duration.total_seconds() < 0:
             raise ValueError("Task-Duration can't be negative.")
         return self
+
+    def is_contained(self, paths: AbstractSet[PurePosixPath]) -> bool:
+        return any(self.output_path.is_relative_to(path) for path in paths)

shepherd_core/data_models/task/helper_paths.py

@@ -0,0 +1,15 @@
+r"""Helper FN to avoid unwanted behavior.
+
+On windows Path("\xyz") gets transformed to "/xyz", but not on linux.
+When sending an experiment via fastapi, this bug gets triggered.
+"""
+
+from pathlib import Path
+
+
+def path_posix(path: Path) -> Path:
+    r"""Help Linux to get from "\xyz" to "/xyz".
+
+    This isn't a problem on windows and gets triggered when sending XP via fastapi.
+    """
+    return Path(path.as_posix().replace("\\", "/"))

shepherd_core/data_models/task/observer_tasks.py

@@ -1,8 +1,9 @@
 """Collection of tasks for selected observer included in experiment."""
 
+from collections.abc import Set as AbstractSet
 from datetime import datetime
-from datetime import timedelta
 from pathlib import Path
+from pathlib import PurePosixPath
 from typing import Annotated
 from typing import Optional
 
@@ -18,6 +19,7 @@ from shepherd_core.data_models.testbed.testbed import Testbed
 
 from .emulation import EmulationTask
 from .firmware_mod import FirmwareModTask
+from .helper_paths import path_posix
 from .programming import ProgrammingTask
 
 
@@ -25,12 +27,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
+    time_prep: Optional[datetime] = None  # TODO: currently not used
     root_path: Path
-    abort_on_error: Annotated[bool, deprecated("has no effect")] = False
 
     # fw mod, store as hex-file and program
     fw1_mod: Optional[FirmwareModTask] = None
@@ -41,6 +41,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
@@ -53,25 +57,14 @@ class ObserverTasks(ShpModel):
         if not tb.shared_storage:
             raise ValueError("Implementation currently relies on shared storage!")
 
-        t_start = (
-            xp.time_start
-            if isinstance(xp.time_start, datetime)
-            else datetime.now().astimezone() + timedelta(minutes=3)
-        )  # TODO: this is messed up, just a hotfix
-
         obs = tb.get_observer(tgt_id)
-        xp_dir = "experiments/" + xp.name + "_" + t_start.strftime("%Y-%m-%d_%H-%M-%S")
-        root_path = tb.data_on_observer / xp_dir
-        # TODO: Paths should be "friendlier"
-        #    - replace whitespace with "_" and remove non-alphanum?
-
+        root_path = tb.data_on_observer / "experiments" / xp.folder_name()
         fw_paths = [root_path / f"fw{_i}_{obs.name}.hex" for _i in [1, 2]]
 
         return cls(
             observer=obs.name,
-            owner_id=xp.owner_id,
-            time_prep=t_start - tb.prep_duration,
-            root_path=root_path,
+            # time_prep=
+            root_path=path_posix(root_path),
             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]),
@@ -99,3 +92,12 @@ class ObserverTasks(ShpModel):
                 raise ValueError("Emu-Task should have a valid output-path")
             values[self.observer] = self.emulation.output_path
         return values
+
+    def is_contained(self, paths: AbstractSet[PurePosixPath]) -> bool:
+        all_ok = any(self.root_path.is_relative_to(path) for path in paths)
+        all_ok &= self.fw1_mod.is_contained(paths)
+        all_ok &= self.fw2_mod.is_contained(paths)
+        all_ok &= self.fw1_prog.is_contained(paths)
+        all_ok &= self.fw2_prog.is_contained(paths)
+        all_ok &= self.emulation.is_contained(paths)
+        return all_ok

shepherd_core/data_models/task/programming.py

@@ -1,7 +1,8 @@
 """Config for a Task programming the selected target."""
 
-import copy
+from collections.abc import Set as AbstractSet
 from pathlib import Path
+from pathlib import PurePosixPath
 from typing import Annotated
 from typing import Optional
 
@@ -21,6 +22,8 @@ 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
 
+from .helper_paths import path_posix
+
 
 class ProgrammingTask(ShpModel):
     """Config for a Task programming the selected target."""
@@ -29,7 +32,7 @@ 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
@@ -38,7 +41,7 @@ class ProgrammingTask(ShpModel):
     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:
@@ -66,7 +69,7 @@ class ProgrammingTask(ShpModel):
             return None
 
         return cls(
-            firmware_file=copy.copy(fw_path),
+            firmware_file=path_posix(fw_path),
             target_port=obs.get_target_port(tgt_id),
             mcu_port=mcu_port,
             mcu_type=fw.mcu.name,
@@ -74,3 +77,6 @@ class ProgrammingTask(ShpModel):
             datarate=fw.mcu.prog_datarate,
             protocol=fw.mcu.prog_protocol,
         )
+
+    def is_contained(self, paths: AbstractSet[PurePosixPath]) -> bool:
+        return any(self.firmware_file.is_relative_to(path) for path in paths)