Add the catalog index, and package a real prompt collection
CANP-WP-0004. The operator asked canned-prompts to build a database of versioned prompts recording where each came from and when — the first step toward a platform for collaborative prompting. The format had nowhere to put that. `provenance` records who wrote a prompt and where the idea came from; nothing recorded how a copy arrived in a particular store. Section 20.3 now specifies an `index.yaml` as store metadata rather than package data: how a copy arrived differs for every consumer, and recording an arrival must never rewrite the package that arrived. `add`, `install` and `publish` record registry, id, version, name, source, method, first-inclusion date, and the package's declared author, source and licence — the last three copied so a listing is readable without opening every package. A new `index` verb lists it. `included_at` is never overwritten; a re-run updates `last_seen_at`, because when a package first entered a collection is a fact about history rather than about the last command run. Tests 84 -> 90. Also records two findings from actually using the format: CANP-WP-0004-T03 — inclusion has no deduplication, so a diamond dependency renders shared content once per path. Found by composing a real collection. Not fixed here: deduplicating means choosing which occurrence survives and deciding what happens when two paths resolve different versions, which is resolver behaviour that section 10.4 deliberately avoids. Handed to CANP-WP-0005 with a leaning: document it, warn at validation time, do not deduplicate. The add_ons workaround in practice/pqrst-estimate is evidence about section 23's deferred "richer template syntax" — an optional appendix has to be an input with an empty default, because CPF has no conditionals. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Bjefh8NUiEiahN4JLwoSKM Assistant: claude-code Assistant-Model: opus Assistant-Process: 388925@bnt-lap001 Assistant-Session: 3507023f-e0fd-4a1e-9d90-a0d4217d1502
This commit is contained in:
parent
f55ef13c75
commit
b3280df742
7 changed files with 386 additions and 1 deletions
|
|
@ -11,6 +11,7 @@ import argparse
|
|||
import json
|
||||
import os
|
||||
import re
|
||||
import datetime as dt
|
||||
import shutil
|
||||
import sys
|
||||
from dataclasses import dataclass, field
|
||||
|
|
@ -30,6 +31,8 @@ RENDER_CHECKS = ("contains", "not_contains", "resolves_all")
|
|||
CAPABILITY_RE = re.compile(r"^[a-z0-9]+(?:-[a-z0-9]+)*$")
|
||||
RESERVED_FILES = ("prompt.yaml", "README.md", "LICENSE")
|
||||
RESERVED_DIRS = ("examples", "evals", "assets")
|
||||
INDEX_FILE = "index.yaml"
|
||||
INDEX_FORMAT = "canned-prompt-index/v0.1"
|
||||
PLACEHOLDER_RE = re.compile(r"{{\s*([A-Za-z_][A-Za-z0-9_.-]*)\s*}}")
|
||||
SEMVER_RE = re.compile(
|
||||
r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)"
|
||||
|
|
@ -678,6 +681,76 @@ def copy_package(src: Path, dst: Path, manifest: dict[str, Any], what: str) -> l
|
|||
return skipped
|
||||
|
||||
|
||||
def read_index(store: Path) -> dict[str, Any]:
|
||||
"""The catalog index: which packages entered this store, from where, when.
|
||||
|
||||
Registry-side metadata, deliberately outside the immutable package (§ 20).
|
||||
A package records who wrote it; the index records how it got here.
|
||||
"""
|
||||
path = store / INDEX_FILE
|
||||
if not path.is_file():
|
||||
return {"format": INDEX_FORMAT, "entries": []}
|
||||
try:
|
||||
data = yaml.safe_load(path.read_text(encoding="utf-8"))
|
||||
except yaml.YAMLError as exc:
|
||||
raise CannedPromptError(f"invalid YAML in {path}: {exc}") from exc
|
||||
if not isinstance(data, dict) or not isinstance(data.get("entries"), list):
|
||||
raise CannedPromptError(f"{path}: index must be a mapping with an entries list")
|
||||
if data.get("format") != INDEX_FORMAT:
|
||||
raise CannedPromptError(f"unsupported index format: {data.get('format')!r}")
|
||||
return data
|
||||
|
||||
|
||||
def index_entry_key(entry: dict[str, Any]) -> tuple[str, str, str]:
|
||||
return (entry.get("registry", ""), entry.get("id", ""), entry.get("version", ""))
|
||||
|
||||
|
||||
def record_inclusion(
|
||||
store: Path,
|
||||
registry: str,
|
||||
manifest: dict[str, Any],
|
||||
source: str,
|
||||
method: str,
|
||||
) -> dict[str, Any]:
|
||||
"""Record that a package version entered this store, and from where.
|
||||
|
||||
Re-recording the same registry/id/version keeps the original `included_at`:
|
||||
the date a package first entered is a fact about history, not about the last
|
||||
time someone re-ran a command.
|
||||
"""
|
||||
index = read_index(store)
|
||||
entry = {
|
||||
"registry": registry,
|
||||
"id": manifest["id"],
|
||||
"version": manifest["version"],
|
||||
"name": manifest.get("name"),
|
||||
"source": source,
|
||||
"method": method,
|
||||
"included_at": dt.datetime.now(dt.timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"),
|
||||
}
|
||||
provenance = manifest.get("provenance") or {}
|
||||
if isinstance(provenance, dict):
|
||||
for field in ("author", "source"):
|
||||
if provenance.get(field):
|
||||
entry[f"declared_{field}"] = str(provenance[field])
|
||||
if manifest.get("license"):
|
||||
entry["license"] = manifest["license"]
|
||||
|
||||
existing = {index_entry_key(e): e for e in index["entries"]}
|
||||
key = index_entry_key(entry)
|
||||
if key in existing:
|
||||
entry["included_at"] = existing[key].get("included_at", entry["included_at"])
|
||||
entry["last_seen_at"] = dt.datetime.now(dt.timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
|
||||
existing[key] = entry
|
||||
|
||||
index["entries"] = [existing[k] for k in sorted(existing)]
|
||||
store.mkdir(parents=True, exist_ok=True)
|
||||
(store / INDEX_FILE).write_text(
|
||||
yaml.safe_dump(index, sort_keys=False, allow_unicode=True), encoding="utf-8"
|
||||
)
|
||||
return entry
|
||||
|
||||
|
||||
def missing_dependencies(catalog: Path, manifest: dict[str, Any]) -> list[str]:
|
||||
"""Declared prompt dependencies that this catalog cannot satisfy.
|
||||
|
||||
|
|
@ -737,6 +810,7 @@ def cmd_add(args: argparse.Namespace) -> None:
|
|||
registry = check_registry_name(args.as_registry)
|
||||
dst = catalog_package_path(catalog, registry, manifest["id"], manifest["version"])
|
||||
report_skipped(copy_package(src.resolve(), dst, manifest, "catalog package"))
|
||||
record_inclusion(catalog, registry, manifest, str(src.resolve()), "add")
|
||||
report_missing_dependencies(catalog, manifest)
|
||||
print(f"added {registry}:{manifest['id']}@{manifest['version']} -> {dst}")
|
||||
|
||||
|
|
@ -759,6 +833,7 @@ def cmd_publish(args: argparse.Namespace) -> None:
|
|||
|
||||
dst = registry_package_path(registry, manifest["id"], manifest["version"])
|
||||
report_skipped(copy_package(src.resolve(), dst, manifest, "published package"))
|
||||
record_inclusion(registry, name or "", manifest, str(src.resolve()), "publish")
|
||||
label = f"{name}:{manifest['id']}" if name else manifest["id"]
|
||||
print(f"published {label}@{manifest['version']} -> {dst}")
|
||||
|
||||
|
|
@ -778,6 +853,7 @@ def cmd_install(args: argparse.Namespace) -> None:
|
|||
manifest = validate_package(src)
|
||||
dst = catalog_package_path(catalog, name, manifest["id"], manifest["version"])
|
||||
copy_package(src, dst, manifest, "catalog package")
|
||||
record_inclusion(catalog, name, manifest, str(registry.resolve()), "install")
|
||||
report_missing_dependencies(catalog, manifest)
|
||||
print(f"installed {name}:{manifest['id']}@{manifest['version']} -> {dst}")
|
||||
|
||||
|
|
@ -1238,6 +1314,28 @@ def cmd_eval(args: argparse.Namespace) -> None:
|
|||
raise CannedPromptError(f"{failures} render check(s) failed")
|
||||
|
||||
|
||||
def cmd_index(args: argparse.Namespace) -> None:
|
||||
store = Path(args.catalog).expanduser()
|
||||
entries = read_index(store)["entries"]
|
||||
if args.id:
|
||||
_, package_id = parse_reference(args.id)
|
||||
entries = [e for e in entries if e.get("id") == package_id]
|
||||
if args.json:
|
||||
print(json.dumps(entries, indent=2, ensure_ascii=False))
|
||||
return
|
||||
if not entries:
|
||||
print("no packages recorded in this catalog")
|
||||
return
|
||||
width = max(len(f"{e.get('registry')}:{e.get('id')}@{e.get('version')}") for e in entries)
|
||||
for entry in entries:
|
||||
label = f"{entry.get('registry')}:{entry.get('id')}@{entry.get('version')}"
|
||||
print(f"{label:<{width}} {entry.get('included_at')} {entry.get('method')}")
|
||||
print(f"{'':<{width}} from {entry.get('source')}")
|
||||
declared = entry.get("declared_source")
|
||||
if declared:
|
||||
print(f"{'':<{width}} declares source {declared}")
|
||||
|
||||
|
||||
def build_parser() -> argparse.ArgumentParser:
|
||||
parser = argparse.ArgumentParser(prog="canned-prompts", description=__doc__)
|
||||
sub = parser.add_subparsers(dest="command", required=True)
|
||||
|
|
@ -1274,6 +1372,12 @@ def build_parser() -> argparse.ArgumentParser:
|
|||
render.add_argument("--set", dest="set_values", action="append", default=[], metavar="NAME=VALUE")
|
||||
render.set_defaults(func=cmd_render)
|
||||
|
||||
index = sub.add_parser("index", help="show what entered this catalog, from where and when")
|
||||
index.add_argument("id", nargs="?")
|
||||
index.add_argument("--catalog", default=str(default_catalog()))
|
||||
index.add_argument("--json", action="store_true")
|
||||
index.set_defaults(func=cmd_index)
|
||||
|
||||
evaluate = sub.add_parser("eval", help="run an installed package's render checks")
|
||||
evaluate.add_argument("id")
|
||||
evaluate.add_argument("--version")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue