Function restore_iteration

openkb/skill/workspace.py:86–118

Restore an iteration as the current skill. If ``n`` is ``None``, restore the highest-numbered iteration. Raises ``FileNotFoundError`` if the requested iteration doesn't exist. Returns the path to the restored skill directory.

(kb_dir: Path, skill_name: str, n: int | None = None)

def restore_iteration(kb_dir: Path, skill_name: str, n: int | None = None) -> Path:
    """Restore an iteration as the current skill.

    If ``n`` is ``None``, restore the highest-numbered iteration. Raises
    ``FileNotFoundError`` if the requested iteration doesn't exist.

    Returns the path to the restored skill directory.
    """
    iters = list_iterations(kb_dir, skill_name)
    if not iters:
        raise FileNotFoundError(f"No iterations exist for skill {skill_name!r}.")

    if n is None:
        src = iters[-1]
    else:
        match = next(
            (p for p in iters if _iter_number(p) == n),
            None,
        )
        if match is None:
            raise FileNotFoundError(f"Iteration {n} not found for skill {skill_name!r}.")
        src = match

    # Save the current state before overwriting it — rollback is a mutation
    # too, and the workspace promise ("no work is destroyed") has to hold
    # in both directions. A user who edits files in chat then rolls back
    # gets those edits preserved as the next iteration, not silently lost.
    dest = _skill_dir(kb_dir, skill_name)
    if dest.exists():
        save_iteration(kb_dir, skill_name)
        shutil.rmtree(dest)
    shutil.copytree(src, dest)
    return dest


# ---------------------------------------------------------------------------