labnotes 0.2.33__tar.gz → 0.2.35__tar.gz

{labnotes-0.2.33 → labnotes-0.2.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.2.33
+Version: 0.2.35
 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.2.33 → labnotes-0.2.35}/src/labnotes/runner/execute_run.py

@@ -16,6 +16,7 @@ from labnotes.runner.exit_signal import exit_signal
 from labnotes.runner.record_memory import record_memory
 from labnotes.runner.run_git import run_git
 from labnotes.runner.shell_command import shell_command
+from labnotes.runner.stop_containers import stop_containers
 from labnotes.runner.stop_then_kill import GRACE_SECONDS
 from labnotes.runner.wait_for_tree import wait_for_tree
 from labnotes.runner.write_run_json import write_run_json
@@ -146,6 +147,8 @@ async def execute_run(
                         GRACE_SECONDS, stop
                     )
                 run["exit_code"] = code = await exited
+                if kill_later is not None:
+                    kill_later.cancel()
                 run["signal"] = exit_signal(code)
                 if kill_later is not None:
                     run["ended_by"] = "timeout"
@@ -158,6 +161,8 @@ async def execute_run(
                 # is gone. A normal exit ends the run even if helpers linger.
                 if stopping.is_set() or kill_later is not None:
                     await wait_for_tree(tree)
+                if stopping.is_set() or kill_later is not None or stopped():
+                    await asyncio.to_thread(stop_containers, str(folder.resolve()))
             finally:
                 if kill_later is not None:
                     kill_later.cancel()

{labnotes-0.2.33 → labnotes-0.2.35}/src/labnotes/runner/read_experiment_config.py

@@ -1,4 +1,5 @@
 import json
+import re
 import tomllib
 from pathlib import Path
 from typing import Any
@@ -13,6 +14,7 @@ from labnotes.is_positive_int import is_positive_int
 from labnotes.config_migration import MISSING_CONTINUES, REMOVED_MODE
 from labnotes.retries import RETRY_SECONDS
 
+SHELL_IDENTIFIER = re.compile(r"[A-Za-z_][A-Za-z0-9_]*\Z")
 SETTINGS = {
     "name",
     "command",
@@ -103,6 +105,11 @@ def read_experiment_config(
     for key, value in env.items():
         if key.startswith("LABNOTES_"):
             raise ValueError(f"{path}: env.{key} is reserved for labnotes")
+        if not SHELL_IDENTIFIER.match(key):
+            raise ValueError(
+                f"{path}: env.{key} must be a shell identifier"
+                " (letters, digits, underscore; not starting with a digit)"
+            )
         if not isinstance(value, str):
             raise ValueError(f"{path}: env.{key} must be a string")
     if "continues" not in values:

labnotes-0.2.35/src/labnotes/runner/stop_containers.py

@@ -0,0 +1,17 @@
+import shutil
+
+from labnotes.runner.container_memory import LABEL
+from labnotes.runner.docker_output import docker_output
+
+
+def stop_containers(run_id: str) -> None:
+    """Stop Docker containers that outlive their run's host process tree."""
+    if shutil.which("docker") is None:
+        return
+    ids = docker_output(
+        "ps", "--quiet", "--no-trunc", "--filter", f"label={LABEL}={run_id}"
+    )
+    if ids is None:
+        return
+    for container_id in ids.splitlines():
+        docker_output("kill", container_id)

{labnotes-0.2.33 → labnotes-0.2.35}/tests/conftest.py

@@ -2,11 +2,44 @@ import shlex
 import shutil
 import subprocess
 import sys
+import os
 from collections.abc import Iterator
 from pathlib import Path
+from unittest import mock
 
 import pytest
 
+
+@pytest.fixture
+def fake_docker(tmp_path: Path) -> Iterator[dict[str, str]]:
+    """A Docker CLI whose container survives when the client is signalled."""
+    binary = tmp_path / "fake-docker-bin"
+    binary.mkdir()
+    (binary / "docker").write_text(
+        "#!/usr/bin/env python3\n"
+        "import os, pathlib, sys, time\n"
+        "args = sys.argv[1:]\n"
+        "state = pathlib.Path(os.environ['FAKE_DOCKER_STATE'])\n"
+        "if args[0] == 'run':\n"
+        "    label = args[args.index('--label') + 1]\n"
+        "    state.write_text(label)\n"
+        "    time.sleep(30)\n"
+        "elif args[0] == 'ps':\n"
+        "    wanted = args[args.index('--filter') + 1][6:]\n"
+        "    if state.exists() and state.read_text() == wanted: print('fake-container')\n"
+        "elif args[0] == 'kill':\n"
+        "    if state.exists(): state.unlink()\n"
+        "    print(args[1])\n"
+    )
+    (binary / "docker").chmod(0o755)
+    environment = {
+        "PATH": f"{binary}{os.pathsep}{os.environ['PATH']}",
+        "FAKE_DOCKER_STATE": str(tmp_path / "container.state"),
+    }
+    with mock.patch.dict(os.environ, environment):
+        yield environment
+
+
 BOTBOX_CONTAINER = """
 import os
 import subprocess