labnotes 0.0.20__tar.gz → 0.0.21__tar.gz

{labnotes-0.0.20 → labnotes-0.0.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.20
+Version: 0.0.21
 Summary: Browse experiment designs, notes, and run data from a folder.
 Project-URL: Repository, https://github.com/thekevinscott/labnotes
 Author-email: Kevin Scott <me@thekevinscott.com>

{labnotes-0.0.20 → labnotes-0.0.21}/src/labnotes/context.md

@@ -73,7 +73,8 @@ A script run by labnotes should:
 
 - take each param as a `--name value` flag, parsing lists and tables from JSON;
 - take its output folder as an argument, passed in `command` as `{run_dir}`, and write everything it produces there;
-- exit non-zero when it fails, so the run counts as failed and runs again next time.
+- exit non-zero when it fails, so the run counts as failed and runs again next time;
+- stop any background process it starts before it exits; the run ends when `command` exits.
 
 Runs can take a long time. Start `run` in the background, then check on it with `labnotes experiments foo runs`; a run with no `ended` is still going.
 

{labnotes-0.0.20 → labnotes-0.0.21}/src/labnotes/runner/execute_run.py

@@ -3,6 +3,7 @@ import time
 from pathlib import Path
 
 from labnotes.runner.shell_command import shell_command
+from labnotes.runner.wait_for_group import wait_for_group
 from labnotes.runner.write_run_json import write_run_json
 from labnotes.tables.iso_time import iso_time
 
@@ -13,6 +14,7 @@ async def execute_run(
     command: str,
     params: dict[str, object],
     running: set[asyncio.subprocess.Process],
+    stopping: asyncio.Event,
 ) -> dict[str, object]:
     run: dict[str, object] = {
         "params": params,
@@ -42,6 +44,11 @@ async def execute_run(
             running.add(process)
             try:
                 run["exit_code"] = await process.wait()
+                # The shell can exit on SIGTERM before what it started. Once
+                # stopping, the run stays killable until its whole group is
+                # gone. A normal exit ends the run even if helpers linger.
+                if stopping.is_set():
+                    await wait_for_group(process.pid)
             finally:
                 running.discard(process)
     run["ended"] = iso_time(time.time())

{labnotes-0.0.20 → labnotes-0.0.21}/src/labnotes/runner/run_experiment.py

@@ -32,7 +32,7 @@ async def run_experiment(
     report({"event": "planned", "runs": len(plan), "concurrency": concurrency})
     running: set[asyncio.subprocess.Process] = set()
     results: list[dict[str, object]] = []
-    stopping = False
+    stopping = asyncio.Event()
 
     def signal_runs(signal_number: int) -> None:
         for process in running:
@@ -40,10 +40,9 @@ async def run_experiment(
                 os.killpg(process.pid, signal_number)
 
     def interrupt() -> None:
-        nonlocal stopping
         plan.clear()
-        if not stopping:
-            stopping = True
+        if not stopping.is_set():
+            stopping.set()
             report({"event": "stopping"})
             signal_runs(signal.SIGTERM)
         elif running:
@@ -60,7 +59,7 @@ async def run_experiment(
             folder.mkdir(parents=True)
             report({"event": "started", "run": run, "params": params})
             result = await execute_run(
-                config.root, folder, experiment.command, params, running
+                config.root, folder, experiment.command, params, running, stopping
             )
             report({"event": "ended", "run": run, **result})
             results.append(result)

labnotes-0.0.21/src/labnotes/runner/wait_for_group.py

@@ -0,0 +1,11 @@
+import asyncio
+import os
+
+
+async def wait_for_group(group: int) -> None:
+    while True:
+        try:
+            os.killpg(group, 0)
+        except ProcessLookupError:
+            return
+        await asyncio.sleep(0.1)