datasette-agent-edit 0.1a0__py3-none-any.whl

datasette_agent_edit/__init__.py

@@ -0,0 +1,57 @@
+"""Storage-agnostic file-editing tools for Datasette Agent plugins.
+
+Three layers:
+
+1. :mod:`datasette_agent_edit.operations` -- pure string-editing primitives.
+2. :mod:`datasette_agent_edit.store` -- the :class:`EditStore` backend seam,
+   plus ready-made :class:`SqliteVersionedStore` / :class:`DiskStore` backends.
+3. :class:`EditToolset` -- builds Datasette Agent tools over any backend with
+   a single consistent JSON envelope and optional presentation hook.
+"""
+
+from .operations import (
+    EditApplyError,
+    EditError,
+    apply_edit,
+    apply_edits,
+    insert,
+    str_replace,
+    view_lines,
+)
+from .store import (
+    AsyncTransformStore,
+    Conflict,
+    Editable,
+    EditStore,
+    IdCodec,
+    NotFound,
+    PrefixCodec,
+    Transform,
+)
+from .stores import DiskStore, SqliteVersionedStore
+from .toolset import EditToolset
+
+__all__ = [
+    # operations
+    "view_lines",
+    "str_replace",
+    "insert",
+    "apply_edit",
+    "apply_edits",
+    "EditError",
+    "EditApplyError",
+    # store
+    "Editable",
+    "EditStore",
+    "AsyncTransformStore",
+    "Transform",
+    "IdCodec",
+    "PrefixCodec",
+    "NotFound",
+    "Conflict",
+    # backends
+    "SqliteVersionedStore",
+    "DiskStore",
+    # toolset
+    "EditToolset",
+]

datasette_agent_edit/operations.py

@@ -0,0 +1,120 @@
+"""Pure, storage-agnostic text-editing primitives.
+
+These functions operate on plain strings and never touch a storage backend,
+an event loop, or a Datasette instance. They are the in-memory "surgery" that
+a backend's atomic ``edit()`` critical section applies to content. Keeping
+them pure is what lets the same editing behaviour run unchanged inside a
+SQLite write thread, a disk file lock, or an S3/GitHub compare-and-set loop.
+"""
+
+
+class EditError(ValueError):
+    """Raised when an edit cannot be applied to the given content.
+
+    Subclasses ``ValueError`` so existing ``except ValueError`` handlers (and
+    the test-suite's ``pytest.raises(ValueError, ...)`` expectations) keep
+    working.
+    """
+
+
+class EditApplyError(EditError):
+    """Raised by :func:`apply_edits` when one edit in a batch fails.
+
+    Carries the list of human-readable descriptions of the edits that did
+    succeed before the failure, plus the zero-based index of the edit that
+    failed, so callers can report partial progress without re-deriving it.
+    """
+
+    def __init__(self, message, applied, index):
+        super().__init__(message)
+        self.applied = applied
+        self.index = index
+
+
+def view_lines(content, view_range=""):
+    """Format ``content`` as numbered lines, optionally sliced to a range.
+
+    ``view_range`` is a string ``"start,end"`` (1-indexed, inclusive). An end
+    of ``-1`` means end-of-file. An empty string returns every line.
+    """
+    all_lines = content.splitlines(True)
+    total_lines = len(all_lines)
+
+    if view_range:
+        parts = view_range.split(",")
+        start = int(parts[0])
+        end = int(parts[1])
+        if end == -1:
+            end = total_lines
+        lines = all_lines[start - 1 : end]
+        start_num = start
+    else:
+        lines = all_lines
+        start_num = 1
+
+    numbered = []
+    for i, line in enumerate(lines, start=start_num):
+        numbered.append(f"{i}:\t{line.rstrip()}")
+    return "\n".join(numbered)
+
+
+def str_replace(content, old_str, new_str):
+    """Replace exactly one occurrence of ``old_str`` in ``content``.
+
+    Raises :class:`EditError` if ``old_str`` is absent or appears more than
+    once (the caller should add surrounding context to disambiguate).
+    """
+    count = content.count(old_str)
+    if count == 0:
+        raise EditError("old_str not found in content")
+    if count > 1:
+        raise EditError(f"old_str appears {count} times in content; must be unique")
+    return content.replace(old_str, new_str, 1)
+
+
+def insert(content, insert_line, insert_text):
+    """Insert ``insert_text`` after line number ``insert_line``.
+
+    ``insert_line=0`` inserts at the very beginning of the content.
+    """
+    lines = content.splitlines(True)
+    insert_pieces = insert_text.splitlines(True)
+    new_lines = lines[:insert_line] + insert_pieces + lines[insert_line:]
+    return "".join(new_lines)
+
+
+def apply_edit(content, edit):
+    """Apply a single ``{"operation": ..., ...}`` edit dict to ``content``.
+
+    Supported operations:
+
+    - ``str_replace``: keys ``old_str``, ``new_str``
+    - ``insert``: keys ``insert_line``, ``insert_text``
+    """
+    op = edit.get("operation")
+    if op == "str_replace":
+        return str_replace(content, edit["old_str"], edit["new_str"])
+    if op == "insert":
+        return insert(content, edit["insert_line"], edit["insert_text"])
+    raise EditError(
+        f"unknown operation {op!r}. Use 'str_replace' or 'insert'."
+    )
+
+
+def apply_edits(content, edits):
+    """Apply a sequence of edit dicts, returning ``(new_content, applied)``.
+
+    Edits are applied in order, so each edit sees the result of the previous
+    one. If any edit fails, an :class:`EditApplyError` is raised before any
+    result is returned, so callers can treat the batch as all-or-nothing.
+    ``applied`` is a list of strings like ``"str_replace #1: OK"``.
+    """
+    applied = []
+    for i, edit in enumerate(edits):
+        op = edit.get("operation")
+        try:
+            content = apply_edit(content, edit)
+        except EditError as e:
+            raise EditApplyError(str(e), applied=applied, index=i) from e
+        applied.append(f"{op} #{i + 1}: OK")
+    return content, applied

datasette_agent_edit/store.py

@@ -0,0 +1,139 @@
+"""The storage seam: :class:`EditStore` and its supporting types.
+
+A backend is anything that can create, read and atomically transform a piece
+of text content addressed by a ``ref``. The defining method is
+:meth:`EditStore.edit`, which takes a *synchronous, pure* ``transform``
+callable and is responsible for running it inside whatever critical section
+the backend needs (a SQLite write transaction, a file lock, an S3/GitHub
+compare-and-set retry loop). Because the transform contains no I/O and no
+awaits, the same editing logic is safe inside any of those contexts.
+"""
+
+from dataclasses import dataclass, field
+from typing import Any, Awaitable, Callable, Optional
+
+try:
+    from typing import Protocol, runtime_checkable
+except ImportError:  # pragma: no cover - py<3.8 fallback
+    from typing_extensions import Protocol, runtime_checkable
+
+
+#: A pure, synchronous content transform: old content in, new content out.
+#: It must not perform I/O or await; raise :class:`~.operations.EditError`
+#: (a ``ValueError``) to abort the edit before anything is persisted.
+Transform = Callable[[str], str]
+
+#: An async transform, for the optional :class:`AsyncTransformStore` capability.
+AsyncTransform = Callable[[str], Awaitable[str]]
+
+
+class NotFound(Exception):
+    """Raised by a store when ``ref`` does not identify existing content."""
+
+
+class Conflict(Exception):
+    """Raised when an atomic edit could not be committed due to contention.
+
+    Backends that implement optimistic concurrency (S3 ``If-Match``, the
+    GitHub contents API ``sha``) raise this after exhausting their retries.
+    """
+
+
+@dataclass
+class Editable:
+    """A snapshot of stored content plus its addressing and bookkeeping.
+
+    ``version`` is an opaque token whose meaning is backend-defined: an
+    incrementing integer for a versioned SQLite store, an mtime for a disk
+    file, an ETag or git blob SHA for object stores. The toolset only echoes
+    it back to the model and (optionally) uses it for display; it never
+    interprets it.
+    """
+
+    ref: str
+    content: str
+    metadata: dict = field(default_factory=dict)
+    version: Any = None
+
+
+@runtime_checkable
+class EditStore(Protocol):
+    """The interface every storage backend implements."""
+
+    async def create(
+        self, content: str, *, ref: Optional[str] = None, metadata: Optional[dict] = None
+    ) -> Editable:
+        """Create new content and return its :class:`Editable`.
+
+        ``ref`` may be supplied for path-addressed backends (disk, S3,
+        GitHub); id-generating backends (SQLite) generate one when it is
+        ``None``.
+        """
+        ...
+
+    async def read(self, ref: str) -> Editable:
+        """Return the current :class:`Editable` for ``ref``.
+
+        Raises :class:`NotFound` if it does not exist.
+        """
+        ...
+
+    async def edit(self, ref: str, transform: Transform) -> Editable:
+        """Atomically apply ``transform`` to the content at ``ref``.
+
+        The backend reads the current content, applies ``transform`` inside
+        its critical section, persists the result and returns the new
+        :class:`Editable`. If ``transform`` raises, nothing is persisted.
+        Raises :class:`NotFound` if ``ref`` does not exist and
+        :class:`Conflict` if the write could not be committed.
+        """
+        ...
+
+    async def delete(self, ref: str) -> None:
+        """Delete the content at ``ref`` (raising :class:`NotFound` if absent)."""
+        ...
+
+
+@runtime_checkable
+class AsyncTransformStore(Protocol):
+    """Opt-in capability for the rare backend that can await mid-edit.
+
+    Most backends cannot (a SQLite write transform runs on a non-async write
+    thread), so this is deliberately separate from :class:`EditStore`. The
+    :class:`~.toolset.EditToolset` never calls it; it exists for specialised
+    callers whose edit decision must consult something asynchronously and who
+    cannot pre-resolve that work before calling :meth:`EditStore.edit`.
+    """
+
+    async def aedit(self, ref: str, transform: AsyncTransform) -> Editable:
+        ...
+
+
+class IdCodec:
+    """Translates between the internal ``ref`` and the id the model sees.
+
+    The default is an identity mapping. Subclass (or use :class:`PrefixCodec`)
+    to expose, for example, ``artifact-01J...`` externally while storing the
+    bare ULID internally.
+    """
+
+    def to_external(self, ref: str) -> str:
+        return ref
+
+    def to_internal(self, external_id: str) -> str:
+        return external_id
+
+
+class PrefixCodec(IdCodec):
+    """An :class:`IdCodec` that adds/strips a fixed prefix."""
+
+    def __init__(self, prefix: str):
+        self.prefix = prefix
+
+    def to_external(self, ref: str) -> str:
+        return self.prefix + ref
+
+    def to_internal(self, external_id: str) -> str:
+        if external_id.startswith(self.prefix):
+            return external_id[len(self.prefix) :]
+        return external_id

datasette_agent_edit/stores/__init__.py

@@ -0,0 +1,4 @@
+from .disk import DiskStore
+from .sqlite import SqliteVersionedStore
+
+__all__ = ["DiskStore", "SqliteVersionedStore"]

datasette_agent_edit/stores/disk.py

@@ -0,0 +1,115 @@
+"""A filesystem-backed :class:`~datasette_agent_edit.store.EditStore`.
+
+``ref`` is a path relative to a root directory. This backend is unversioned:
+``version`` is the content file's ``mtime_ns``, used purely as a display/
+freshness token. Atomicity within a process comes from a per-store
+``asyncio.Lock`` plus a write-to-temp-then-``os.replace`` swap; blocking file
+I/O is pushed to a worker thread so the event loop is never blocked. For
+cross-process safety you would add an ``fcntl.flock`` around the read/replace,
+which is the disk analogue of the SQLite write transaction.
+"""
+
+import asyncio
+import json
+import os
+
+from ulid import ULID
+
+from ..store import Editable, NotFound, Transform
+
+
+class DiskStore:
+    """Store each piece of content as a file under ``root_dir``.
+
+    Metadata, if any, is written to a ``<path>.meta.json`` sidecar.
+    """
+
+    def __init__(self, root_dir):
+        self.root_dir = os.path.abspath(root_dir)
+        self._lock = asyncio.Lock()
+
+    def _resolve(self, ref):
+        """Resolve ``ref`` to an absolute path, refusing escapes from root."""
+        path = os.path.abspath(os.path.join(self.root_dir, ref))
+        if path != self.root_dir and not path.startswith(self.root_dir + os.sep):
+            raise ValueError(f"ref escapes storage root: {ref!r}")
+        return path
+
+    def _meta_path(self, path):
+        return path + ".meta.json"
+
+    def _read_sync(self, ref):
+        path = self._resolve(ref)
+        try:
+            with open(path, "r", encoding="utf-8") as f:
+                content = f.read()
+        except FileNotFoundError:
+            raise NotFound(ref)
+        metadata = {}
+        meta_path = self._meta_path(path)
+        if os.path.exists(meta_path):
+            with open(meta_path, "r", encoding="utf-8") as f:
+                metadata = json.load(f)
+        version = os.stat(path).st_mtime_ns
+        return Editable(ref=ref, content=content, metadata=metadata, version=version)
+
+    def _write_sync(self, path, content):
+        """Atomically replace ``path`` with ``content`` (temp file + rename)."""
+        os.makedirs(os.path.dirname(path) or ".", exist_ok=True)
+        tmp = f"{path}.{ULID()}.tmp"
+        with open(tmp, "w", encoding="utf-8") as f:
+            f.write(content)
+        os.replace(tmp, path)
+
+    async def create(self, content, *, ref=None, metadata=None):
+        ref = ref or str(ULID())
+        metadata = metadata or {}
+        path = self._resolve(ref)
+
+        def _do():
+            if os.path.exists(path):
+                raise FileExistsError(ref)
+            self._write_sync(path, content)
+            if metadata:
+                self._write_sync(self._meta_path(path), json.dumps(metadata))
+            return os.stat(path).st_mtime_ns
+
+        async with self._lock:
+            version = await asyncio.to_thread(_do)
+        return Editable(ref=ref, content=content, metadata=metadata, version=version)
+
+    async def read(self, ref):
+        return await asyncio.to_thread(self._read_sync, ref)
+
+    async def edit(self, ref, transform: Transform):
+        path = self._resolve(ref)
+
+        def _do():
+            current = self._read_sync(ref)  # raises NotFound if missing
+            # Pure, synchronous surgery between read and atomic replace.
+            new_content = transform(current.content)
+            self._write_sync(path, new_content)
+            return Editable(
+                ref=ref,
+                content=new_content,
+                metadata=current.metadata,
+                version=os.stat(path).st_mtime_ns,
+            )
+
+        async with self._lock:
+            return await asyncio.to_thread(_do)
+
+    async def delete(self, ref):
+        path = self._resolve(ref)
+
+        def _do():
+            try:
+                os.remove(path)
+            except FileNotFoundError:
+                raise NotFound(ref)
+            meta_path = self._meta_path(path)
+            if os.path.exists(meta_path):
+                os.remove(meta_path)
+
+        async with self._lock:
+            await asyncio.to_thread(_do)

datasette_agent_edit/stores/sqlite.py

@@ -0,0 +1,180 @@
+"""A versioned :class:`~datasette_agent_edit.store.EditStore` backed by SQLite.
+
+Every edit appends a new row to a versions table and bumps a ``current_version``
+pointer, giving full history. The atomic ``edit()`` runs the pure transform
+*inside* Datasette's write thread via ``db.execute_write_fn``, so the
+read-modify-write is a single serialised transaction with no chance of another
+edit interleaving — and no ``await`` is possible (or needed) in that context.
+"""
+
+from datetime import datetime, timezone
+
+from ulid import ULID
+
+from ..store import Editable, NotFound, Transform
+
+
+def _now():
+    return datetime.now(timezone.utc).isoformat()
+
+
+class SqliteVersionedStore:
+    """Store content in two tables: objects + an append-only versions log.
+
+    Parameters
+    ----------
+    db:
+        A Datasette ``Database`` (e.g. ``datasette.get_internal_database()``).
+    table:
+        Name of the objects table (one row per piece of content).
+    versions_table:
+        Name of the append-only versions table.
+    metadata_columns:
+        Optional mapping of ``column_name -> metadata_key``. Listed metadata
+        keys are stored in their own columns (and are filterable in SQL);
+        everything else is JSON-encoded into the ``metadata`` column. Defaults
+        to ``{}`` (all metadata goes to JSON).
+    validate_metadata:
+        Optional callable invoked as ``validate_metadata(metadata)`` on
+        ``create``; raise ``ValueError`` to reject invalid metadata.
+    """
+
+    def __init__(
+        self,
+        db,
+        *,
+        table="datasette_agent_edit_objects",
+        versions_table="datasette_agent_edit_versions",
+        validate_metadata=None,
+    ):
+        self.db = db
+        self.table = table
+        self.versions_table = versions_table
+        self.validate_metadata = validate_metadata
+        self._ensured = False
+
+    @property
+    def schema_sql(self):
+        return f"""
+CREATE TABLE IF NOT EXISTS {self.table} (
+    id TEXT PRIMARY KEY,
+    metadata TEXT NOT NULL DEFAULT '{{}}',
+    current_version INTEGER NOT NULL DEFAULT 1,
+    created_at TEXT NOT NULL,
+    updated_at TEXT NOT NULL
+);
+
+CREATE TABLE IF NOT EXISTS {self.versions_table} (
+    object_id TEXT NOT NULL REFERENCES {self.table}(id),
+    version INTEGER NOT NULL,
+    content TEXT NOT NULL,
+    created_at TEXT NOT NULL,
+    PRIMARY KEY (object_id, version)
+);
+"""
+
+    async def ensure_tables(self):
+        if not self._ensured:
+            await self.db.execute_write_script(self.schema_sql)
+            self._ensured = True
+
+    async def create(self, content, *, ref=None, metadata=None):
+        import json
+
+        metadata = metadata or {}
+        if self.validate_metadata is not None:
+            self.validate_metadata(metadata)
+        await self.ensure_tables()
+
+        object_id = ref or str(ULID())
+        now = _now()
+        metadata_json = json.dumps(metadata)
+
+        await self.db.execute_write(
+            f"INSERT INTO {self.table} "
+            "(id, metadata, current_version, created_at, updated_at) "
+            "VALUES (?, ?, 1, ?, ?)",
+            [object_id, metadata_json, now, now],
+        )
+        await self.db.execute_write(
+            f"INSERT INTO {self.versions_table} "
+            "(object_id, version, content, created_at) VALUES (?, 1, ?, ?)",
+            [object_id, content, now],
+        )
+        return Editable(ref=object_id, content=content, metadata=metadata, version=1)
+
+    async def read(self, ref):
+        import json
+
+        await self.ensure_tables()
+        row = (
+            await self.db.execute(
+                f"SELECT o.metadata, o.current_version, v.content "
+                f"FROM {self.versions_table} v "
+                f"JOIN {self.table} o ON o.id = v.object_id "
+                f"WHERE v.object_id = ? AND v.version = o.current_version",
+                [ref],
+            )
+        ).first()
+        if not row:
+            raise NotFound(ref)
+        return Editable(
+            ref=ref,
+            content=row["content"],
+            metadata=json.loads(row["metadata"]),
+            version=row["current_version"],
+        )
+
+    async def edit(self, ref, transform: Transform):
+        import json
+
+        await self.ensure_tables()
+        now = _now()
+
+        def _write(conn):
+            row = conn.execute(
+                f"SELECT o.metadata, o.current_version, v.content "
+                f"FROM {self.versions_table} v "
+                f"JOIN {self.table} o ON o.id = v.object_id "
+                f"WHERE v.object_id = ? AND v.version = o.current_version",
+                [ref],
+            ).fetchone()
+            if not row:
+                raise NotFound(ref)
+            metadata_json, current_version, content = row
+            # Pure, synchronous surgery inside the write transaction. If this
+            # raises (e.g. a failed str_replace) the transaction is rolled
+            # back and nothing is persisted.
+            new_content = transform(content)
+            new_version = current_version + 1
+            conn.execute(
+                f"INSERT INTO {self.versions_table} "
+                "(object_id, version, content, created_at) VALUES (?, ?, ?, ?)",
+                [ref, new_version, new_content, now],
+            )
+            conn.execute(
+                f"UPDATE {self.table} SET current_version = ?, updated_at = ? "
+                "WHERE id = ?",
+                [new_version, now, ref],
+            )
+            return new_version, new_content, json.loads(metadata_json)
+
+        new_version, new_content, metadata = await self.db.execute_write_fn(_write)
+        return Editable(
+            ref=ref, content=new_content, metadata=metadata, version=new_version
+        )
+
+    async def delete(self, ref):
+        await self.ensure_tables()
+
+        def _write(conn):
+            cur = conn.execute(
+                f"DELETE FROM {self.table} WHERE id = ?", [ref]
+            )
+            if cur.rowcount == 0:
+                raise NotFound(ref)
+            conn.execute(
+                f"DELETE FROM {self.versions_table} WHERE object_id = ?", [ref]
+            )
+
+        await self.db.execute_write_fn(_write)

datasette_agent_edit/toolset.py

@@ -0,0 +1,332 @@
+"""Layer 3: turn an :class:`~datasette_agent_edit.store.EditStore` into a set
+of Datasette Agent tools with a single, consistent JSON envelope.
+
+The toolset is storage- *and* presentation-agnostic. Two extension points
+absorb everything plugin-specific:
+
+- ``id_codec`` maps between the internal ``ref`` and the id the model sees
+  (e.g. the ``artifact-`` prefix).
+- ``render`` is an optional hook ``(Editable) -> dict`` (sync or async) whose
+  result is merged into the tool output, letting a plugin inject e.g. an
+  ``_html`` preview. With no hook, no ``*_render`` tool is registered and
+  edits simply report status — which is exactly what a plain file editor
+  wants.
+
+Handler methods (``view``, ``str_replace``, ``insert``, ``edit``, ``render``)
+each return a JSON string and are directly callable for testing. :meth:`tools`
+wraps them as ``AgentTool`` instances; that import is deferred so the rest of
+the package works without ``datasette-agent`` installed.
+"""
+
+import inspect
+import json
+
+from . import operations
+from .operations import EditApplyError, EditError
+from .store import IdCodec, NotFound
+
+
+class EditToolset:
+    def __init__(
+        self,
+        store,
+        *,
+        name_prefix="file",
+        id_field="id",
+        id_codec=None,
+        render=None,
+        descriptions=None,
+    ):
+        self.store = store
+        self.name_prefix = name_prefix
+        self.id_field = id_field
+        self.codec = id_codec or IdCodec()
+        self.render_hook = render
+        self.descriptions = {**self._default_descriptions(), **(descriptions or {})}
+
+    # ------------------------------------------------------------------ #
+    # Naming / formatting helpers
+    # ------------------------------------------------------------------ #
+    def _name(self, op):
+        return f"{self.name_prefix}_{op}"
+
+    def _ok(self, external_id, **extra):
+        return json.dumps({self.id_field: external_id, **extra})
+
+    def _err(self, message, **extra):
+        return json.dumps({"error": message, **extra})
+
+    async def _render_payload(self, editable):
+        if self.render_hook is None:
+            return {}
+        result = self.render_hook(editable)
+        if inspect.isawaitable(result):
+            result = await result
+        return result or {}
+
+    # ------------------------------------------------------------------ #
+    # Handlers (directly callable; each returns a JSON string)
+    # ------------------------------------------------------------------ #
+    async def view(self, external_id, view_range=""):
+        ref = self.codec.to_internal(external_id)
+        try:
+            editable = await self.store.read(ref)
+        except NotFound:
+            return self._err(f"Content not found: {external_id}")
+        return self._ok(
+            external_id,
+            metadata=editable.metadata,
+            content=operations.view_lines(editable.content, view_range),
+        )
+
+    async def str_replace(self, external_id, old_str, new_str):
+        ref = self.codec.to_internal(external_id)
+
+        def transform(content):
+            return operations.str_replace(content, old_str, new_str)
+
+        try:
+            editable = await self.store.edit(ref, transform)
+        except NotFound:
+            return self._err(f"Content not found: {external_id}")
+        except EditError as e:
+            return self._err(str(e))
+        return self._ok(
+            external_id,
+            version=editable.version,
+            status=(
+                f"Replacement applied. Call {self._name('render')} to display "
+                "the updated content."
+                if self.render_hook
+                else "Replacement applied."
+            ),
+        )
+
+    async def insert(self, external_id, insert_line, insert_text):
+        ref = self.codec.to_internal(external_id)
+
+        def transform(content):
+            return operations.insert(content, insert_line, insert_text)
+
+        try:
+            editable = await self.store.edit(ref, transform)
+        except NotFound:
+            return self._err(f"Content not found: {external_id}")
+        except EditError as e:
+            return self._err(str(e))
+        return self._ok(
+            external_id,
+            version=editable.version,
+            status=(
+                f"Inserted text after line {insert_line}. Call "
+                f"{self._name('render')} to display the updated content."
+                if self.render_hook
+                else f"Inserted text after line {insert_line}."
+            ),
+        )
+
+    async def edit(self, external_id, edits):
+        ref = self.codec.to_internal(external_id)
+        holder = {}
+
+        def transform(content):
+            new_content, applied = operations.apply_edits(content, edits)
+            holder["applied"] = applied
+            return new_content
+
+        try:
+            editable = await self.store.edit(ref, transform)
+        except NotFound:
+            return self._err(f"Content not found: {external_id}")
+        except EditApplyError as e:
+            return self._err(
+                f"Edit #{e.index + 1} failed: {e}", applied=e.applied
+            )
+        except EditError as e:
+            return self._err(str(e))
+
+        applied = holder.get("applied", [])
+        payload = await self._render_payload(editable)
+        return self._ok(
+            external_id,
+            version=editable.version,
+            edits_applied=len(applied),
+            status=f"Applied {len(applied)} edits.",
+            **payload,
+        )
+
+    async def render(self, external_id):
+        if self.render_hook is None:
+            return self._err("This toolset has no render hook configured.")
+        ref = self.codec.to_internal(external_id)
+        try:
+            editable = await self.store.read(ref)
+        except NotFound:
+            return self._err(f"Content not found: {external_id}")
+        payload = await self._render_payload(editable)
+        return self._ok(external_id, status="Rendered.", **payload)
+
+    # ------------------------------------------------------------------ #
+    # AgentTool construction
+    # ------------------------------------------------------------------ #
+    def _id_arg(self):
+        return {
+            self.id_field: {
+                "type": "string",
+                "description": "The id of the content to operate on",
+            }
+        }
+
+    def tools(self):
+        """Return the list of ``AgentTool`` instances for this toolset."""
+        from datasette_agent.tools import AgentTool
+
+        idf = self.id_field
+
+        def adapt(handler):
+            async def fn(datasette, actor, **kwargs):
+                external_id = kwargs.pop(idf)
+                return await handler(external_id, **kwargs)
+
+            return fn
+
+        tools = [
+            AgentTool(
+                name=self._name("view"),
+                description=self.descriptions["view"],
+                input_schema={
+                    "type": "object",
+                    "properties": {
+                        **self._id_arg(),
+                        "view_range": {
+                            "type": "string",
+                            "description": 'Optional line range "start,end" '
+                            "(1-indexed, -1 for end-of-file)",
+                        },
+                    },
+                    "required": [idf],
+                },
+                fn=adapt(self.view),
+            ),
+            AgentTool(
+                name=self._name("str_replace"),
+                description=self.descriptions["str_replace"],
+                input_schema={
+                    "type": "object",
+                    "properties": {
+                        **self._id_arg(),
+                        "old_str": {
+                            "type": "string",
+                            "description": "Exact text to find (must appear once)",
+                        },
+                        "new_str": {
+                            "type": "string",
+                            "description": "Replacement text",
+                        },
+                    },
+                    "required": [idf, "old_str", "new_str"],
+                },
+                fn=adapt(self.str_replace),
+            ),
+            AgentTool(
+                name=self._name("insert"),
+                description=self.descriptions["insert"],
+                input_schema={
+                    "type": "object",
+                    "properties": {
+                        **self._id_arg(),
+                        "insert_line": {
+                            "type": "integer",
+                            "description": "Line number after which to insert "
+                            "(0 for beginning)",
+                        },
+                        "insert_text": {
+                            "type": "string",
+                            "description": "Text to insert",
+                        },
+                    },
+                    "required": [idf, "insert_line", "insert_text"],
+                },
+                fn=adapt(self.insert),
+            ),
+            AgentTool(
+                name=self._name("edit"),
+                description=self.descriptions["edit"],
+                input_schema={
+                    "type": "object",
+                    "properties": {
+                        **self._id_arg(),
+                        "edits": {
+                            "type": "array",
+                            "description": "Edit operations applied sequentially",
+                            "items": {
+                                "type": "object",
+                                "properties": {
+                                    "operation": {
+                                        "type": "string",
+                                        "enum": ["str_replace", "insert"],
+                                    },
+                                    "old_str": {"type": "string"},
+                                    "new_str": {"type": "string"},
+                                    "insert_line": {"type": "integer"},
+                                    "insert_text": {"type": "string"},
+                                },
+                                "required": ["operation"],
+                            },
+                        },
+                    },
+                    "required": [idf, "edits"],
+                },
+                fn=adapt(self.edit),
+            ),
+        ]
+
+        if self.render_hook is not None:
+            tools.append(
+                AgentTool(
+                    name=self._name("render"),
+                    description=self.descriptions["render"],
+                    input_schema={
+                        "type": "object",
+                        "properties": self._id_arg(),
+                        "required": [idf],
+                    },
+                    fn=adapt(self.render),
+                )
+            )
+        return tools
+
+    # ------------------------------------------------------------------ #
+    def _default_descriptions(self):
+        p = self.name_prefix
+        renders = self.render_hook is not None
+        edit_note = (
+            f" The {p}_edit tool renders once after applying all edits; the "
+            f"single-edit tools do not render, so call {p}_render when done."
+            if renders
+            else ""
+        )
+        return {
+            "view": (
+                f"View the current content with line numbers. Use before "
+                f"editing with {p}_str_replace or {p}_insert. Optionally pass "
+                'view_range as "start,end" (1-indexed, -1 for end-of-file).'
+            ),
+            "str_replace": (
+                "Replace an exact string. old_str must appear exactly once "
+                "(add surrounding context to disambiguate)." + edit_note
+            ),
+            "insert": (
+                "Insert text after a given line number (0 for the beginning "
+                "of the content)." + edit_note
+            ),
+            "edit": (
+                "Apply multiple edits in one atomic operation. Pass an array "
+                'of {"operation": "str_replace"|"insert", ...} objects applied '
+                "sequentially; if any edit fails, none are saved."
+            ),
+            "render": (
+                "Render the current content and display it. Call once after "
+                "all edits are complete."
+            ),
+        }

datasette_agent_edit-0.1a0.dist-info/METADATA

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: datasette-agent-edit
+Version: 0.1a0
+Summary: Storage-agnostic file-editing tools (view / str_replace / insert) for Datasette Agent plugins
+Author: Simon Willison
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/datasette/datasette-agent-edit
+Project-URL: Issues, https://github.com/datasette/datasette-agent-edit/issues
+Classifier: Framework :: Datasette
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: datasette>=1.0a31
+Requires-Dist: python-ulid
+Requires-Dist: typing_extensions
+Dynamic: license-file
+
+# datasette-agent-edit
+
+Storage-agnostic file-editing tools (`view` / `str_replace` / `insert` / batch
+`edit`) for Datasette Agent plugins. The same tool behaviour can sit on top of
+any storage layer — SQLite, the local filesystem, S3, the GitHub contents API,
+…
+
+## The three layers
+
+1. **`operations`** — pure, synchronous string surgery (`view_lines`,
+   `str_replace`, `insert`, `apply_edits`). No I/O, no `await`, no Datasette.
+2. **`EditStore`** — the storage seam. The defining method is
+   `edit(ref, transform)`: the backend reads the current content, runs your
+   *pure* transform inside whatever critical section it needs, and persists the
+   result atomically. A failing transform persists nothing.
+   - `SqliteVersionedStore` runs the transform inside Datasette's write thread
+     (`execute_write_fn`) and keeps full version history.
+   - `DiskStore` uses a lock + atomic `os.replace`.
+   - S3 (`If-Match`) and GitHub (`sha`) backends fit the same shape with a
+     compare-and-set retry loop.
+3. **`EditToolset`** — turns any `EditStore` into Datasette Agent tools with one
+   consistent JSON envelope. Two hooks absorb the plugin-specific parts:
+   - `id_codec` maps internal refs to the ids the model sees (e.g. an
+     `artifact-` prefix).
+   - `render` optionally injects presentation (e.g. an `_html` iframe preview);
+     omit it and no `*_render` tool is registered.
+
+## Why `transform` is synchronous
+
+The transform sits *between* a backend's awaits, never inside them — the SQLite
+backend literally cannot `await` on its write thread, and the S3/GitHub backends
+must not re-run network calls on every compare-and-set retry. If an edit
+decision needs async work, resolve it first and close over the result:
+
+```python
+resolved = await registry.lookup(name)
+await store.edit(ref, lambda c: rewrite(c, resolved))
+```
+
+A rare backend that genuinely needs in-transaction async can implement the
+optional `AsyncTransformStore.aedit` capability; the toolset never requires it.
+
+## Example
+
+```python
+from datasette_agent_edit import EditToolset, SqliteVersionedStore, PrefixCodec
+
+store = SqliteVersionedStore(datasette.get_internal_database())
+toolset = EditToolset(
+    store,
+    name_prefix="artifact",
+    id_field="artifact_id",
+    id_codec=PrefixCodec("artifact-"),
+    render=lambda editable: {"_html": build_iframe(editable.content, editable.metadata)},
+)
+agent_tools = toolset.tools()   # list of AgentTool, ready to register
+```
+
+## Development
+
+```bash
+uv run pytest
+```

datasette_agent_edit-0.1a0.dist-info/RECORD

@@ -0,0 +1,12 @@
+datasette_agent_edit/__init__.py,sha256=vqc6eD0Mo3ebB1-_E3gKZ44YSmBMMKbN1gic8cmQX9g,1253
+datasette_agent_edit/operations.py,sha256=TBoqOZCkwnDVDMOuXGNpgDa-QrBiVu6Fp4XCP_1SBlE,4213
+datasette_agent_edit/store.py,sha256=5sbps3qH3pfqGVAq9gfvX8nEpiZvzF_zofwIPv8tqAQ,4914
+datasette_agent_edit/toolset.py,sha256=NTGsBBPKg3XqMWkpcX7b94vJXyYMDPMZP2W3YmagTTE,12486
+datasette_agent_edit/stores/__init__.py,sha256=UAqNpnerYQ_IMcekNFM_zO2Vzy05eVB7wwumD_3zrfo,118
+datasette_agent_edit/stores/disk.py,sha256=GrwgImpx353IwRlud34TdzzgxV__fk7BztOg-W8TrwE,4061
+datasette_agent_edit/stores/sqlite.py,sha256=77gRSi5UuFJ7KnBcc1yG-9K5xDcYKZ0KHCNxl_LRuDM,6170
+datasette_agent_edit-0.1a0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+datasette_agent_edit-0.1a0.dist-info/METADATA,sha256=kUpC70ayGCrvZavKQwX1ATjMGrnHON2yJRA-bmln1OU,3122
+datasette_agent_edit-0.1a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+datasette_agent_edit-0.1a0.dist-info/top_level.txt,sha256=v8buiXT593LwC-j43TAx1Aie-g1fJ3lhGK67ThQyWsc,21
+datasette_agent_edit-0.1a0.dist-info/RECORD,,

datasette_agent_edit-0.1a0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

datasette_agent_edit-0.1a0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

datasette_agent_edit-0.1a0.dist-info/top_level.txt

@@ -0,0 +1 @@
+datasette_agent_edit