shepherd-core 2023.8.6__py3-none-any.whl → 2023.8.8__py3-none-any.whl

shepherd_core/data_models/testbed/testbed.py

@@ -1,10 +1,12 @@
 from datetime import timedelta
 from pathlib import Path
+from typing import List
 from typing import Optional
 
+from pydantic import Field
 from pydantic import HttpUrl
-from pydantic import conlist
-from pydantic import root_validator
+from pydantic import model_validator
+from typing_extensions import Annotated
 
 from ...testbed_client import tb_client
 from ..base.content import IdInt
@@ -22,9 +24,9 @@ class Testbed(ShpModel):
     description: SafeStr
     comment: Optional[SafeStr] = None
 
-    url: Optional[HttpUrl]
+    url: Optional[HttpUrl] = None
 
-    observers: conlist(item_type=Observer, min_items=1, max_items=64)
+    observers: Annotated[List[Observer], Field(min_length=1, max_length=64)]
 
     shared_storage: bool = True
     data_on_server: Path
@@ -34,20 +36,21 @@ class Testbed(ShpModel):
     prep_duration: timedelta = timedelta(minutes=5)
     # TODO: one BBone is currently time-keeper
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
+    @classmethod
     def query_database(cls, values: dict) -> dict:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         return values
 
-    @root_validator(pre=False)
-    def post_validation(cls, values: dict) -> dict:
+    @model_validator(mode="after")
+    def post_validation(self):
         observers = []
         ips = []
         macs = []
         capes = []
         targets = []
         eth_ports = []
-        for _obs in values.get("observers"):
+        for _obs in self.observers:
             observers.append(_obs.id)
             ips.append(_obs.ip)
             macs.append(_obs.mac)
@@ -70,11 +73,11 @@ class Testbed(ShpModel):
             raise ValueError("Target used more than once in Testbed")
         if len(eth_ports) > len(set(eth_ports)):
             raise ValueError("Observers-Ethernet-Port used more than once in Testbed")
-        if values.get("prep_duration") and values["prep_duration"].total_seconds() < 0:
+        if self.prep_duration.total_seconds() < 0:
             raise ValueError("Task-Duration can't be negative.")
-        if not values.get("shared_storage"):
+        if not self.shared_storage:
             raise ValueError("Only shared-storage-option is implemented")
-        return values
+        return self
 
     def get_observer(self, target_id: int) -> Observer:
         for _observer in self.observers:

shepherd_core/fw_tools/converter.py

@@ -5,7 +5,7 @@ from pathlib import Path
 from typing import Union
 
 import zstandard as zstd
-from pydantic import validate_arguments
+from pydantic import validate_call
 
 from ..data_models.content.firmware_datatype import FirmwareDType
 from .converter_elf import elf_to_hex
@@ -13,7 +13,7 @@ from .validation import is_elf
 from .validation import is_hex
 
 
-@validate_arguments
+@validate_call
 def firmware_to_hex(file_path: Path) -> Path:
     """Generic converter that handles ELF & HEX"""
     if not file_path.is_file():
@@ -28,7 +28,7 @@ def firmware_to_hex(file_path: Path) -> Path:
         )
 
 
-@validate_arguments
+@validate_call
 def file_to_base64(file_path: Path) -> str:
     """Compress and encode content of file
     - base64 adds ~33 % overhead
@@ -42,7 +42,7 @@ def file_to_base64(file_path: Path) -> str:
     return base64.b64encode(file_cmpress).decode("ascii")
 
 
-@validate_arguments
+@validate_call
 def base64_to_file(content: str, file_path: Path) -> None:
     """DeCompress and decode Content of file
     - base64 adds ~33 % overhead
@@ -54,7 +54,7 @@ def base64_to_file(content: str, file_path: Path) -> None:
         file.write(file_content)
 
 
-@validate_arguments
+@validate_call
 def file_to_hash(file_path: Path) -> str:
     if not file_path.is_file():
         raise ValueError("Fn needs an existing file as input")
@@ -63,14 +63,14 @@ def file_to_hash(file_path: Path) -> str:
     return hashlib.sha3_224(file_content).hexdigest()
 
 
-@validate_arguments
+@validate_call
 def base64_to_hash(content: str) -> str:
     file_cmpress = base64.b64decode(content)
     file_content = zstd.ZstdDecompressor().decompress(file_cmpress)
     return hashlib.sha3_224(file_content).hexdigest()
 
 
-@validate_arguments
+@validate_call
 def extract_firmware(
     data: Union[str, Path], data_type: FirmwareDType, file_path: Path
 ) -> Path:

shepherd_core/fw_tools/converter_elf.py

@@ -2,12 +2,12 @@ import subprocess  # noqa: S404
 from pathlib import Path
 from typing import Optional
 
-from pydantic import validate_arguments
+from pydantic import validate_call
 
 # extra src-file necessary to prevent circular import
 
 
-@validate_arguments
+@validate_call
 def elf_to_hex(file_elf: Path, file_hex: Optional[Path] = None) -> Path:
     if not file_elf.is_file():
         raise ValueError("Fn needs an existing file as input")

shepherd_core/fw_tools/patcher.py

@@ -1,8 +1,9 @@
 from pathlib import Path
 from typing import Optional
 
-from pydantic import conint
-from pydantic import validate_arguments
+from pydantic import Field
+from pydantic import validate_call
+from typing_extensions import Annotated
 
 from ..commons import uid_len_default
 from ..commons import uid_str_default
@@ -21,7 +22,7 @@ except ImportError as e:
     )
 
 
-@validate_arguments
+@validate_call
 def find_symbol(file_elf: Path, symbol: str) -> bool:
     if symbol is None or not is_elf(file_elf):
         return False
@@ -44,7 +45,7 @@ def find_symbol(file_elf: Path, symbol: str) -> bool:
     return True
 
 
-@validate_arguments
+@validate_call
 def read_symbol(
     file_elf: Path, symbol: str, length: int = uid_len_default
 ) -> Optional[int]:
@@ -76,11 +77,11 @@ def read_arch(file_elf: Path) -> Optional[str]:
     return None
 
 
-@validate_arguments
+@validate_call
 def modify_symbol_value(
     file_elf: Path,
     symbol: str,
-    value: conint(ge=0, lt=2 ** (8 * uid_len_default)),
+    value: Annotated[int, Field(ge=0, lt=2 ** (8 * uid_len_default))],
     overwrite: bool = False,
 ) -> Optional[Path]:
     """replaces value of symbol in ELF-File, hardcoded for uint16_t (2 byte)

shepherd_core/fw_tools/validation.py

@@ -7,7 +7,7 @@ from pathlib import Path
 
 from intelhex import IntelHex
 from intelhex import IntelHexError
-from pydantic import validate_arguments
+from pydantic import validate_call
 
 from ..data_models.content.firmware_datatype import FirmwareDType
 from ..logger import logger
@@ -26,7 +26,7 @@ except ImportError as e:
     )
 
 
-@validate_arguments
+@validate_call
 def is_hex(file: Path):
     try:
         _ = IntelHex(file.as_posix())
@@ -80,7 +80,7 @@ def is_hex_nrf52(file: Path) -> bool:
 #  https://github.com/eliben/pyelftools/wiki/User's-guide
 
 
-@validate_arguments
+@validate_call
 def is_elf(file: Path) -> bool:
     if not elf_support:
         raise RuntimeError(elf_error_text)

shepherd_core/inventory/__init__.py

@@ -4,8 +4,10 @@
     - hardware-config
 """
 from pathlib import Path
+from typing import List
 
-from pydantic.types import conlist
+from pydantic import Field
+from typing_extensions import Annotated
 
 from ..data_models import ShpModel
 from .python import PythonInventory
@@ -27,15 +29,21 @@ class Inventory(PythonInventory, SystemInventory, TargetInventory):
     @classmethod
     def collect(cls):
         # one by one for more precise error messages
-        pid = PythonInventory.collect().dict(exclude_unset=True, exclude_defaults=True)
-        sid = SystemInventory.collect().dict(exclude_unset=True, exclude_defaults=True)
-        tid = TargetInventory.collect().dict(exclude_unset=True, exclude_defaults=True)
+        pid = PythonInventory.collect().model_dump(
+            exclude_unset=True, exclude_defaults=True
+        )
+        sid = SystemInventory.collect().model_dump(
+            exclude_unset=True, exclude_defaults=True
+        )
+        tid = TargetInventory.collect().model_dump(
+            exclude_unset=True, exclude_defaults=True
+        )
         model = {**pid, **sid, **tid}
         return cls(**model)
 
 
 class InventoryList(ShpModel):
-    items: conlist(item_type=Inventory, min_items=1)
+    elements: Annotated[List[Inventory], Field(min_length=1)]
 
     def to_csv(self, path: Path) -> None:
         """TODO: pretty messed up (raw lists and dicts for sub-elements)
@@ -45,8 +53,8 @@ class InventoryList(ShpModel):
         if path.is_dir():
             path = path / "inventory.yaml"
         with open(path.as_posix(), "w") as fd:
-            fd.write(", ".join(self.items[0].dict().keys()) + "\r\n")
-            for item in self.items:
-                content = list(item.dict().values())
+            fd.write(", ".join(self.elements[0].model_dump().keys()) + "\r\n")
+            for item in self.elements:
+                content = list(item.model_dump().values())
                 content = ["" if value is None else str(value) for value in content]
                 fd.write(", ".join(content) + "\r\n")

shepherd_core/inventory/python.py

@@ -3,11 +3,13 @@ from contextlib import suppress
 from importlib import import_module
 from typing import Optional
 
+from pydantic import ConfigDict
+
 from ..data_models import ShpModel
 
 
 class PythonInventory(ShpModel):
-    # versions
+    # program versions
     python: Optional[str] = None
     numpy: Optional[str] = None
     h5py: Optional[str] = None
@@ -16,8 +18,7 @@ class PythonInventory(ShpModel):
     shepherd_core: Optional[str] = None
     shepherd_sheep: Optional[str] = None
 
-    class Config:
-        min_anystr_length = 0
+    model_config = ConfigDict(str_min_length=0)
 
     @classmethod
     def collect(cls):

shepherd_core/inventory/system.py

@@ -13,6 +13,7 @@ try:
 except ImportError:
     psutil_support = False
 
+from pydantic import ConfigDict
 from pydantic.types import PositiveInt
 
 from ..data_models import ShpModel
@@ -20,7 +21,7 @@ from ..data_models import ShpModel
 
 class SystemInventory(ShpModel):
     uptime: PositiveInt
-    # seconds
+    # ⤷ seconds
 
     system: str
     release: str
@@ -34,12 +35,11 @@ class SystemInventory(ShpModel):
     hostname: str
 
     interfaces: dict = {}
-    # tuple with
+    # ⤷ tuple with
     #   ip IPvAnyAddress
     #   mac MACStr
 
-    class Config:
-        min_anystr_length = 0
+    model_config = ConfigDict(str_min_length=0)
 
     @classmethod
     def collect(cls):
@@ -61,7 +61,7 @@ class SystemInventory(ShpModel):
             )
 
         model_dict = {
-            "uptime": uptime,
+            "uptime": round(uptime),
             "system": platform.system(),
             "release": platform.release(),
             "version": platform.version(),

shepherd_core/inventory/target.py

@@ -1,16 +1,16 @@
+from typing import List
 from typing import Optional
 
-from pydantic import conlist
+from pydantic import ConfigDict
 
 from ..data_models import ShpModel
 
 
 class TargetInventory(ShpModel):
     cape: Optional[str] = None
-    targets: conlist(item_type=str) = []
+    targets: List[str] = []
 
-    class Config:
-        min_anystr_length = 0
+    model_config = ConfigDict(str_min_length=0)
 
     @classmethod
     def collect(cls):

shepherd_core/reader.py

@@ -17,7 +17,7 @@ from typing import Union
 import h5py
 import numpy as np
 import yaml
-from pydantic import validate_arguments
+from pydantic import validate_call
 from tqdm import trange
 
 from .commons import samplerate_sps_default
@@ -45,7 +45,7 @@ class BaseReader:
         "emulator": [EnergyDType.ivsample],
     }
 
-    @validate_arguments
+    @validate_call
     def __init__(self, file_path: Optional[Path], verbose: Optional[bool] = True):
         if not hasattr(self, "file_path"):
             self.file_path: Optional[Path] = None
@@ -99,7 +99,7 @@ class BaseReader:
 
         # retrieve cal-data
         if not hasattr(self, "_cal"):
-            cal_dict = CalibrationSeries().dict()
+            cal_dict = CalibrationSeries().model_dump()
             for ds, param in product(
                 ["current", "voltage", "time"], ["gain", "offset"]
             ):

shepherd_core/testbed_client/client.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from typing import Optional
 from typing import Union
 
-from pydantic import validate_arguments
+from pydantic import validate_call
 
 from ..commons import testbed_server_default
 from ..data_models.base.shepherd import ShpModel
@@ -35,7 +35,7 @@ class TestbedClient:
     def __del__(self):
         TestbedClient._instance = None
 
-    @validate_arguments
+    @validate_call
     def connect(
         self, server: Optional[str] = None, token: Union[str, Path, None] = None
     ) -> bool:
@@ -65,10 +65,12 @@ class TestbedClient:
     def insert(self, data: ShpModel) -> bool:
         wrap = Wrapper(
             datatype=type(data).__name__,
-            parameters=data.dict(),
+            parameters=data.model_dump(),
         )
         if self._connected:
-            r = self._req.post(self._server + "/add", data=wrap.json(), timeout=2)
+            r = self._req.post(
+                self._server + "/add", data=wrap.model_dump_json(), timeout=2
+            )
             r.raise_for_status()
         else:
             self._fixtures.insert_model(wrap)

shepherd_core/testbed_client/user_model.py

@@ -6,9 +6,10 @@ from pydantic import EmailStr
 from pydantic import Field
 from pydantic import SecretBytes
 from pydantic import SecretStr
-from pydantic import constr
-from pydantic import root_validator
-from pydantic import validate_arguments
+from pydantic import StringConstraints
+from pydantic import model_validator
+from pydantic import validate_call
+from typing_extensions import Annotated
 
 from ..data_models.base.content import IdInt
 from ..data_models.base.content import NameStr
@@ -17,8 +18,10 @@ from ..data_models.base.content import id_default
 from ..data_models.base.shepherd import ShpModel
 
 
-@validate_arguments
-def hash_password(pw: constr(min_length=20, max_length=100)) -> bytes:
+@validate_call
+def hash_password(
+    pw: Annotated[str, StringConstraints(min_length=20, max_length=100)]
+) -> bytes:
     # TODO: add salt of testbed -> this fn should be part of Testbed-Object
     # NOTE: 1M Iterations need 25s on beaglebone
     return pbkdf2_hmac(
@@ -46,19 +49,20 @@ class User(ShpModel):
     email: EmailStr
 
     pw_hash: Optional[SecretBytes] = None
-    # ⤷ = hash_password("this_will_become_a_salted_slow_hash") -> slowed BBB down
+    # ⤷ was hash_password("this_will_become_a_salted_slow_hash") -> slowed BBB down
     # ⤷ TODO (min_length=128, max_length=512)
 
     token: SecretStr
     # ⤷ TODO (min_length=128), request with: token.get_secret_value()
+    active: bool = False
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
+    @classmethod
     def query_database(cls, values: dict) -> dict:
         # TODO:
-        return values
 
-    @root_validator(pre=False)
-    def post_validation(cls, values: dict) -> dict:
+        # post correction
         if values.get("token") is None:
             values["token"] = "shepherd_token_" + secrets.token_urlsafe(nbytes=128)
+
         return values

shepherd_core/writer.py

@@ -14,7 +14,7 @@ from typing import Union
 import h5py
 import numpy as np
 import yaml
-from pydantic import validate_arguments
+from pydantic import validate_call
 from yaml import SafeDumper
 
 from .commons import samplerate_sps_default
@@ -90,7 +90,7 @@ class BaseWriter(BaseReader):
 
     _chunk_shape: tuple = (BaseReader.samples_per_buffer,)
 
-    @validate_arguments
+    @validate_call
     def __init__(
         self,
         file_path: Path,

{shepherd_core-2023.8.6.dist-info → shepherd_core-2023.8.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd-core
-Version: 2023.8.6
+Version: 2023.8.8
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Home-page: https://pypi.org/project/shepherd-core/
 Author: Ingmar Splitt, Kai Geissdoerfer
@@ -34,7 +34,7 @@ Requires-Dist: h5py
 Requires-Dist: numpy
 Requires-Dist: pyYAML
 Requires-Dist: chromalog
-Requires-Dist: pydantic[email] <2.0.0
+Requires-Dist: pydantic[email] >2.0.0
 Requires-Dist: tqdm
 Requires-Dist: scipy
 Requires-Dist: intelhex
@@ -100,6 +100,13 @@ The Library is available via PyPI and can be installed with
   pip install shepherd-data
 ```
 
+for bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here `dev`-branch):
+
+```Shell
+pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_core -U
+```
+
+
 If you are working with ``.elf``-files (embedding into experiments) you make "objcopy" accessible to python. In Ubuntu, you can either install ``build-essential`` or ``binutils-$ARCH`` with arch being ``msp430`` or ``arm-none-eabi`` for the nRF52.
 
 ```shell