labnotes 0.0.94__tar.gz → 0.0.96__tar.gz

{labnotes-0.0.94 → labnotes-0.0.96}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.94
+Version: 0.0.96
 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.96/src/labnotes/__init__.py

@@ -0,0 +1,3 @@
+from labnotes.log import log
+
+__all__ = ["log"]

labnotes-0.0.96/src/labnotes/log.py

@@ -0,0 +1,23 @@
+import json
+from datetime import UTC, datetime
+
+from labnotes.log_path import log_path
+
+
+def now() -> str:
+    return datetime.now(UTC).isoformat(timespec="milliseconds").replace("+00:00", "Z")
+
+
+def log(block: dict[str, object]) -> None:
+    """Write a block to the run's log, or print its content outside a run.
+
+    Scripts import this, so the module stays standard-library only.
+    """
+    path = log_path()
+    if path is None:
+        if "content" in block:
+            print(block["content"])
+        return
+    line = json.dumps({**block, "timestamp": now()})
+    with path.open("a", encoding="utf-8") as file:
+        file.write(f"{line}\n")

labnotes-0.0.96/src/labnotes/log_path.py

@@ -0,0 +1,10 @@
+import os
+from pathlib import Path
+
+# The one env contract between runner and script; config is otherwise never env.
+LOG_ENV = "LABNOTES_LOG"
+
+
+def log_path() -> Path | None:
+    value = os.environ.get(LOG_ENV)
+    return Path(value) if value else None

{labnotes-0.0.94 → labnotes-0.0.96}/src/labnotes/runner/execute_run.py

@@ -5,6 +5,7 @@ from pathlib import Path
 
 import psutil
 
+from labnotes.log_path import LOG_ENV
 from labnotes.runner.shell_command import shell_command
 from labnotes.runner.wait_for_tree import wait_for_tree
 from labnotes.runner.write_run_json import write_run_json
@@ -36,7 +37,12 @@ async def execute_run(
             process = await asyncio.create_subprocess_shell(
                 shell_command(command, folder, params),
                 cwd=root,
-                env={"FORCE_COLOR": "1", "CLICOLOR_FORCE": "1", **os.environ},
+                env={
+                    "FORCE_COLOR": "1",
+                    "CLICOLOR_FORCE": "1",
+                    **os.environ,
+                    LOG_ENV: str(folder / "log.jsonl"),
+                },
                 stdout=stdout,
                 stderr=stderr,
             )

labnotes-0.0.96/src/labnotes/tui/run_output.py

@@ -0,0 +1,61 @@
+import codecs
+from pathlib import Path
+
+from rich.text import Text
+from textual.geometry import Size
+from textual.widgets import RichLog
+
+STREAMS = ("stdout", "stderr")
+
+
+class RunOutput(RichLog):
+    def __init__(self, id: str | None = None) -> None:
+        super().__init__(id=id)
+        self.reset()
+
+    def reset(self) -> None:
+        self.offsets = dict.fromkeys(STREAMS, 0)
+        self.decoders = {
+            stream: codecs.getincrementaldecoder("utf-8")(errors="replace")
+            for stream in STREAMS
+        }
+        self.last_stream: str | None = None
+        self.unfinished = ""
+        self.clear()
+
+    @property
+    def mid_line(self) -> bool:
+        return bool(self.unfinished)
+
+    def follow(self, folder: Path) -> None:
+        for stream in STREAMS:
+            path = folder / f"{stream}.log"
+            if not path.exists():
+                continue
+            with path.open("rb") as log:
+                log.seek(self.offsets[stream])
+                data = log.read()
+            self.offsets[stream] += len(data)
+            text = self.decoders[stream].decode(data)
+            if not text:
+                continue
+            # A stream's unfinished line is redrawn as it grows, but the
+            # other stream's output starts below it.
+            if self.mid_line and stream == self.last_stream:
+                self.drop_last_line()
+                text = self.unfinished + text
+            *complete, self.unfinished = text.split("\n")
+            if complete:
+                self.write(Text.from_ansi("\n".join(complete)))
+            if self.unfinished:
+                self.write(Text.from_ansi(self.unfinished))
+            self.last_stream = stream
+
+    def drop_last_line(self) -> None:
+        if not self._size_known:
+            self._deferred_renders.pop()
+            return
+        del self.lines[-1]
+        self._line_cache.clear()
+        self.virtual_size = Size(self.virtual_size.width, len(self.lines))
+        self.refresh()

{labnotes-0.0.94 → labnotes-0.0.96}/testing-conventions.toml

@@ -7,8 +7,8 @@ reason = "LOCK_EX and LOCK_NB are disjoint bits, so | equals + and ^"
 [[python.exempt]]
 path = "src/labnotes/tui/run_output.py"
 rules = ["mutation"]
-lines = [37]
-reason = "last_stream is always the same str object taken from STREAMS, so is not equals !="
+lines = [44]
+reason = "last_stream is always the same str object taken from STREAMS, so is equals =="
 
 [[python.exempt]]
 path = "src/labnotes/load_experiment.py"

labnotes-0.0.94/src/labnotes/tui/run_output.py

@@ -1,41 +0,0 @@
-import codecs
-from pathlib import Path
-
-from textual.widgets import Log
-
-STREAMS = ("stdout", "stderr")
-
-
-class RunOutput(Log):
-    def __init__(self, id: str | None = None) -> None:
-        super().__init__(id=id)
-        self.reset()
-
-    def reset(self) -> None:
-        self.offsets = dict.fromkeys(STREAMS, 0)
-        self.decoders = {
-            stream: codecs.getincrementaldecoder("utf-8")(errors="replace")
-            for stream in STREAMS
-        }
-        self.last_stream: str | None = None
-        self.mid_line = False
-        self.clear()
-
-    def follow(self, folder: Path) -> None:
-        for stream in STREAMS:
-            path = folder / f"{stream}.log"
-            if not path.exists():
-                continue
-            with path.open("rb") as log:
-                log.seek(self.offsets[stream])
-                data = log.read()
-            self.offsets[stream] += len(data)
-            text = self.decoders[stream].decode(data)
-            if not text:
-                continue
-            # Don't glue one stream's unfinished line onto the other's output.
-            if self.mid_line and stream != self.last_stream:
-                text = "\n" + text
-            self.write(text)
-            self.last_stream = stream
-            self.mid_line = not text.endswith("\n")