labnotes 0.0.66__tar.gz → 0.0.67__tar.gz

{labnotes-0.0.66 → labnotes-0.0.67}/PKG-INFO

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

@@ -28,13 +28,14 @@ from labnotes.format_value import format_value
 from labnotes.list_experiments import list_experiments
 from labnotes.load_experiment import load_experiment
 from labnotes.models import LabnotesConfig
+from labnotes.note_path import note_path
 from labnotes.notebook_kernel import NotebookKernel
 from labnotes.python_blocks import python_blocks
+from labnotes.render_markdown import render_markdown
 from labnotes.save_conflict_copy import save_conflict_copy
 from labnotes.save_note import save_note
 from labnotes.saved_outputs import saved_outputs
 from labnotes.tables.open_tables import open_tables
-from labnotes.wait_for_note import wait_for_note
 
 HERE = Path(__file__).parent
 templates = Jinja2Templates(directory=HERE / "templates")
@@ -100,13 +101,24 @@ def create_app(config: LabnotesConfig) -> Starlette:
         if request.headers.get("content-type") != "application/json":
             raise HTTPException(415, "Send JSON")
         name = request.path_params["name"]
-        filename = create_note(config, name)
-        if filename is None:
+        path = create_note(config, name)
+        if path is None:
             raise HTTPException(404, "No such experiment")
-        await wait_for_note(request.app.state.tables, config.root, name, filename)
-        page = request.url_for("experiment", name=name)
-        url = page.include_query_params(tab="notebooks", note=filename)
-        return JSONResponse({"url": f"{url.path}?{url.query}#edit"}, status_code=201)
+        content = path.read_text(encoding="utf-8")
+        return templates.TemplateResponse(
+            request,
+            "note.html",
+            {
+                "e": {"name": name},
+                "note": {
+                    "name": path.name,
+                    "content": content,
+                    "html": render_markdown(content, ()),
+                    "runnable": bool(python_blocks(content)),
+                },
+            },
+            status_code=201,
+        )
 
     async def get_note(request: Request) -> Response:
         note = await read_note(request)
@@ -118,23 +130,33 @@ def create_app(config: LabnotesConfig) -> Starlette:
             media_type="text/event-stream",
         )
 
+    def note_file(request: Request) -> Path:
+        if request.headers.get("content-type") != "application/json":
+            raise HTTPException(415, "Send JSON")
+        path = note_path(
+            config, request.path_params["name"], request.path_params["note"]
+        )
+        if path is None:
+            raise HTTPException(404, "No such note")
+        return path
+
     async def put_note(request: Request) -> Response:
-        note = await find_note(request)
+        path = note_file(request)
         body = await request.json()
         base, content = body.get("base"), body.get("content")
         if not isinstance(base, str) or not isinstance(content, str):
             raise HTTPException(400, "Send base and content as strings")
-        current = save_note(Path(note["path"]), base, content)
+        current = save_note(path, base, content)
         if current is not None:
             return JSONResponse({"content": current}, status_code=409)
         return Response(status_code=204)
 
     async def post_conflict(request: Request) -> Response:
-        note = await find_note(request)
+        path = note_file(request)
         content = (await request.json()).get("content")
         if not isinstance(content, str):
             raise HTTPException(400, "Send content as a string")
-        copy = save_conflict_copy(Path(note["path"]), content, datetime.now())
+        copy = save_conflict_copy(path, content, datetime.now())
         return JSONResponse({"name": copy.name}, status_code=201)
 
     async def run_block(request: Request) -> Response:

{labnotes-0.0.66 → labnotes-0.0.67}/src/labnotes/create_note.py

@@ -4,7 +4,7 @@ from labnotes.models import LabnotesConfig
 from labnotes.tables.file_prefix import file_prefix
 
 
-def create_note(config: LabnotesConfig, experiment: str) -> str | None:
+def create_note(config: LabnotesConfig, experiment: str) -> Path | None:
     def folder(template: str) -> Path:
         return config.root / template.replace("{experiment}", experiment)
 
@@ -17,7 +17,7 @@ def create_note(config: LabnotesConfig, experiment: str) -> str | None:
         try:
             with (notes / filename).open("x", encoding="utf-8") as note:
                 note.write("# Untitled\n")
-            return filename
+            return notes / filename
         except FileExistsError:
             n += 1
             filename = f"Untitled {n}.md"

labnotes-0.0.67/src/labnotes/note_path.py

@@ -0,0 +1,16 @@
+from pathlib import Path, PurePosixPath
+
+from labnotes.models import LabnotesConfig
+from labnotes.tables.file_prefix import file_prefix
+from labnotes.tables.path_pattern import path_pattern
+
+
+def note_path(config: LabnotesConfig, experiment: str, note: str) -> Path | None:
+    relative = file_prefix(config.files).replace("{experiment}", experiment) + note
+    if ".." in PurePosixPath(relative).parts or not note.endswith(".md"):
+        return None
+    found = path_pattern(config.files).fullmatch(relative)
+    if found is None or found["experiment"] != experiment:
+        return None
+    path = config.root / relative
+    return path if path.is_relative_to(config.root) and path.is_file() else None

labnotes-0.0.67/src/labnotes/static/new-note.js

@@ -0,0 +1,43 @@
+function show(note, button) {
+  let tabs = document.querySelector(".tabs.sub");
+  if (!tabs) {
+    tabs = document.createElement("nav");
+    tabs.className = "tabs sub";
+    button.closest(".empty").replaceWith(tabs);
+    tabs.append(button);
+  }
+  const search = `?tab=notebooks&note=${encodeURIComponent(note.dataset.note)}`;
+  const link = document.createElement("a");
+  link.href = search;
+  link.textContent = note.dataset.note;
+  link.setAttribute("aria-current", "page");
+  for (const other of tabs.querySelectorAll("a")) other.removeAttribute("aria-current");
+  button.before(link);
+  const count = document.querySelector(".tabs:not(.sub) [aria-current] .count");
+  count.textContent = Number(count.textContent) + 1;
+  const old = document.querySelector(".note");
+  if (old) old.replaceWith(note);
+  else tabs.after(note);
+  history.replaceState(null, "", search);
+}
+
+for (const button of document.querySelectorAll(".new-note")) {
+  // An open editor closes, and reloads the page, on a mousedown outside it.
+  button.addEventListener("mousedown", (event) => event.stopPropagation());
+  button.addEventListener("click", async () => {
+    button.disabled = true;
+    const response = await fetch(button.dataset.url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: "{}",
+    });
+    button.disabled = false;
+    if (!response.ok) return;
+    const holder = document.createElement("template");
+    holder.innerHTML = await response.text();
+    const note = holder.content.querySelector(".note");
+    const { attach } = await import(button.dataset.module);
+    show(note, button);
+    attach(note, true);
+  });
+}

{labnotes-0.0.66 → labnotes-0.0.67}/src/labnotes/static/note-edit.js

@@ -1,11 +1,13 @@
-const note = document.querySelector(".note[data-save-url]");
+let detach = () => {};
 
-if (note) {
+export function attach(note, openNow) {
+  detach();
   const prose = note.querySelector(".prose");
   const status = note.querySelector(".edit-status");
   const editor = import(note.dataset.editor);
   const source = JSON.parse(note.querySelector(".note-source").textContent);
   let editing = null;
+  let attached = true;
 
   editor.then(
     () => prose.classList.add("editable"),
@@ -18,17 +20,15 @@ if (note) {
   const open = async (event) => {
     if (event.target.closest("a, button, output") || getSelection().toString()) return;
     const { edit } = await editor;
-    if (editing) return;
+    if (editing || !attached) return;
     prose.removeEventListener("click", open);
     editing = edit(note, prose, status);
   };
   prose.addEventListener("click", open);
-  if (location.hash === "#edit") {
-    history.replaceState(null, "", location.pathname + location.search);
-    open({ target: prose });
-  }
+  if (openNow) open({ target: prose });
 
-  new EventSource(note.dataset.changesUrl).addEventListener("message", (event) => {
+  const changes = new EventSource(note.dataset.changesUrl);
+  changes.addEventListener("message", (event) => {
     if (JSON.parse(event.data) !== note.dataset.note) return;
     if (editing) return editing.pull();
     // A touch or a duplicate event leaves the text alone, and reloading then
@@ -39,4 +39,13 @@ if (note) {
         if (text !== source) location.reload();
       });
   });
+
+  detach = () => {
+    attached = false;
+    changes.close();
+    editing?.detach();
+  };
 }
+
+const note = document.querySelector(".note[data-save-url]");
+if (note) attach(note, false);

{labnotes-0.0.66 → labnotes-0.0.67}/src/labnotes/static/note-editor.js

@@ -228,5 +228,11 @@ export function edit(note, prose, status) {
     }),
   });
   view.focus();
-  return { pull: () => run(pull) };
+  return {
+    pull: () => run(pull),
+    detach: () => {
+      document.removeEventListener("mousedown", outside);
+      save();
+    },
+  };
 }

{labnotes-0.0.66 → labnotes-0.0.67}/src/labnotes/templates/experiment.html

@@ -35,21 +35,16 @@
 {% set note = (e.notes | selectattr('name', 'equalto', chosen) | first) or (e.notes | first) %}
 {% if note %}
 <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 %}<button type="button" class="new-note" data-url="{{ url_for('post_note', name=e.name) }}" aria-label="New note" title="New note">+</button>
+  {% 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 %}<button type="button" class="new-note" data-url="{{ url_for('post_note', name=e.name) }}" data-module="{{ asset('note-edit.js') }}" aria-label="New note" title="New note">+</button>
 </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-conflict-url="{{ url_for('post_conflict', 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>
-  <script type="application/json" class="note-source">{{ note.content | tojson }}</script>
-</article>
-{% include "editor_imports.html" %}
+{% include "note.html" %}
 <script src="{{ asset('run-cell.js') }}" defer></script>
-<script type="module" src="{{ asset('note-edit.js') }}"></script>
 {% else %}
-<p class="empty">No notebooks yet. <button type="button" class="new-note" data-url="{{ url_for('post_note', name=e.name) }}" aria-label="New note" title="New note">+</button></p>
+<p class="empty">No notebooks yet. <button type="button" class="new-note" data-url="{{ url_for('post_note', name=e.name) }}" data-module="{{ asset('note-edit.js') }}" aria-label="New note" title="New note">+</button></p>
 {% endif %}
-<script src="{{ asset('new-note.js') }}" defer></script>
+{% include "editor_imports.html" %}
+<script type="module" src="{{ asset('note-edit.js') }}"></script>
+<script type="module" src="{{ asset('new-note.js') }}"></script>
 {% else %}
 <section id="runs">
   {% set view = e.run_view %}

labnotes-0.0.67/src/labnotes/templates/note.html

@@ -0,0 +1,6 @@
+<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-conflict-url="{{ url_for('post_conflict', 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>
+  <script type="application/json" class="note-source">{{ note.content | tojson }}</script>
+</article>

labnotes-0.0.66/src/labnotes/static/new-note.js

@@ -1,12 +0,0 @@
-for (const button of document.querySelectorAll(".new-note")) {
-  button.addEventListener("click", async () => {
-    button.disabled = true;
-    const response = await fetch(button.dataset.url, {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: "{}",
-    });
-    if (response.ok) location.assign((await response.json()).url);
-    else button.disabled = false;
-  });
-}

labnotes-0.0.66/src/labnotes/wait_for_note.py

@@ -1,13 +0,0 @@
-import asyncio
-from pathlib import Path
-
-from dirsql import DirSQL
-
-from labnotes.experiment_notes import experiment_notes
-
-
-async def wait_for_note(tables: DirSQL, root: Path, experiment: str, note: str) -> None:
-    for _ in range(40):
-        if await experiment_notes(tables, root, experiment, note):
-            return
-        await asyncio.sleep(0.05)