fraclab-sdk 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+## 0.1.2
+
+### Validation System Upgrade
+- **InputSpec strict validation**:
+  - `json_schema_extra` whitelist enforcement (unknown keys → ERROR, `x_*` prefix → WARNING for extensions)
+  - `show_when` canonical operators only: `equals`, `not_equals`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
+  - Operator aliases (`eq`, `neq`, `nin`) emit WARNING and normalize to canonical form
+  - snake_case field path detection with camelCase fix suggestions (UI compatibility)
+  - JSON Schema path resolution with `$ref`, `allOf`, `anyOf/oneOf` handling (Pydantic v2 patterns)
+  - `enum_labels` must match enum values exactly (missing/extra keys → ERROR)
+  - Leaf fields missing `title` emit WARNING
+- **OutputContract policy checks**:
+  - Schema structure validation per kind (`frame`, `object`, `blob`, `scalar`)
+  - `dimensions` cannot overlap with owner-level keys (`stageId`, `wellId`, `platformId`)
+  - `groupPath` depth limit warning (max 4 levels)
+  - Invariants validation: dataset references must exist, `sameOwner` level must match
+  - Relations validation: dataset/field references must exist, blob/scalar cannot have field relations
+- **Algorithm signature validation**:
+  - `main.py` must exist with top-level `run` function
+  - `async def run` not supported (sandbox limitation)
+  - Exactly 1 positional parameter required (no `*args`, `**kwargs`, keyword-only args)
+- **Export page integration**:
+  - Cached validation with mtime-based invalidation (avoids re-running on every rerender)
+  - Status badges for InputSpec, OutputContract, Algorithm
+  - Validation details expander with fix suggestions for snake_case issues
+  - Export blocked when validation errors exist
+
+### Other Changes
+- Export page: Replace "File Status" with "Validation Status" as the primary integrity check; File Inspector in expander (expanded by default); Revalidate button inline with status badges.
+- Schema/Output Edit pages: Show warnings even when validation passes; fix incorrect path passed to `validate_output_contract`.
+- Single .py file import: Now creates full template structure (`schema/`, `dist/`) matching "Create New Algorithm".
+- Algorithm scaffold: Now creates `dist/output_contract.json` template.
+- Flatten exported algorithm zip structure (no top-level version folder in Workbench export).
+- Manifest defaults: add `requires.sdk`, `repository`, `homepage`, `license` to scaffolds and bundled examples.
+- Workbench Run/Results pages prompt users to use the InputSpec/OutputSpec editor Validate actions when UI or artifacts are missing.
+- Workbench pages default sidebar to expanded to avoid being trapped when the Streamlit toolbar is hidden.
+- Keep Streamlit toolbar visible (deploy button hidden) so the sidebar toggle is always accessible.
+- Force sidebar to stay visible via CSS so navigation is always reachable.
+- Hide the sidebar collapse control to keep navigation fixed open.
+
+## 0.1.1
+- Package the Streamlit Workbench inside `fraclab_sdk` with the `fraclab-workbench` entrypoint; optional `workbench` extra pulls UI deps.
+- Restore core scientific deps to the base install (numpy/pandas/scipy/matplotlib/fastapi/rich) while keeping Workbench UI deps optional.
+- Add manifest defaults for `requires.sdk`, `repository`, `homepage`, `license`, and embed the SDK version constant for templating.
+- Update bundled example manifests to include the new metadata fields.
+
+## 0.1.0
+- Initial public SDK release with snapshots, algorithm library, run manager, CLI, and devkit tooling.

README.md

@@ -890,6 +890,8 @@ $ fraclab-sdk run tail f9e8d7c6
 $ fraclab-sdk run tail f9e8d7c6 --stderr
 ```
 
+> Workbench 提示：结果页面会展示本次运行的输出目录路径（含 `_logs` 日志），即使运行失败也能点开路径定位调试。
+
 #### 6. 运行目录结构
 
 执行完成后，`~/.fraclab/runs/<run_id>/` 目录结构:

fraclab_sdk/__init__.py

@@ -7,6 +7,7 @@ from fraclab_sdk.results import ResultReader
 from fraclab_sdk.run import RunManager, RunMeta, RunResult, RunStatus
 from fraclab_sdk.selection.model import SelectionModel
 from fraclab_sdk.snapshot import SnapshotHandle, SnapshotLibrary, SnapshotMeta
+from fraclab_sdk.version import __version__
 
 __all__ = [
     # Config
@@ -31,4 +32,6 @@ __all__ = [
     "RunStatus",
     # Results
     "ResultReader",
+    # Package metadata
+    "__version__",
 ]

fraclab_sdk/devkit/__init__.py

@@ -9,6 +9,10 @@ This module provides tools for:
 from fraclab_sdk.devkit.compile import compile_algorithm
 from fraclab_sdk.devkit.export import export_algorithm_package
 from fraclab_sdk.devkit.validate import (
+    ValidationIssue,
+    ValidationResult,
+    ValidationSeverity,
+    validate_algorithm_signature,
     validate_bundle,
     validate_inputspec,
     validate_output_contract,
@@ -18,6 +22,10 @@ from fraclab_sdk.devkit.validate import (
 __all__ = [
     "compile_algorithm",
     "export_algorithm_package",
+    "ValidationSeverity",
+    "ValidationIssue",
+    "ValidationResult",
+    "validate_algorithm_signature",
     "validate_bundle",
     "validate_inputspec",
     "validate_output_contract",