labnotes 0.0.15__tar.gz → 0.0.16__tar.gz

{labnotes-0.0.15 → labnotes-0.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.15
+Version: 0.0.16
 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>
@@ -98,7 +98,8 @@ line per event instead.
 - `--concurrency N` runs N at a time (default 1).
 - `-e PATH` reads another file instead of `experiment.toml`.
 - Ctrl-C stops the running scripts and records their end. A second Ctrl-C
-  kills them.
+  kills them. Closing the terminal or sending SIGTERM stops them the same way,
+  then kills any still going 5 seconds later.
 - A second `run` of the same experiment fails while the first holds the lock.
 - It exits 1 if any run failed.
 

{labnotes-0.0.15 → labnotes-0.0.16}/README.md

@@ -75,7 +75,8 @@ line per event instead.
 - `--concurrency N` runs N at a time (default 1).
 - `-e PATH` reads another file instead of `experiment.toml`.
 - Ctrl-C stops the running scripts and records their end. A second Ctrl-C
-  kills them.
+  kills them. Closing the terminal or sending SIGTERM stops them the same way,
+  then kills any still going 5 seconds later.
 - A second `run` of the same experiment fails while the first holds the lock.
 - It exits 1 if any run failed.
 

{labnotes-0.0.15 → labnotes-0.0.16}/src/labnotes/context.md

@@ -58,6 +58,14 @@ Each param is appended as `--name value`, with the name as written (use
 and tables as JSON. labnotes writes `run.json` (params, created, ended, exit
 code), `stdout.log` and `stderr.log` to the run folder.
 
+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.
+
+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.
+
 In a terminal, `run` shows a live table of runs (status and time) and stays
 open when they finish; `q` quits. Elsewhere, or with `--no-tui`, it prints a
 line per event instead.
@@ -65,7 +73,8 @@ line per event instead.
 - `--concurrency N` runs N at a time (default 1).
 - `-e PATH` reads another file instead of `experiment.toml`.
 - Ctrl-C stops the running scripts and records their end. A second Ctrl-C
-  kills them.
+  kills them. Closing the terminal or sending SIGTERM stops them the same way,
+  then kills any still going 5 seconds later.
 - A second `run` of the same experiment fails while the first holds the lock.
 - It exits 1 if any run failed.
 

{labnotes-0.0.15 → labnotes-0.0.16}/src/labnotes/runner/run_experiment.py

@@ -38,13 +38,13 @@ async def run_experiment(
     def interrupt() -> None:
         nonlocal stopping
         plan.clear()
-        if stopping:
-            report({"event": "killing"})
-            signal_runs(signal.SIGKILL)
-        else:
+        if not stopping:
             stopping = True
             report({"event": "stopping"})
             signal_runs(signal.SIGTERM)
+        elif running:
+            report({"event": "killing"})
+            signal_runs(signal.SIGKILL)
 
     async def work() -> None:
         while plan:

{labnotes-0.0.15 → labnotes-0.0.16}/src/labnotes/runner/run_headless.py

@@ -6,10 +6,12 @@ import click
 
 from labnotes.models import Start
 from labnotes.runner.describe_event import describe_event
+from labnotes.runner.stop_then_kill import stop_then_kill
 
 
 def run_headless(start: Start) -> list[dict[str, object]]:
     def listen(interrupt: Callable[[], None]) -> None:
         asyncio.get_running_loop().add_signal_handler(signal.SIGINT, interrupt)
+        stop_then_kill(interrupt, signal.SIGTERM, signal.SIGHUP)
 
     return asyncio.run(start(lambda event: click.echo(describe_event(event)), listen))

labnotes-0.0.16/src/labnotes/runner/stop_then_kill.py

@@ -0,0 +1,15 @@
+import asyncio
+from collections.abc import Callable
+
+GRACE_SECONDS = 5
+
+
+def stop_then_kill(interrupt: Callable[[], None], *signals: int) -> None:
+    loop = asyncio.get_running_loop()
+
+    def stop() -> None:
+        interrupt()
+        loop.call_later(GRACE_SECONDS, interrupt)
+
+    for signal_number in signals:
+        loop.add_signal_handler(signal_number, stop)

{labnotes-0.0.15 → labnotes-0.0.16}/src/labnotes/tui/run_app.py

@@ -1,3 +1,4 @@
+import signal
 import time
 from collections.abc import Callable
 
@@ -7,6 +8,7 @@ from textual.widgets import DataTable, Footer, Header, Static
 
 from labnotes.models import Start
 from labnotes.runner.describe_event import describe_event
+from labnotes.runner.stop_then_kill import stop_then_kill
 from labnotes.runner.param_args import param_args
 from labnotes.tui.format_elapsed import format_elapsed
 
@@ -50,6 +52,7 @@ class RunApp(App[None]):
 
     def listen(self, interrupt: Callable[[], None]) -> None:
         self.interrupt = interrupt
+        stop_then_kill(interrupt, signal.SIGTERM, signal.SIGHUP)
 
     def show_event(self, event: dict[str, object]) -> None:
         table = self.query_one(DataTable)