labnotes 0.0.55__tar.gz → 0.0.57__tar.gz

{labnotes-0.0.55 → labnotes-0.0.57}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.55
+Version: 0.0.57
 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.55 → labnotes-0.0.57}/src/labnotes/create_app.py

@@ -6,7 +6,13 @@ from pathlib import Path
 from starlette.applications import Starlette
 from starlette.exceptions import HTTPException
 from starlette.requests import Request
-from starlette.responses import HTMLResponse, JSONResponse, Response
+from starlette.responses import (
+    HTMLResponse,
+    JSONResponse,
+    PlainTextResponse,
+    Response,
+    StreamingResponse,
+)
 from starlette.routing import Mount, Route
 from starlette.staticfiles import StaticFiles
 from starlette.templating import Jinja2Templates
@@ -14,6 +20,7 @@ from starlette.templating import Jinja2Templates
 from labnotes.asset_url import asset_url
 from labnotes.drain_watch import drain_watch
 from labnotes.experiment_notes import experiment_notes
+from labnotes.file_changes import file_changes
 from labnotes.format_duration import format_duration
 from labnotes.format_value import format_value
 from labnotes.list_experiments import list_experiments
@@ -74,9 +81,7 @@ def create_app(config: LabnotesConfig, kernel_idle_minutes: float) -> Starlette:
             request, "experiment.html", {"experiment": loaded}
         )
 
-    async def find_note(request: Request) -> dict[str, str]:
-        if request.headers.get("content-type") != "application/json":
-            raise HTTPException(415, "Send JSON")
+    async def read_note(request: Request) -> dict[str, str]:
         name = request.path_params["name"]
         note = request.path_params["note"]
         found = await experiment_notes(
@@ -87,6 +92,21 @@ def create_app(config: LabnotesConfig, kernel_idle_minutes: float) -> Starlette:
         [note] = found
         return note
 
+    async def find_note(request: Request) -> dict[str, str]:
+        if request.headers.get("content-type") != "application/json":
+            raise HTTPException(415, "Send JSON")
+        return await read_note(request)
+
+    async def get_note(request: Request) -> Response:
+        note = await read_note(request)
+        return PlainTextResponse(note["content"], media_type="text/markdown")
+
+    async def changes(request: Request) -> Response:
+        return StreamingResponse(
+            file_changes(request.app.state.tables, request.path_params["name"]),
+            media_type="text/event-stream",
+        )
+
     async def put_note(request: Request) -> Response:
         note = await find_note(request)
         body = await request.json()
@@ -119,6 +139,8 @@ def create_app(config: LabnotesConfig, kernel_idle_minutes: float) -> Starlette:
         routes=[
             Route("/", index),
             Route("/experiments/{name}", experiment),
+            Route("/experiments/{name}/changes", changes),
+            Route("/experiments/{name}/notes/{note:path}", get_note),
             Route("/experiments/{name}/notes/{note:path}", put_note, methods=["PUT"]),
             Route(
                 "/experiments/{name}/notes/{note:path}/run",

labnotes-0.0.57/src/labnotes/file_changes.py

@@ -0,0 +1,11 @@
+import json
+from collections.abc import AsyncIterator
+
+from dirsql import DirSQL
+
+
+async def file_changes(tables: DirSQL, experiment: str) -> AsyncIterator[str]:
+    async for event in tables.watch():
+        row = event.row or event.old_row
+        if event.table == "files" and row and row["experiment"] == experiment:
+            yield f"data: {json.dumps(row['filename'])}\n\n"

labnotes-0.0.57/src/labnotes/group_runs.py

@@ -0,0 +1,17 @@
+from labnotes.invocation_started import invocation_started
+
+
+def group_runs(runs: list[dict[str, object]]) -> list[dict[str, object]]:
+    groups: dict[str, list[dict[str, object]]] = {}
+    for run in runs:
+        groups.setdefault(str(run["id"]).partition("/")[0], []).append(run)
+    return [
+        {
+            "name": name,
+            "started": invocation_started(name),
+            "runs": members,
+            "passed": sum(1 for run in members if run["labnotes_completed"]),
+            "failed": sum(1 for run in members if not run["labnotes_completed"]),
+        }
+        for name, members in sorted(groups.items(), reverse=True)
+    ]

labnotes-0.0.57/src/labnotes/invocation_started.py

@@ -0,0 +1,11 @@
+import re
+
+STAMP = re.compile(r"(\d{4})(\d{2})(\d{2})-(\d{2})(\d{2})(\d{2})")
+
+
+def invocation_started(name: str) -> str | None:
+    found = STAMP.match(name)
+    if not found:
+        return None
+    year, month, day, hour, minute, second = found.groups()
+    return f"{year}-{month}-{day} {hour}:{minute}:{second}"

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/load_experiment.py

@@ -10,8 +10,10 @@ from labnotes.count_runs import count_runs
 from labnotes.experiment_notes import experiment_notes
 from labnotes.experiment_runs import experiment_runs
 from labnotes.format_value import format_value
+from labnotes.group_runs import group_runs
 from labnotes.list_runs import list_runs
 from labnotes.models import QueryParams
+from labnotes.nests_runs import nests_runs
 from labnotes.parse_run_view import parse_run_view
 from labnotes.python_blocks import python_blocks
 from labnotes.render_markdown import render_markdown
@@ -53,6 +55,8 @@ async def load_experiment(
     view = parse_run_view(params, shown, choices)
     [totals] = await count_runs(tables, source, str(summary["completed_run"]))
     notes = await experiment_notes(tables, root, name)
+    runs = await list_runs(tables, source, str(summary["completed_run"]), view)
+    nested = summary["mode"] == "adhoc" and await nests_runs(tables, source)
     return {
         "name": row["name"],
         "display_name": row["display_name"],
@@ -71,9 +75,8 @@ async def load_experiment(
             }
             for note in notes
         ],
-        "runs_list": await list_runs(
-            tables, source, str(summary["completed_run"]), view
-        ),
+        "runs_list": runs,
+        "run_groups": group_runs(runs) if nested else None,
         "run_columns": shown,
         "run_view": view,
         "run_choices": choices,

labnotes-0.0.57/src/labnotes/nests_runs.py

@@ -0,0 +1,10 @@
+from dirsql import DirSQL
+
+
+async def nests_runs(runs: DirSQL, source: str) -> bool:
+    found = await runs.query(
+        f"SELECT 1 FROM {source} WHERE instr(id, '/') > 0"
+        " GROUP BY substr(id, 1, instr(id, '/') - 1)"
+        " HAVING COUNT(*) > 1 LIMIT 1"
+    )
+    return bool(found)

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/static/experiment.js

@@ -11,7 +11,14 @@ if (summary) {
   dialog.querySelector(".config-close").addEventListener("click", () => dialog.close());
 }
 
+const expand = (group, open) => {
+  group.classList.toggle("open", open);
+  group.querySelector(".group-toggle").setAttribute("aria-expanded", String(open));
+};
+
 document.addEventListener("click", (event) => {
+  const header = event.target.closest(".group-row");
+  if (header) expand(header.parentElement, !header.parentElement.classList.contains("open"));
   const row = event.target.closest(".run-row");
   if (!row || getSelection().toString()) return;
   const record = row.nextElementSibling;
@@ -43,8 +50,13 @@ if (filters) {
     runs.querySelector(".narrowed")?.remove();
     const narrowed = fresh.querySelector(".narrowed");
     if (narrowed) runs.prepend(narrowed);
-    for (const part of ["thead tr:first-child", "tbody"]) {
-      runs.querySelector(part).replaceWith(fresh.querySelector(part));
+    runs.querySelector("thead tr").replaceWith(fresh.querySelector("thead tr"));
+    const table = runs.querySelector("table");
+    const opened = new Set([...table.querySelectorAll(".group.open")].map((group) => group.dataset.name));
+    for (const body of table.querySelectorAll("tbody")) body.remove();
+    for (const body of fresh.querySelectorAll("tbody")) {
+      table.append(body);
+      if (opened.has(body.dataset.name)) expand(body, true);
     }
     const summaries = fresh.querySelectorAll(".pick summary");
     runs.querySelectorAll(".pick summary").forEach((summary, index) => {

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/static/labnotes.css

@@ -316,6 +316,15 @@ h3 {
 .run-row:hover { background: color-mix(in srgb, var(--accent) 4%, transparent); }
 .run-row[aria-expanded="true"] { background: color-mix(in srgb, var(--accent) 6%, transparent); }
 .record-row td { background: var(--paper); }
+.group-row { cursor: pointer; background: var(--paper); }
+.group-row td { font-weight: 600; white-space: nowrap; }
+.group-row .good { color: var(--good); }
+.group-row .bad { color: var(--bad); }
+.group-toggle { font: inherit; color: inherit; background: none; border: 0; padding: 0; cursor: pointer; }
+.group-toggle::before { content: "▸"; display: inline-block; width: 1rem; color: var(--ink-3); }
+.group-toggle[aria-expanded="true"]::before { content: "▾"; }
+.group:not(.open) > :not(.group-row) { display: none; }
+.group.open .run-row td:nth-child(2) { padding-left: 2rem; }
 
 /* Notes */
 .note {

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/static/note-edit.js

@@ -4,6 +4,8 @@ if (note) {
   const prose = note.querySelector(".prose");
   const status = note.querySelector(".edit-status");
   const editor = import(note.dataset.editor);
+  let editing = null;
+
   editor.then(
     () => prose.classList.add("editable"),
     () => {
@@ -15,9 +17,15 @@ if (note) {
   const open = async (event) => {
     if (event.target.closest("a, button, output") || getSelection().toString()) return;
     const { edit } = await editor;
-    if (!prose.isConnected) return;
+    if (editing) return;
     prose.removeEventListener("click", open);
-    edit(note, prose, status);
+    editing = edit(note, prose, status);
   };
   prose.addEventListener("click", open);
+
+  new EventSource(note.dataset.changesUrl).addEventListener("message", (event) => {
+    if (JSON.parse(event.data) !== note.dataset.note) return;
+    if (editing) editing.pull();
+    else location.reload();
+  });
 }

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/static/note-editor.js

@@ -12,6 +12,7 @@ import { EditorState, RangeSetBuilder } from "@codemirror/state";
 import { Decoration, EditorView, ViewPlugin, keymap } from "@codemirror/view";
 import { tags } from "@lezer/highlight";
 import { GFM, parseCode, parser } from "@lezer/markdown";
+import { DIFF_DELETE, DIFF_EQUAL, diff_match_patch } from "diff-match-patch";
 
 // Built from @lezer/markdown rather than @codemirror/lang-markdown, which
 // imports HTML, CSS and JavaScript support that notes never use.
@@ -102,9 +103,27 @@ function show(status, message) {
   status.hidden = false;
 }
 
+const dmp = new diff_match_patch();
+
+// Three-way: what changed on disk since base, applied onto the editor's text.
+const merge = (base, ours, theirs) => dmp.patch_apply(dmp.patch_make(base, theirs), ours)[0];
+
+// Minimal changes, so the cursor and undo history survive.
+function setText(view, text) {
+  const changes = [];
+  let at = 0;
+  for (const [op, chunk] of dmp.diff_main(view.state.doc.toString(), text)) {
+    if (op === DIFF_EQUAL) at += chunk.length;
+    else if (op === DIFF_DELETE) {
+      changes.push({ from: at, to: at + chunk.length });
+      at += chunk.length;
+    } else changes.push({ from: at, insert: chunk });
+  }
+  if (changes.length) view.dispatch({ changes });
+}
+
 export function edit(note, prose, status) {
   let base = JSON.parse(note.querySelector(".note-source").textContent);
-  let stale = false;
   let timer;
   let queue = Promise.resolve();
 
@@ -112,31 +131,46 @@ export function edit(note, prose, status) {
   host.className = "editor";
   prose.replaceWith(host);
 
-  const save = () =>
-    (queue = queue
-      .then(async () => {
-        clearTimeout(timer);
-        const content = view.state.doc.toString();
-        if (stale || content === base) return;
-        const response = await fetch(note.dataset.saveUrl, {
-          method: "PUT",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({ base, content }),
-        });
-        if (response.status === 409) {
-          stale = true;
-          show(status, "This note changed on disk, so your edits are not saved. Copy them, then reload.");
-        } else if (response.ok) {
-          base = content;
-        } else {
-          show(status, `Not saved: ${response.status} ${response.statusText}`);
-        }
-      })
-      .catch((error) => show(status, `Not saved: ${error.message}`)));
+  const run = (task) =>
+    (queue = queue.then(task).catch((error) => show(status, `Not saved: ${error.message}`)));
+
+  const absorb = (theirs) => {
+    setText(view, merge(base, view.state.doc.toString(), theirs));
+    base = theirs;
+  };
+
+  const push = async () => {
+    clearTimeout(timer);
+    for (;;) {
+      const content = view.state.doc.toString();
+      if (content === base) return;
+      const response = await fetch(note.dataset.saveUrl, {
+        method: "PUT",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ base, content }),
+      });
+      if (response.status !== 409) {
+        if (response.ok) base = content;
+        else show(status, `Not saved: ${response.status} ${response.statusText}`);
+        return;
+      }
+      absorb((await response.json()).content);
+    }
+  };
+
+  const pull = async () => {
+    const response = await fetch(note.dataset.saveUrl, { cache: "no-store" });
+    if (!response.ok) return show(status, `Not synced: ${response.status} ${response.statusText}`);
+    const theirs = await response.text();
+    if (theirs === base) return;
+    absorb(theirs);
+    await push();
+  };
+
+  const save = () => run(push);
 
   const close = async () => {
     await save();
-    if (stale) return;
     document.removeEventListener("mousedown", outside);
     location.reload();
   };
@@ -166,4 +200,5 @@ export function edit(note, prose, status) {
     }),
   });
   view.focus();
+  return { pull: () => run(pull) };
 }

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/templates/editor_imports.html

@@ -16,6 +16,7 @@
     "@lezer/python": "https://esm.sh/*@lezer/python@1.1.19",
     "@marijn/find-cluster-break": "https://esm.sh/*@marijn/find-cluster-break@1.0.4",
     "crelt": "https://esm.sh/*crelt@1.0.7",
+    "diff-match-patch": "https://esm.sh/*diff-match-patch@1.0.5",
     "style-mod": "https://esm.sh/*style-mod@4.1.4",
     "w3c-keyname": "https://esm.sh/*w3c-keyname@2.2.8"
   }

{labnotes-0.0.55 → labnotes-0.0.57}/src/labnotes/templates/experiment.html

@@ -37,7 +37,7 @@
 <nav class="tabs sub">
   {% for each in e.notes %}<a href="?tab=notebooks&amp;note={{ each.name | urlencode }}"{% if each.name == note.name %} aria-current="page"{% endif %}>{{ each.name }}</a>{% endfor %}
 </nav>
-<article class="note" data-run-url="{{ url_for('run_block', name=e.name, note=note.name) }}" data-restart-url="{{ url_for('restart_kernel', name=e.name, note=note.name) }}" data-save-url="{{ url_for('put_note', name=e.name, note=note.name) }}" data-editor="{{ asset('note-editor.js') }}">
+<article class="note" data-run-url="{{ url_for('run_block', name=e.name, note=note.name) }}" data-restart-url="{{ url_for('restart_kernel', name=e.name, note=note.name) }}" data-save-url="{{ url_for('put_note', name=e.name, note=note.name) }}" data-editor="{{ asset('note-editor.js') }}" data-changes-url="{{ url_for('changes', name=e.name) }}" data-note="{{ note.name }}">
   {% if note.runnable %}<header class="note-name"><button type="button" class="restart" title="Stop this note's Python kernel. The next Run starts a fresh one.">Restart</button></header>{% endif %}
   <p class="edit-status" role="status" hidden></p>
   <div class="prose">{{ note.html | safe }}</div>
@@ -52,6 +52,8 @@
 {% else %}
 <section id="runs">
   {% set view = e.run_view %}
+  {% set nested = e.run_groups is not none %}
+  {% set width = e.run_columns | length + (2 if nested else 1) %}
   {% set narrowed = view.status or view.filters or view.picked %}
   {% if narrowed %}<p class="narrowed"><span class="num">{{ e.runs_list | length }}</span> of <span class="num">{{ e.runs }}</span> <a class="clear" href="{{ '?sort=' ~ (view.sort | urlencode) ~ ('&order=desc' if view.descending else '') if view.sort else '?' }}#runs">Clear filters</a></p>{% endif %}
   {% if e.runs %}
@@ -67,6 +69,7 @@
         {% for column in ['status'] + e.run_columns %}
         {% set sorted = view.sort == column %}
         <th scope="col"{% if sorted %} aria-sort="{{ 'descending' if view.descending else 'ascending' }}"{% endif %}><a class="sort{{ ' sorted' if sorted }}" href="{{ e.sort_hrefs[column] }}" title="Sort by {{ column }}">{{ '' if column == 'status' else column }}{% if sorted %}<span class="arrow">{{ '↓' if view.descending else '↑' }}</span>{% endif %}</a></th>
+        {% if nested and column == 'id' %}<th scope="col">runs</th>{% endif %}
         {% endfor %}
       </tr>
       <tr class="filters">
@@ -78,17 +81,16 @@
         {% for column in e.run_columns %}<td>{% if column in e.run_choices %}{% set picked = view.picked.get(column, {}) %}<details class="pick">
           <summary aria-label="Filter {{ column }}">{{ picked | join(', ') if picked else 'all' }}</summary>
           <div class="options">{% for label in e.run_choices[column] %}<label><input form="run-filters" type="checkbox" name="f.{{ column }}" value="{{ label }}"{{ ' checked' if label in picked }}> {{ label }}</label>{% endfor %}</div>
-        </details>{% else %}<input form="run-filters" type="search" name="f.{{ column }}" value="{{ view.filters.get(column, '') }}" placeholder="filter" aria-label="Filter {{ column }}">{% endif %}</td>{% endfor %}
+        </details>{% else %}<input form="run-filters" type="search" name="f.{{ column }}" value="{{ view.filters.get(column, '') }}" placeholder="filter" aria-label="Filter {{ column }}">{% endif %}</td>{% if nested and loop.first %}<td></td>{% endif %}{% endfor %}
       </tr>
     </thead>
-    <tbody>
-      {% for run in e.runs_list %}
+    {% macro run_rows(run) %}
       <tr class="run-row" aria-expanded="false">
         <td><span class="status {{ 'good' if run.labnotes_completed else 'bad' }}" title="{{ 'complete' if run.labnotes_completed else 'not complete' }}">{{ '✓' if run.labnotes_completed else '✕' }}</span></td>
-        {% for column in e.run_columns %}<td class="{{ 'mono' if loop.first }}{{ 'num' if column == 'duration' }}">{{ run[column] | duration if column == 'duration' else run[column] | value }}</td>{% endfor %}
+        {% for column in e.run_columns %}{% if column == 'id' and nested %}<td class="mono">{{ run.id.partition('/')[2] or run.id }}</td><td></td>{% else %}<td class="{{ 'mono' if loop.first }}{{ 'num' if column == 'duration' }}">{{ run[column] | duration if column == 'duration' else run[column] | value }}</td>{% endif %}{% endfor %}
       </tr>
       <tr class="record-row" hidden>
-        <td colspan="{{ e.run_columns | length + 1 }}">
+        <td colspan="{{ width }}">
           <dl class="record">
             {% for key, value in run.items() if key != 'labnotes_completed' %}
             <dt>{{ key }}</dt>
@@ -98,10 +100,29 @@
           </dl>
         </td>
       </tr>
+    {% endmacro %}
+    {% if nested %}
+    {% for group in e.run_groups %}
+    <tbody class="group" data-name="{{ group.name }}">
+      <tr class="group-row">
+        <td class="num" title="{{ group.passed }} passed, {{ group.failed }} failed"><span class="good">{{ group.passed }}✓</span> <span class="bad">{{ group.failed }}✕</span></td>
+        <td class="mono"><button type="button" class="group-toggle" aria-expanded="false">{{ group.name }}</button></td>
+        <td class="num">{{ group.runs | length }}</td>
+        {% for column in e.run_columns[1:] %}<td>{{ group.started or '' if column == 'started' }}</td>{% endfor %}
+      </tr>
+      {% for run in group.runs %}{{ run_rows(run) }}{% endfor %}
+    </tbody>
+    {% else %}
+    <tbody><tr><td class="empty" colspan="{{ width }}">No runs match these filters.</td></tr></tbody>
+    {% endfor %}
+    {% else %}
+    <tbody>
+      {% for run in e.runs_list %}{{ run_rows(run) }}
       {% else %}
-      <tr><td class="empty" colspan="{{ e.run_columns | length + 1 }}">No runs match these filters.</td></tr>
+      <tr><td class="empty" colspan="{{ width }}">No runs match these filters.</td></tr>
       {% endfor %}
     </tbody>
+    {% endif %}
   </table>
   </div>
   {% else %}

{labnotes-0.0.55 → labnotes-0.0.57}/testing-conventions.toml

@@ -15,3 +15,9 @@ path = "src/labnotes/runner/run_experiment.py"
 rules = ["mutation"]
 lines = [47]
 reason = "mode is validated to fill or adhoc; \"fill\" <= \"adhoc\" is false like ==, and both are interned literals so is equals =="
+
+[[python.exempt]]
+path = "src/labnotes/load_experiment.py"
+rules = ["mutation"]
+lines = [59]
+reason = "summarize_config returns mode fill or adhoc; \"fill\" <= \"adhoc\" is false like ==, and both are interned literals so is equals =="