labnotes 0.0.133__tar.gz → 0.0.135__tar.gz

{labnotes-0.0.133 → labnotes-0.0.135}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.133
+Version: 0.0.135
 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.133 → labnotes-0.0.135}/src/labnotes/context.md

@@ -80,7 +80,7 @@ Both placeholders are shell-quoted.
 Each param is appended as `--name value`, with the name as written (use
 `source-language` for a `--source-language` flag), booleans as 0 or 1, and lists
 and tables as JSON. labnotes writes `run.json` (params, `command`, created,
-ended, exit code, `ended_by`, `signal`), `stdout.log` and `stderr.log` to the
+ended, exit code, `ended_by`, `signal`, `git`), `stdout.log` and `stderr.log` to the
 run folder. `command` is the shell command the run executed, with the placeholders
 and the params filled in, written before the run starts, so a killed run has it
 and a later edit to `experiment.toml` doesn't hide what a run did. `ended_by` is `"timeout"`, `"stop"` (labnotes stopped it),
@@ -88,6 +88,11 @@ and a later edit to `experiment.toml` doesn't hide what a run did. `ended_by` is
 `"lost"` (its process died unseen; the daemon marks these when it starts, with
 `ended` set and `exit_code` null) or null (the script exited itself). `signal` is the signal number read from the
 exit code (negative, or 128 + N from the shell), else null.
+`git` is `{"commit": "<full HEAD SHA>", "dirty": false}`, read from the command's
+working directory before each run starts, including retries. `dirty` counts staged
+and unstaged changes to tracked files only, ignoring untracked files. `git` is
+null outside a Git repository, if Git is missing, or if lookup fails (including
+a repository with no commits). Older records lack the key.
 `meta` in `experiment.toml` (or `[experiment]` in `.labnotes.toml`) is a shell
 command that prints one JSON object, such as the git commit. labnotes runs it
 once from the root when `run` starts and copies it into every run's `run.json`

{labnotes-0.0.133 → labnotes-0.0.135}/src/labnotes/runner/execute_run.py

@@ -10,6 +10,7 @@ import psutil
 from labnotes.log_path import LOG_ENV, RUN_ENV
 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_then_kill import GRACE_SECONDS
 from labnotes.runner.wait_for_tree import wait_for_tree
@@ -48,6 +49,7 @@ async def execute_run(
         "error": None,
         "ended_by": None,
         "signal": None,
+        "git": await asyncio.to_thread(run_git, root),
     }
     if args:
         run["args"] = list(args)
@@ -56,6 +58,10 @@ async def execute_run(
     if meta is not None:
         run["meta"] = meta
     write_run_json(folder, run)
+    run_environment = os.environ if environment is None else environment
+    botbox_labels = f"labnotes.run={folder.resolve()}"
+    if existing_labels := run_environment.get("BOTBOX_LABELS"):
+        botbox_labels = f"{existing_labels}\n{botbox_labels}"
     with (
         (folder / "stdout.log").open("wb") as stdout,
         (folder / "stderr.log").open("wb") as stderr,
@@ -69,13 +75,12 @@ async def execute_run(
                     "CLICOLOR_FORCE": "1",
                     **{
                         key: value
-                        for key, value in (
-                            os.environ if environment is None else environment
-                        ).items()
+                        for key, value in run_environment.items()
                         if not key.startswith("LABNOTES_")
                     },
                     LOG_ENV: str(folder / "log.jsonl"),
                     RUN_ENV: str(folder.resolve()),
+                    "BOTBOX_LABELS": botbox_labels,
                     RUN_STATE_ENV: str(state_file),
                 },
                 stdout=stdout,

labnotes-0.0.135/src/labnotes/runner/run_git.py

@@ -0,0 +1,22 @@
+import subprocess
+from pathlib import Path
+
+
+def run_git(root: Path) -> dict[str, str | bool] | None:
+    try:
+        commit = subprocess.check_output(
+            ["git", "rev-parse", "HEAD"],
+            cwd=root,
+            stderr=subprocess.DEVNULL,
+            timeout=3,
+        )
+        status = subprocess.check_output(
+            ["git", "status", "--porcelain", "--untracked-files=no"],
+            cwd=root,
+            stderr=subprocess.DEVNULL,
+            timeout=3,
+        )
+        return {"commit": commit.decode("ascii").strip(), "dirty": bool(status)}
+    except (OSError, subprocess.SubprocessError, UnicodeError):
+        # Git metadata is optional; a failed lookup must not prevent the run.
+        return None