dsh-labscript 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.2.4
+
+- Fix: labs_data no longer answers h5: 0 for a run folder that does not exist. A missing
+  folder raises RUN_FOLDER_MISSING with the raw and mapped paths plus a hint: runmanager's
+  shot output folder is the folder the NEXT run will use and only exists after engage, so
+  historical runs must be passed explicitly. An existing folder with no shots reports
+  empty: true instead.
+- Fix: labs_status with keys=[...] drops keys that are not panel globals instead of
+  returning null, so the rendered output shows <missing>. UI group names (for example
+  Select_Sequence) are not globals: read their leaf keys or a run's h5.
+- Descriptions: labs_status says the shot output folder is the NEXT run folder and that
+  keys are leaf global names; labs_data explains the run_folder default and the error.
+- Tests: missing run folder, empty run folder, missing keys dropped.
+
+## 0.2.3
+
+- Fix: labs_status now prints panel values. keys=[...] and raw=true were accepted but the
+  rendered summary never showed any global, so the model could only see the key count
+  (the tool result content is the render output; the returned object is not in context).
+  With keys the selected values are printed (240 chars each, <missing> when absent);
+  without keys it prints the count and a hint to pass keys.
+- Tests: labs_status value rendering (values, count-only, missing keys).
+
 ## 0.2.2
 
 - Fix: labs_status and labs_engage report pathMap-mapped paths. `labs_status.labscript`

package/README.md

@@ -125,8 +125,8 @@ is not a physics simulation.
 ## Development
 
     npm install              # only runtime dependency: yaml
-    npm test                 # node --test, 35 tests (fake bridge, no python needed)
-    python python/tests/run_tests.py   # 15 tests (needs numpy + h5py)
+    npm test                 # node --test, 36 tests (fake bridge, no python needed)
+    python python/tests/run_tests.py   # 18 tests (needs numpy + h5py)
     LABSCRIPT_PYTHON=/path/to/python3 node scripts/demo.mjs   # end-to-end mock demo
 
 A fresh clone must run `npm install` before `npm test`; the CI workflow does this.
@@ -157,7 +157,9 @@ A fresh clone must run `npm install` before `npm test`; the CI workflow does thi
   partial). compiled_not_executed means shots exist but show no acquisition data yet;
   BLACS may be paused or not executing the queue.
 - Real runmanager engage does not return a run folder; the bridge captures the
-  output folder before engage and reports it as the run folder.
+  output folder before engage and reports it as the run folder. That shot output
+  folder is the NEXT run's folder and does not exist until engage, so labs_data
+  errors (RUN_FOLDER_MISSING) instead of reporting h5: 0 for a path that is not there.
 - The panel is snapshotted before every write; labs_restore restores only the keys the
   write touched (full=true restores the whole panel), so unrelated concurrent edits survive.
 - Actions are logged to events.jsonl next to the snapshots.

package/lib/tools.js

@@ -35,6 +35,30 @@ function progressLine(run) {
   return parts.join('  ')
 }
 
+// The bridge returns the whole panel; without this the summary alone hides it.
+function globalText(value, limit = 240) {
+  let rendered
+  try { rendered = JSON.stringify(value) } catch { rendered = String(value) }
+  if (rendered === undefined) rendered = String(value)
+  return rendered.length > limit ? rendered.slice(0, limit) + '…' : rendered
+}
+
+function globalLines(args, value) {
+  const globals = value.globals || {}
+  const keys = Array.isArray(args.keys) ? args.keys : []
+  if (keys.length === 0) {
+    const count = Object.keys(globals).length
+    return [count > 0 ? 'globals: ' + count + ' keys (pass keys=[...] to read values)' : 'globals: none']
+  }
+  const raw = args.raw === true && value.raw_globals ? value.raw_globals : null
+  const out = ['globals:']
+  for (const key of keys) {
+    const shown = raw ? raw[key] : globals[key]
+    out.push('  ' + key + ' = ' + (shown === undefined ? '<missing>' : globalText(shown)))
+  }
+  return out
+}
+
 async function pendingProgress(runtime, exec) {
   const pending = runtime.state.pending
   if (!pending) return null
@@ -105,7 +129,7 @@ export function registerTools(ctx, runtime) {
 
   ctx.tools.register({
     name: 'labs_status',
-    description: 'Read the labscript runmanager panel: loaded labscript, globals (evaluated; raw expressions with raw=true), n_shots, error_in_globals, run_shots, shot output folder, pending run progress, and the panel snapshot directory. Read-only; call this before any write. Paths in the output are already mapped for this machine through pathMap; do not map them again.',
+    description: 'Read the labscript runmanager panel: loaded labscript, globals (evaluated; raw expressions with raw=true), n_shots, error_in_globals, run_shots, shot output folder, pending run progress, and the panel snapshot directory. Read-only; call this before any write. Pass keys=[...] (leaf global names; UI group names are not globals) to print the selected panel values (240 chars each; raw=true prints the raw expression), missing keys are shown as <missing>. The shot output folder is the folder the NEXT run will use; it does not exist until engage. Paths in the output are already mapped for this machine through pathMap; do not map them again.',
     parameters: {
       type: 'object',
       properties: {
@@ -115,13 +139,14 @@ export function registerTools(ctx, runtime) {
       additionalProperties: false,
     },
     isConcurrencySafe: () => true,
-    output: looseOutput((_args, value) => text(lines([
+    output: looseOutput((args, value) => text(lines([
       'backend: ' + value.backend + '  plugin: v' + runtime.version,
       'labscript: ' + value.labscript,
       'shot output: ' + value.shot_output_folder,
       'n_shots: ' + value.n_shots + '  error_in_globals: ' + value.error_in_globals + '  run_shots: ' + value.run_shots,
       progressLine(value.last_run),
       'panel history: ' + (value.panel_history ? value.panel_history.dir + ' (' + value.panel_history.count + ' snapshots)' : 'n/a'),
+      ...globalLines(args, value),
     ]))),
     async execute(args, exec) {
       const data = await runtime.runBridge('status', {
@@ -314,11 +339,11 @@ export function registerTools(ctx, runtime) {
 
   ctx.tools.register({
     name: 'labs_data',
-    description: 'Read a run folder HDF5: globals of the first shot (execution facts) and, with scan: a per-shot table of scan values and numeric results. Read-only.',
+    description: 'Read a run folder HDF5: globals of the first shot (execution facts) and, with scan: a per-shot table of scan values and numeric results. Read-only. run_folder defaults to the run this DSH session submitted; for a historical run pass its folder explicitly. A missing folder is an error: runmanager\'s shot output is the NEXT run folder and only exists after engage.',
     parameters: {
       type: 'object',
       properties: {
-        run_folder: { type: 'string', description: 'Run folder; defaults to the pending/last submitted run' },
+        run_folder: { type: 'string', description: 'Run folder; defaults to the run submitted from this DSH session (pass a historical run folder explicitly)' },
         scan: { type: 'string', description: 'Panel global name used as the scan axis; adds a per-shot table' },
         globals: { type: 'boolean', description: 'Include the first shot globals (default true)' },
         results: { type: 'boolean', description: 'Include the results layout' },
@@ -328,7 +353,7 @@ export function registerTools(ctx, runtime) {
     isConcurrencySafe: () => true,
     output: looseOutput((_args, value) => text(lines([
       'run: ' + (value.mapped_run_folder || value.run_folder),
-      'h5: ' + value.n_h5,
+      'h5: ' + value.n_h5 + (value.empty ? ' (folder exists, no shots yet)' : ''),
       value.scan_table ? 'scan ' + value.scan_table.scan + ': ' + value.scan_table.n_points + ' shots' : '',
       value.globals ? 'globals: ' + Object.keys(value.globals).length + ' keys' : '',
     ]))),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-labscript",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Control labscript-suite experiments from DeepSeek Harness: runmanager globals and scans, submits and waits, YAML fixed-operation protocols with postprocess write-back, panel snapshots, a built-in mock backend and a read-only doctor.",
   "type": "module",
   "main": "lib/index.js",

package/python/bridge.py

@@ -922,8 +922,8 @@ def cmd_status(config, args):
     values = backend.get_globals(raw=False)
     raw_values = backend.get_globals(raw=True)
     if keys:
-        values = dict((k, values.get(k)) for k in keys)
-        raw_values = dict((k, raw_values.get(k)) for k in keys)
+        values = dict((k, values[k]) for k in keys if k in values)
+        raw_values = dict((k, raw_values[k]) for k in keys if k in raw_values)
     out = {
         "backend": config.get("backend"),
         "version": backend.version() if hasattr(backend, "version") else None,
@@ -1182,9 +1182,16 @@ def cmd_data(config, args):
     if not run_folder:
         raise BridgeError("BAD_ARGS", "run_folder is required")
     folder = map_path(config, run_folder)
+    if not os.path.isdir(folder):
+        raise BridgeError("RUN_FOLDER_MISSING", "run folder does not exist: " + str(folder), {
+            "run_folder": run_folder,
+            "mapped_run_folder": folder,
+            "hint": "runmanager's shot output folder is the folder the NEXT run will use; it does not exist until engage. Pass a historical run folder explicitly.",
+        })
     shots = sorted(glob.glob(os.path.join(folder, "**", "*.h5"), recursive=True))
     out = {"run_folder": run_folder, "mapped_run_folder": folder, "n_h5": len(shots)}
     if not shots:
+        out["empty"] = True
         return out
     scan = args.get("scan")
     with h5py.File(shots[0], "r", locking=False) as handle:

package/python/tests/run_tests.py

@@ -346,6 +346,48 @@ def test_progress_reports_mapped_run_folder():
     assert out["mapped_run_folder"] == "\\\\lab-pc\\Experiments\\nope", out
 
 
+def test_data_missing_run_folder():
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-data-missing-")
+    try:
+        cfg = make_config(tmp)
+        missing = os.path.join(tmp, "no_such_run")
+        try:
+            bridge.cmd_data(cfg, {"run_folder": missing})
+        except bridge.BridgeError as exc:
+            assert exc.code == "RUN_FOLDER_MISSING", exc.message
+            assert exc.detail["mapped_run_folder"] == missing, exc.detail
+            assert "next" in exc.detail["hint"].lower(), exc.detail
+        else:
+            raise AssertionError("expected RUN_FOLDER_MISSING")
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
+def test_data_empty_run_folder():
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-data-empty-")
+    try:
+        cfg = make_config(tmp)
+        run_dir = os.path.join(tmp, "empty_run")
+        os.makedirs(run_dir, exist_ok=True)
+        out = bridge.cmd_data(cfg, {"run_folder": run_dir})
+        assert out["n_h5"] == 0, out
+        assert out.get("empty") is True, out
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
+def test_status_drops_missing_keys():
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-status-missing-")
+    try:
+        cfg = make_config(tmp)
+        out = bridge.cmd_status(cfg, {"keys": ["amplitude", "Select_Sequence"], "raw": True})
+        assert "amplitude" in out["globals"], out["globals"]
+        assert "Select_Sequence" not in out["globals"], out["globals"]
+        assert "Select_Sequence" not in out["raw_globals"], out["raw_globals"]
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
 def main():
     tests = [value for name, value in sorted(globals().items()) if name.startswith("test_")]
     failures = 0