plesty-lib 0.2.6__tar.gz → 0.2.8__tar.gz

plesty_lib-0.2.8/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.2.8 — 2026-07-07
+
+- Add `plesty.lib.test.experiment_pipeline.ExperimentPipeline` (lib#14) — the experiment-tier counterpart of `DevicePipeline`: five hardware-free contract gates (public `Experiment` subclass instantiable without devices; deterministic `build_plan()` by content hash; every `Step.op` resolves via the framework's own plan validation; `Plan.save`/`load` round-trip preserves the hash; `setup`/`teardown` overrides are async) plus a one-shot `run_mock_pipeline()`. Experiment HUB modules expose one pytest function per gate; SDK gate E1 (plesty-sdk#15) verifies their presence and passage, mirroring gate d1.
+
+- `Experiment.run` now validates the plan before anything executes: every `Step.op` must name an existing public callable on the experiment and may not be a reserved lifecycle method (`build_plan`, `run`, `setup`, `teardown`) — violations raise the new `InvalidOperationError` listing all offending steps, before any device is touched or journal written. The class docstring now spells out the override contract (`build_plan` required; `setup`/`teardown` optional extensions).
+
+- Add `plesty.lib.experiment` — async `Experiment` ABC with atomic scheduling, status journaling and checkpoint/resume (first step toward lib#3): `Plan`/`Step` define the frozen measurement schedule (content-hashed so a resumed run refuses a changed schedule); `Journal` is a crash-safe append-only JSONL status log replayed to derive run state and the completed-step set; `Experiment` provides the async `setup()`/`run()`/`teardown()` lifecycle with per-step retries, clean handling of cancel/error, and resume via `run(resume=<run_id>)` that skips journaled-complete steps.
+- Add `plesty.lib.data.io` (first step toward lib#4): `save_result`/`load_result` persist measurement results crash-safely — blobs stay in their original raw format (`.npy` for `PlestyArray`, native encoding for image bytes) described by a JSON metadata document (Plesty meta, provenance, timestamp) with a reference link to the blob; `convert_to_hdf5` optionally packs such documents into a unified HDF5 archive (requires the optional `h5py` dependency).
+
+- Surface `op_schema`-registered functions through the `describe` endpoint (lib#13): `DeviceTCPIPServer._describe` now merges the `FunctionSystem._functions` registry into the method listing. These ops are installed as instance attributes and were therefore invisible to the MRO-based `@expose_to_api` walk, so remote clients could not discover or bind them (though they were already callable via the generic `call` path). `DeviceTCPIPClient` now binds them as local proxy methods.
+- Migrate licensing to the [REUSE](https://reuse.software/) standard (lib#12, follows plesty-sdk#10): Python sources carry inline SPDX headers with a collective `SPDX-FileCopyrightText` (Plesty Development Team) plus a `SPDX-FileContributor` per author; non-code files are covered by a central `REUSE.toml`. The root `LICENSE` is kept for forge (GitLab) license detection; `COPYING`, `spdx.tmpl` and the unused `GPL-3.0-or-later.txt` were removed. `plesty check` Gate 9 now verifies `reuse lint` and authorship currency.
+
+## 0.2.7 — 2026-07-02
+
+- Add `EnvSettings` in `plesty.lib.utils.settings`: a dependency-free helper that loads environment variables (optionally seeded from a `.env` file, process env taking precedence) with typed `get`/`require` access. By default `load()` also registers parsed `.env` values into `os.environ` without overriding existing ones (dotenv-style; pass `export=False` to disable). Generic by design — device modules choose their own variable names and defaults for credential/connection info (lib#11, companion to plesty-sdk#13)
+- Expose `identity`, `check_errors`, `check_operatability`, `reset`, `clear` to the remote API via `@expose_to_api` on `BaseDeviceSyncModel`
+- Fix `TCPIPTrafficManager._send_command`: pass actual `timeout` to `receive_one` instead of the boolean flag `timeout_overrided` (lib#9)
+- Fix `sock_smart_read` JSON framing: exit the read loop when `terminator in msg` (consistent with line-data branch) and return `msg.rstrip()` — the previous `rstrip(terminator)` only stripped `\n`, leaving `\r` and causing the brace check to fail for `\r\n`-terminated responses (e.g. AMC300) (lib#9)
+- Fix `DeviceTCPIPClient._send`: drain stale ZMQ reply after `recv()` timeout (100 ms window) so the client remains usable on the next call (lib#10)
+
+## 2026-06-25
+
+- Add `FuncMeta` and `SCPISolver.solve_func` for schema-driven operation dispatch
+- Fix mypy type annotations across all public modules
+- Migrate CI pipeline to `plesty-standard-ci@exp`

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: plesty-lib
-Version: 0.2.6
+Version: 0.2.8
 Summary: A library for the Plesty ecosystem.
+Author: Plesty Development Team
 Author-email: Yunshuang Yuan <yunshuang.yuan@fkp.uni-hannover.de>
 Maintainer-email: Plesty Development Team <yunshuang.yuan@fkp.uni-hannover.de>
 License-Expression: LGPL-3.0-or-later
-License-File: COPYING
 License-File: LICENSE
+License-File: LICENSES/LGPL-3.0-or-later.txt
 Requires-Python: >=3.12
 Requires-Dist: numpy>=1.24
 Requires-Dist: pyserial>=3.5

plesty_lib-0.2.8/REUSE.toml

@@ -0,0 +1,21 @@
+version = 1
+
+# Non-code files (docs, images, configs, the root LICENSE, lockfiles) are
+# licensed here; Python sources carry their own inline SPDX headers. Copyright
+# is held collectively by the Plesty Development Team, with contributors listed
+# below. `reuse lint` (Gate 9 of `plesty check`) verifies full coverage.
+
+[[annotations]]
+path = [
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md",
+    "pyproject.toml",
+    "uv.lock",
+    ".gitignore",
+    ".gitlab-ci.yml",
+    "docs/**",
+]
+SPDX-FileCopyrightText = "2026 Plesty Development Team"
+SPDX-FileContributor = "Yunshuang Yuan"
+SPDX-License-Identifier = "LGPL-3.0-or-later"

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/docs/api_reference.md

@@ -11,6 +11,6 @@ Entry page for [Full API](reference/index) documentation.
 | [`plesty.lib.solver`](reference/plesty/lib/solver/index) | Command and operation solvers |
 | [`plesty.lib.service`](reference/plesty/lib/service/index) | TCP/IP server/client and service builders |
 | [`plesty.lib.sim`](reference/plesty/lib/sim/index) | Synthetic data generation for testing |
-| [`plesty.lib.utils`](reference/plesty/lib/utils/index) | Shared utilities (logging, errors, registry, DLL helpers) |
+| [`plesty.lib.utils`](reference/plesty/lib/utils/index) | Shared utilities (env settings loader, logging, errors, registry, DLL helpers) |
 | [`plesty.lib.test`](reference/plesty/lib/test/index) | Test helpers |
 

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/docs/quickstart.md

@@ -163,6 +163,39 @@ for name in client.get_config_list():
     print(f"{name}: {value}")
 ```
 
+### Connection Settings (Env-Driven)
+
+Credential and connection information — where to reach the device and which port to
+serve it on — belongs in the environment, not hard-coded. `EnvSettings` is a small,
+dependency-free helper that loads environment variables (optionally seeded from a
+`.env` file) with typed access. It is deliberately generic: **each device module
+chooses its own variable names and defaults**; the helper just loads and casts them.
+
+```python
+from plesty.lib.utils import EnvSettings
+
+env = EnvSettings.load()  # reads ./.env, then the process env (process env wins)
+# By default load() also registers the parsed `.env` values into os.environ
+# (without overriding existing ones), so they are visible to os.getenv and child
+# processes too. Pass export=False for a side-effect-free load.
+
+# Precedence per value: CLI argument (override) > env var > default.
+# Credentials use require() — never hard-code them as a default in source.
+host = env.require("AMC300_HOST", override=args.host)
+port = env.require("AMC300_PORT", cast=int, override=args.port)
+# The serving port is not a credential, so a conventional default is fine.
+tcp_port = env.get("AMC300_TCP_PORT", default=5555, cast=int, override=args.tcp_port)
+
+device = PowermeterDevice(host, port)
+server = build_server(device, address=f"tcp://*:{tcp_port}")
+```
+
+Pass a parsed CLI argument as `override` (it wins when not `None`, so unset flags
+fall through to the environment). `require()` raises `KeyError` with a clean message
+when a mandatory credential is set neither by argument nor environment. The same
+`.env` then drives both the server and its tests. Flexible operational tuning
+(non-credential parameters) is configured separately, e.g. via a YAML file.
+
 ## Next Reading
 
 1. [Parameter system](device/param_system.md)

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/gl-secret-detection-report.json

@@ -7,7 +7,7 @@
       "vendor": {
         "name": "GitLab"
       },
-      "version": "7.37.0"
+      "version": "7.38.0"
     },
     "scanner": {
       "id": "gitleaks",
@@ -19,19 +19,19 @@
       "version": "8.30.1"
     },
     "type": "secret_detection",
-    "start_time": "2026-06-26T14:45:00",
-    "end_time": "2026-06-26T14:45:01",
+    "start_time": "2026-07-07T12:57:44",
+    "end_time": "2026-07-07T12:57:45",
     "status": "success",
     "observability": {
       "events": [
         {
           "event": "collect_secrets_analyzer_scan_metrics_from_pipeline",
-          "time_s": 0.483231567,
+          "time_s": 0.465675553,
           "exit_code": 0,
           "git_strategy": "FetchShallow",
-          "repo_size_kb": 1260,
+          "repo_size_kb": 2561,
           "commit_count": 1,
-          "bytes_scanned": 23,
+          "bytes_scanned": 24,
           "pipeline_type": "Tag"
         },
         {
@@ -40,7 +40,7 @@
           "passthrough_types": null,
           "passthrough_count": 0,
           "passthrough_auth_used": false,
-          "rules_version": "0.24.3"
+          "rules_version": "0.25.0"
         }
       ]
     }

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/__init__.py

@@ -1,7 +1,6 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Plesty library root package. Import as ``plesty.lib``."""

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/data/__init__.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Data types and utilities for Plesty."""
 
 from .array import PlestyArray
@@ -16,9 +15,13 @@ from .types import (
     cast_basic_type,
 )
 from .table import TableHeader, PlestyTable2D, PlestyTable3D
+from .io import save_result, load_result, convert_to_hdf5
 
 __all__ = [
     "PlestyArray",
+    "save_result",
+    "load_result",
+    "convert_to_hdf5",
     "Units",
     "TableHeader",
     "PlestyTable2D",

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/data/array.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Data definitions for Plesty.
 
 For data from physical experiments, we need to strictly define the meta information

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/data/ctype_manager.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """C type parameter manager for Plesty device interfaces."""
 
 import ctypes as ct

plesty_lib-0.2.8/plesty/lib/data/io.py

@@ -0,0 +1,210 @@
+# SPDX-FileCopyrightText: 2026 Plesty Development Team
+# SPDX-FileContributor: Yunshuang Yuan
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+"""Persistence helpers for Plesty data (issue plesty-lib#4).
+
+Measured data must survive process crashes so experiments can resume from a
+checkpoint. The storage contract keeps blob data in its **original raw
+format** and describes it in a JSON metadata document that carries a
+reference link to the blob:
+
+* :class:`~plesty.lib.data.array.PlestyArray` — raw ``.npy`` blob; the JSON
+  document stores the Plesty metadata (name, range, options, unit,
+  description) plus shape/dtype and the blob reference.
+* ``bytes`` (e.g. an image already encoded by a camera) — written untouched;
+  common image formats (PNG, JPEG, TIFF) are recognised so the blob gets its
+  native suffix.
+* JSON-serializable values (dicts, lists, scalars) — inlined in the JSON
+  document itself; no blob is written.
+
+Writes are crash-safe: the blob is written first (atomically, via a temporary
+sibling file and :func:`os.replace`), then the JSON document. The JSON
+document is the commit record — a result exists once its ``.json`` file does.
+"""
+
+import json
+import os
+from datetime import datetime, timezone
+from io import BytesIO
+from pathlib import Path
+from typing import Any, Iterable, Optional
+
+import numpy as np
+
+from .array import PlestyArray
+
+#: Magic-number prefixes for recognising already-encoded image blobs.
+_IMAGE_MAGIC: dict[bytes, str] = {
+    b"\x89PNG\r\n\x1a\n": "png",
+    b"\xff\xd8\xff": "jpg",
+    b"II*\x00": "tif",
+    b"MM\x00*": "tif",
+}
+
+
+def _atomic_write_bytes(path: Path, payload: bytes) -> None:
+    """Write *payload* to *path* atomically via a temporary sibling file."""
+    tmp_path = path.with_name(path.name + ".tmp")
+    with open(tmp_path, "wb") as stream:
+        stream.write(payload)
+        stream.flush()
+        os.fsync(stream.fileno())
+    os.replace(tmp_path, path)
+
+
+def _sniff_suffix(payload: bytes) -> str:
+    """Return the native file suffix for an encoded blob (default ``bin``)."""
+    for magic, suffix in _IMAGE_MAGIC.items():
+        if payload.startswith(magic):
+            return suffix
+    return "bin"
+
+
+def save_result(
+    result: Any,
+    path_stem: str | Path,
+    provenance: Optional[dict[str, Any]] = None,
+) -> Path:
+    """Persist a measurement result as raw blob + JSON metadata document.
+
+    Args:
+        result:     The value to persist — a :class:`PlestyArray`, encoded
+                    ``bytes`` (e.g. an image), or any JSON-serializable value.
+        path_stem:  Destination path without suffix; the JSON document is
+                    written to ``<stem>.json`` and any blob next to it.
+        provenance: Optional context (step id, operation, parameters,
+                    device identity) recorded verbatim in the document.
+
+    Returns:
+        The path of the JSON metadata document.
+
+    Raises:
+        TypeError: If the result is neither a PlestyArray, bytes, nor
+            JSON-serializable.
+    """
+    stem = Path(path_stem)
+    stem.parent.mkdir(parents=True, exist_ok=True)
+    document: dict[str, Any] = {
+        "saved_at": datetime.now(timezone.utc).isoformat(),
+        "provenance": provenance or {},
+    }
+
+    if isinstance(result, PlestyArray):
+        blob_path = stem.with_suffix(".npy")
+        buffer = BytesIO()
+        np.save(buffer, np.asarray(result))
+        _atomic_write_bytes(blob_path, buffer.getvalue())
+        document.update(
+            {
+                "type": "array",
+                "blob": blob_path.name,
+                "format": "npy",
+                "shape": list(result.shape),
+                "dtype": str(result.dtype),
+                "meta": {k: getattr(result, k, None) for k in PlestyArray._META_KEYS},
+            }
+        )
+    elif isinstance(result, (bytes, bytearray)):
+        payload = bytes(result)
+        suffix = _sniff_suffix(payload)
+        blob_path = stem.with_suffix(f".{suffix}")
+        _atomic_write_bytes(blob_path, payload)
+        document.update({"type": "bytes", "blob": blob_path.name, "format": suffix})
+    else:
+        document.update({"type": "value", "value": result})
+
+    target = stem.with_suffix(".json")
+    _atomic_write_bytes(target, json.dumps(document, default=str, indent=2).encode())
+    return target
+
+
+def load_result(path: str | Path) -> Any:
+    """Load a result previously written by :func:`save_result`.
+
+    Args:
+        path: Path to the JSON metadata document (``<stem>.json``).
+
+    Returns:
+        The reconstructed value: a :class:`PlestyArray` with its metadata
+        restored, raw ``bytes`` for encoded blobs, or the inlined value.
+
+    Raises:
+        ValueError: If the document declares an unknown result type.
+    """
+    source = Path(path)
+    document: dict[str, Any] = json.loads(source.read_text())
+    result_type = document.get("type")
+
+    if result_type == "array":
+        data = np.load(source.with_name(document["blob"]))
+        meta = dict(document.get("meta", {}))
+        if meta.get("range") is not None:
+            meta["range"] = tuple(meta["range"])
+        return PlestyArray(data, **meta)
+    if result_type == "bytes":
+        return source.with_name(document["blob"]).read_bytes()
+    if result_type == "value":
+        return document.get("value")
+    raise ValueError(f"Unknown result type in {source}: {result_type!r}")
+
+
+def convert_to_hdf5(documents: Iterable[str | Path], target: str | Path) -> Path:
+    """Pack results written by :func:`save_result` into one HDF5 archive.
+
+    The raw blob + JSON layout stays the primary on-disk format; this is an
+    optional post-hoc export to the unified HDF5 format preferred by issue
+    plesty-lib#4. Each JSON document becomes one HDF5 group (named after the
+    document stem) holding a ``data`` dataset — the decoded array, the raw
+    encoded bytes, or the JSON-encoded inline value — with the document's
+    metadata and provenance stored as group attributes.
+
+    Args:
+        documents: Paths of the JSON metadata documents to include.
+        target:    Destination ``.h5`` file; parent directories are created.
+
+    Returns:
+        The resolved path of the written HDF5 file.
+
+    Raises:
+        ImportError: If the optional ``h5py`` dependency is not installed.
+        ValueError:  If a document declares an unknown result type.
+    """
+    try:
+        import h5py
+    except ImportError as exc:  # pragma: no cover - depends on environment
+        raise ImportError(
+            "convert_to_hdf5 requires the optional dependency 'h5py'; install it with: uv add h5py"
+        ) from exc
+
+    destination = Path(target)
+    if destination.suffix not in (".h5", ".hdf5"):
+        destination = destination.with_suffix(".h5")
+    destination.parent.mkdir(parents=True, exist_ok=True)
+
+    with h5py.File(destination, "w") as archive:
+        for doc_path in documents:
+            source = Path(doc_path)
+            document: dict[str, Any] = json.loads(source.read_text())
+            result_type = document.get("type")
+            group = archive.create_group(source.stem)
+
+            if result_type == "array":
+                group.create_dataset("data", data=np.load(source.with_name(document["blob"])))
+                for key, value in document.get("meta", {}).items():
+                    if value is not None:
+                        group.attrs[f"meta.{key}"] = json.dumps(value, default=str)
+            elif result_type == "bytes":
+                payload = source.with_name(document["blob"]).read_bytes()
+                group.create_dataset("data", data=np.frombuffer(payload, dtype=np.uint8))
+                group.attrs["format"] = document.get("format", "bin")
+            elif result_type == "value":
+                group.create_dataset("data", data=json.dumps(document.get("value"), default=str))
+            else:
+                raise ValueError(f"Unknown result type in {source}: {result_type!r}")
+
+            group.attrs["type"] = str(result_type)
+            group.attrs["saved_at"] = document.get("saved_at", "")
+            group.attrs["provenance"] = json.dumps(document.get("provenance", {}), default=str)
+    return destination

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/data/table.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """This module defines the PlestyTable class, which represents a tabular data structure
 with named columns and rows. It provides methods for accessing and manipulating the data
 in a structured way.

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/data/types.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Type resolution and casting utilities for Plesty data types."""
 
 from __future__ import annotations

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/data/units.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Unit parsing, composition, and conversion utilities for Plesty."""
 
 import re

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/__init__.py

@@ -1,7 +1,6 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Device abstractions and base classes for Plesty."""

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/async_wrapper.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Async wrapper classes for synchronous device objects."""
 
 import asyncio

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/base_device_sync.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Base synchronous device model for Plesty."""
 
 from __future__ import annotations
@@ -286,15 +285,18 @@ class BaseDeviceSyncModel(ABC, ConfigSystem, FunctionSystem):
             "Device disconnection logic is not implemented in the base model."
         )
 
+    @expose_to_api
     def identity(self) -> str:
         """Query the device for its identity string."""
         raise NotImplementedError("Device identity query is not implemented in the base model.")
 
+    @expose_to_api
     @abstractmethod
     def check_errors(self) -> list[str]:
         """Query the device for any error messages."""
         raise NotImplementedError("Device error checking is not implemented in the base model.")
 
+    @expose_to_api
     @abstractmethod
     def check_operatability(self) -> bool:
         """Check if the device is currently operatable (connected and responsive)."""
@@ -401,12 +403,10 @@ class BaseDeviceSyncModel(ABC, ConfigSystem, FunctionSystem):
         """Placeholder method for querying the device."""
         raise NotImplementedError("Command querying logic is not implemented in the base model.")
 
+    @expose_to_api
     def reset(self) -> None:
         """Reset the device to a known state."""
-        # This method can be overridden by subclasses to implement device-specific reset logic.
-        pass
 
+    @expose_to_api
     def clear(self) -> None:
         """Clear the device state."""
-        # This method can be overridden by subclasses to implement device-specific clear logic.
-        pass

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/base_tcp_scpi_device.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Base TCP/IP SCPI device implementation for Plesty."""
 
 import logging

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/base_visa_scpi_device.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Base VISA SCPI device implementation for Plesty."""
 
 from typing import Any

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/composite_device.py

@@ -1,3 +1,8 @@
+# SPDX-FileCopyrightText: 2026 Plesty Development Team
+# SPDX-FileContributor: Yunshuang Yuan
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Composite device wrapper for managing multiple devices together."""
 
 from typing import Any

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/device_utils.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Utility functions for device connectivity and configuration."""
 
 import socket

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/funcs.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Function system for registering and dispatching device operations."""
 
 from typing import Any, Callable, get_type_hints
@@ -24,7 +23,6 @@ from plesty.lib.data import (
     cast_basic_type,
 )
 
-
 _FUNC_META_DTYPE_MAP: dict[str, type] = {
     "float": float,
     "int": int,

{plesty_lib-0.2.6 → plesty_lib-0.2.8}/plesty/lib/device/params.py

@@ -1,9 +1,8 @@
-#
 # SPDX-FileCopyrightText: 2026 Plesty Development Team
-# SPDX-License-Identifier: LGPL-3.0-or-later
-# Author: Yunshuang Yuan
-# Email: yunshuang.yuan@fkp.uni-hannover.de
+# SPDX-FileContributor: Yunshuang Yuan
 #
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
 """Configuration parameter system for Plesty device models."""
 
 from dataclasses import dataclass, field

plesty_lib-0.2.8/plesty/lib/experiment/__init__.py

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2026 Plesty Development Team
+# SPDX-FileContributor: Yunshuang Yuan
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+"""Experiment orchestration: plans, journals, and the async Experiment ABC."""
+
+from .base_experiment import Experiment, InvalidOperationError, PlanMismatchError
+from .journal import Journal
+from .schedule import Plan, Step
+
+__all__ = [
+    "Experiment",
+    "InvalidOperationError",
+    "PlanMismatchError",
+    "Journal",
+    "Plan",
+    "Step",
+]