labnotes 0.0.123__tar.gz → 0.0.124__tar.gz

{labnotes-0.0.123 → labnotes-0.0.124}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.123
+Version: 0.0.124
 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.123 → labnotes-0.0.124}/src/labnotes/daemon/daemon_app.py

@@ -79,6 +79,7 @@ def daemon_app(config: LabnotesConfig) -> Starlette:
                 None if path is None else Path(str(path)),
                 body.get("concurrency"),  # type: ignore[arg-type]
                 body.get("only"),  # type: ignore[arg-type]
+                body.get("args"),  # type: ignore[arg-type]
             )
         except ValueError as error:
             return refuse(400, str(error))
@@ -105,6 +106,7 @@ def daemon_app(config: LabnotesConfig) -> Starlette:
                     listen,
                     body.get("timeout"),  # type: ignore[arg-type]
                     only=body.get("only"),  # type: ignore[arg-type]
+                    args=body.get("args"),  # type: ignore[arg-type]
                 )
             # Clients hear why the session ended; the daemon keeps serving.
             except Exception as failure:  # noqa: BLE001

{labnotes-0.0.123 → labnotes-0.0.124}/src/labnotes/daemon/remote_start.py

@@ -17,6 +17,7 @@ def remote_start(
     concurrency: int | None,
     timeout: float | None = None,
     only: dict[str, str] | None = None,
+    args: list[str] | None = None,
 ) -> Start:
     async def start(report: Report, listen: Listen) -> list[dict[str, object]]:
         try:
@@ -48,6 +49,7 @@ def remote_start(
                     "concurrency": concurrency,
                     "timeout": timeout,
                     "only": only,
+                    "args": args,
                 },
             )
             if reply.status_code != 202:

{labnotes-0.0.123 → labnotes-0.0.124}/src/labnotes/experiments.py

@@ -17,12 +17,25 @@ from labnotes.tui.browse_tui import browse_tui
 from labnotes.tui.run_tui import run_tui
 
 BYTES = ("memory", "size")
+PASSTHROUGH = "labnotes.passthrough"
+
+
+class PassthroughCommand(click.Command):
+    def parse_args(self, ctx: click.Context, args: list[str]) -> list[str]:
+        if "--" in args:
+            at = args.index("--")
+            ctx.meta[PASSTHROUGH] = args[at + 1 :]
+            args = args[:at]
+        return super().parse_args(ctx, args)
 
 
 @click.command(
+    cls=PassthroughCommand,
     help="List experiments, show one, list its runs, or run it."
     " `new [NAME]` creates one. With run, --PARAM=VALUE runs only the"
-    " matrix cells where that param has that value.",
+    " matrix cells where that param has that value, and anything after --"
+    " is appended to every run's command and recorded in run.json, so never"
+    " pass secrets there.",
     context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
 )
 @click.argument("name", required=False)
@@ -63,6 +76,7 @@ def experiments(
     experiment_config: Path | None,
     timeout: int | None,
 ) -> None:
+    passthrough: list[str] | None = ctx.meta.get(PASSTHROUGH)
     config = load_config(ctx)
     if config is None:
         raise click.ClickException(
@@ -82,7 +96,13 @@ def experiments(
             except ValueError as error:
                 raise click.UsageError(str(error)) from error
             start = remote_start(
-                config, name, experiment_config, concurrency, timeout, only
+                config,
+                name,
+                experiment_config,
+                concurrency,
+                timeout,
+                only,
+                passthrough or None,
             )
             try:
                 if sys.stdout.isatty() and sys.stderr.isatty():
@@ -101,6 +121,8 @@ def experiments(
             passed = len(results) - failed - retried
             click.echo(f"{passed} passed, {failed} failed.{again}")
             return
+    if passthrough is not None:
+        raise click.UsageError("-- ARGS needs run.")
     if ctx.args:
         raise click.UsageError(f"Unexpected {ctx.args[0]}. --PARAM=VALUE needs run.")
     if action not in (None, "runs"):

labnotes-0.0.124/src/labnotes/runner/check_args.py

@@ -0,0 +1,15 @@
+import shlex
+
+from labnotes.runner.flag_name import flag_name
+
+
+def check_args(params: dict[str, list[object]], command: str, args: list[str]) -> None:
+    taken = {flag_name(token) for token in shlex.split(command)}
+    for arg in args:
+        name = flag_name(arg)
+        if name is None:
+            continue
+        if name in params:
+            raise ValueError(f"--{name} is a param. Pick it with --{name}=VALUE.")
+        if name in taken:
+            raise ValueError(f"--{name} is already in the command.")

{labnotes-0.0.123 → labnotes-0.0.124}/src/labnotes/runner/execute_run.py

@@ -2,7 +2,7 @@ import asyncio
 import contextlib
 import os
 import time
-from collections.abc import Callable
+from collections.abc import Callable, Sequence
 from pathlib import Path
 
 import psutil
@@ -31,10 +31,11 @@ async def execute_run(
     stop: Callable[[], None] = lambda: None,
     stopped: Callable[[], bool] = lambda: False,
     meta: dict[str, object] | None = None,
+    args: Sequence[str] = (),
     *,
     memory_interval: float,
 ) -> dict[str, object]:
-    resolved = shell_command(command, folder, params)
+    resolved = shell_command(command, folder, params, args)
     run: dict[str, object] = {
         "params": params,
         "command": resolved,
@@ -45,6 +46,8 @@ async def execute_run(
         "ended_by": None,
         "signal": None,
     }
+    if args:
+        run["args"] = list(args)
     if retry_of is not None:
         run["retry_of"] = retry_of
     if meta is not None:

labnotes-0.0.124/src/labnotes/runner/flag_name.py

@@ -0,0 +1,4 @@
+def flag_name(token: str) -> str | None:
+    if not token.startswith("--"):
+        return None
+    return token.removeprefix("--").partition("=")[0] or None

{labnotes-0.0.123 → labnotes-0.0.124}/src/labnotes/runner/prepare_experiment.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
 from labnotes.models import ExperimentConfig, LabnotesConfig
+from labnotes.runner.check_args import check_args
 from labnotes.runner.check_subset import check_subset
 from labnotes.runner.read_experiment_config import read_experiment_config
 from labnotes.tables.file_text import file_text
@@ -12,6 +13,7 @@ async def prepare_experiment(
     experiment_config: Path | None,
     concurrency: int | None,
     only: dict[str, str] | None = None,
+    args: list[str] | None = None,
 ) -> tuple[ExperimentConfig, int]:
     if config.experiment not in (None, name):
         raise ValueError(
@@ -33,4 +35,6 @@ async def prepare_experiment(
     )
     if only:
         check_subset(experiment.params, only)
+    if args:
+        check_args(experiment.params, experiment.command, args)
     return experiment, experiment.concurrency if concurrency is None else concurrency

{labnotes-0.0.123 → labnotes-0.0.124}/src/labnotes/runner/run_experiment.py

@@ -38,6 +38,7 @@ async def run_experiment(
     timeout: float | None = None,
     retry_seconds: float = RETRY_SECONDS,
     only: dict[str, str] | None = None,
+    args: list[str] | None = None,
 ) -> list[dict[str, object]]:
     meta = None
     if experiment.meta is not None:
@@ -220,6 +221,7 @@ async def run_experiment(
             stop=lambda: kill(run),
             stopped=lambda: run in stopped,
             meta=meta,
+            args=args or (),
             memory_interval=experiment.memory_interval,
         )
         del running[run], trees[run]

labnotes-0.0.124/src/labnotes/runner/shell_command.py

@@ -0,0 +1,12 @@
+import shlex
+from collections.abc import Sequence
+from pathlib import Path
+
+from labnotes.runner.param_args import param_args
+
+
+def shell_command(
+    command: str, folder: Path, params: dict[str, object], args: Sequence[str] = ()
+) -> str:
+    filled = command.replace("{run_dir}", shlex.quote(str(folder)))
+    return f"{filled} {shlex.join([*param_args(params), *args])}".rstrip()

labnotes-0.0.123/src/labnotes/runner/shell_command.py

@@ -1,9 +0,0 @@
-import shlex
-from pathlib import Path
-
-from labnotes.runner.param_args import param_args
-
-
-def shell_command(command: str, folder: Path, params: dict[str, object]) -> str:
-    filled = command.replace("{run_dir}", shlex.quote(str(folder)))
-    return f"{filled} {shlex.join(param_args(params))}".rstrip()