290 lines
10 KiB
Python
290 lines
10 KiB
Python
"""A Specialist's working copy: files and a graph built up over several tool calls.
|
|
|
|
A model that must return a whole Deliverable in one reply spends most of its output
|
|
repeating itself, and a long reply is what times out. With a working copy it writes a
|
|
file once, changes only the lines that need changing, and adds to a graph a few items
|
|
at a time. The working copy is kept with the Execution, so a Revision starts from the
|
|
last attempt instead of from nothing.
|
|
|
|
It lives in the Deliverable's working memory:
|
|
|
|
working["files"] {path: content}
|
|
working["graph"] the Target architecture, as target-architecture.json holds it
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from collections.abc import Mapping, MutableMapping, Sequence
|
|
from pathlib import PurePosixPath
|
|
from typing import Any
|
|
|
|
from app.adk.runtime import ToolResult, ToolSpec
|
|
|
|
FILES = "files"
|
|
GRAPH = "graph"
|
|
_GRAPH_LISTS = ("elements", "relationships", "checks", "not_applicable")
|
|
_MAX_READ = 40_000
|
|
|
|
|
|
def safe_relative(name: str) -> bool:
|
|
path = PurePosixPath(name)
|
|
return bool(name) and not path.is_absolute() and ".." not in path.parts
|
|
|
|
|
|
def working_files(working: MutableMapping[str, Any]) -> MutableMapping[str, str]:
|
|
files = working.get(FILES)
|
|
if not isinstance(files, MutableMapping):
|
|
files = working[FILES] = {}
|
|
return files
|
|
|
|
|
|
def _schema(properties: Mapping[str, Any], required: Sequence[str]) -> dict[str, Any]:
|
|
return {
|
|
"type": "object",
|
|
"properties": dict(properties),
|
|
"required": list(required),
|
|
}
|
|
|
|
|
|
def _lines(content: str) -> int:
|
|
return content.count("\n") + (1 if content and not content.endswith("\n") else 0)
|
|
|
|
|
|
def file_tools(working: MutableMapping[str, Any]) -> list[ToolSpec]:
|
|
"""Tools that write, change and read the files of a working copy."""
|
|
files = working_files(working)
|
|
|
|
async def write_file(path: str, content: str) -> ToolResult:
|
|
if not safe_relative(path):
|
|
return ToolResult(
|
|
f"Refused: {path!r} must be a relative path without '..'."
|
|
)
|
|
files[path] = content
|
|
return ToolResult(f"Wrote {path} ({_lines(content)} lines).")
|
|
|
|
async def edit_file(path: str, old: str, new: str) -> ToolResult:
|
|
if path not in files:
|
|
return ToolResult(f"Refused: {path} is not in your working copy.")
|
|
found = files[path].count(old) if old else 0
|
|
if found != 1:
|
|
return ToolResult(
|
|
f"Refused: `old` must match exactly one place in {path}; it matches "
|
|
f"{found}. Include more of the surrounding lines."
|
|
)
|
|
files[path] = files[path].replace(old, new)
|
|
return ToolResult(f"Edited {path}.")
|
|
|
|
async def read_file(path: str = "") -> ToolResult:
|
|
if not path:
|
|
if not files:
|
|
return ToolResult("Your working copy is empty.")
|
|
return ToolResult(
|
|
"Your working copy:\n"
|
|
+ "\n".join(
|
|
f"- {name} ({_lines(files[name])} lines)" for name in sorted(files)
|
|
)
|
|
)
|
|
if path not in files:
|
|
return ToolResult(f"Refused: {path} is not in your working copy.")
|
|
content = files[path]
|
|
if len(content) > _MAX_READ:
|
|
content = content[:_MAX_READ] + "\n[truncated]"
|
|
return ToolResult(content)
|
|
|
|
async def delete_file(path: str) -> ToolResult:
|
|
if files.pop(path, None) is None:
|
|
return ToolResult(f"Refused: {path} is not in your working copy.")
|
|
return ToolResult(f"Deleted {path}.")
|
|
|
|
text = {"type": "string"}
|
|
return [
|
|
ToolSpec(
|
|
"write_file",
|
|
"Write one file of your working copy, replacing it if it exists. Your "
|
|
"working copy is attached for you when you submit.",
|
|
_schema({"path": text, "content": text}, ["path", "content"]),
|
|
write_file,
|
|
),
|
|
ToolSpec(
|
|
"edit_file",
|
|
"Change part of one file: replace the single place `old` matches with "
|
|
"`new`. Use this for a fix instead of writing the file again.",
|
|
_schema({"path": text, "old": text, "new": text}, ["path", "old", "new"]),
|
|
edit_file,
|
|
),
|
|
ToolSpec(
|
|
"read_file",
|
|
"Read one file of your working copy, or list its files when `path` is "
|
|
"left out.",
|
|
_schema({"path": text}, []),
|
|
read_file,
|
|
),
|
|
ToolSpec(
|
|
"delete_file",
|
|
"Remove one file from your working copy.",
|
|
_schema({"path": text}, ["path"]),
|
|
delete_file,
|
|
),
|
|
]
|
|
|
|
|
|
# --- the graph -----------------------------------------------------------------------
|
|
|
|
|
|
def working_graph(working: MutableMapping[str, Any]) -> dict[str, list[dict[str, Any]]]:
|
|
graph = working.get(GRAPH)
|
|
if not isinstance(graph, dict):
|
|
graph = working[GRAPH] = {}
|
|
for name in _GRAPH_LISTS:
|
|
if not isinstance(graph.get(name), list):
|
|
graph[name] = []
|
|
return graph
|
|
|
|
|
|
def graph_text(working: MutableMapping[str, Any]) -> str:
|
|
"""The working graph as target-architecture.json, or "" when nothing is in it."""
|
|
graph = working.get(GRAPH)
|
|
if not isinstance(graph, dict) or not any(graph.get(n) for n in _GRAPH_LISTS):
|
|
return ""
|
|
return json.dumps(
|
|
{name: graph.get(name, []) for name in _GRAPH_LISTS},
|
|
indent=2,
|
|
ensure_ascii=False,
|
|
)
|
|
|
|
|
|
def keep_graph(working: MutableMapping[str, Any], text: str) -> None:
|
|
"""Make a submitted graph the working graph, so a Revision amends it."""
|
|
try:
|
|
data = json.loads(text)
|
|
except ValueError:
|
|
return
|
|
if isinstance(data, dict):
|
|
working[GRAPH] = {
|
|
name: [item for item in data.get(name, []) if isinstance(item, dict)]
|
|
for name in _GRAPH_LISTS
|
|
}
|
|
|
|
|
|
def _key(name: str) -> str:
|
|
return "recommendation" if name == "not_applicable" else "id"
|
|
|
|
|
|
def graph_tools(working: MutableMapping[str, Any]) -> list[ToolSpec]:
|
|
"""Tools that build the Target architecture a few items at a time."""
|
|
|
|
async def graph_put(
|
|
elements: Sequence[Any] = (),
|
|
relationships: Sequence[Any] = (),
|
|
checks: Sequence[Any] = (),
|
|
not_applicable: Sequence[Any] = (),
|
|
) -> ToolResult:
|
|
graph = working_graph(working)
|
|
given = dict(
|
|
zip(
|
|
_GRAPH_LISTS,
|
|
(elements, relationships, checks, not_applicable),
|
|
strict=True,
|
|
)
|
|
)
|
|
bad = [
|
|
f"{name}[{index}]"
|
|
for name, items in given.items()
|
|
for index, item in enumerate(items or ())
|
|
if not isinstance(item, Mapping)
|
|
or not isinstance(item.get(_key(name)), str)
|
|
or not item[_key(name)].strip()
|
|
]
|
|
if bad:
|
|
return ToolResult(
|
|
"Refused: each item must be an object with an `id` (a "
|
|
f"`recommendation` under not_applicable): {', '.join(bad)}"
|
|
)
|
|
added = replaced = 0
|
|
for name, items in given.items():
|
|
key = _key(name)
|
|
for item in items or ():
|
|
for index, existing in enumerate(graph[name]):
|
|
if existing.get(key) == item[key]:
|
|
graph[name][index] = dict(item)
|
|
replaced += 1
|
|
break
|
|
else:
|
|
graph[name].append(dict(item))
|
|
added += 1
|
|
return ToolResult(f"Added {added}, replaced {replaced}. {_counts(graph)}")
|
|
|
|
async def graph_remove(ids: Sequence[str]) -> ToolResult:
|
|
graph = working_graph(working)
|
|
wanted = set(ids)
|
|
removed = 0
|
|
for name in _GRAPH_LISTS:
|
|
kept = [item for item in graph[name] if item.get(_key(name)) not in wanted]
|
|
removed += len(graph[name]) - len(kept)
|
|
graph[name] = kept
|
|
return ToolResult(f"Removed {removed}. {_counts(graph)}")
|
|
|
|
async def graph_read() -> ToolResult:
|
|
return ToolResult(graph_text(working) or "Your working graph is empty.")
|
|
|
|
def items(*fields: str, optional: tuple[str, ...] = ()) -> dict[str, Any]:
|
|
return {
|
|
"type": "array",
|
|
"items": _schema(
|
|
{name: {"type": "string"} for name in (*fields, *optional)}, fields
|
|
),
|
|
}
|
|
|
|
lists = {
|
|
"elements": items(
|
|
"id", "name", "product", "resource_type", optional=("component",)
|
|
),
|
|
"relationships": items("id", "from", "to", "kind"),
|
|
"checks": items("id", "applies_to", "statement", "source"),
|
|
"not_applicable": items("recommendation", "reason"),
|
|
}
|
|
return [
|
|
ToolSpec(
|
|
"graph_put",
|
|
"Add items to your working graph, or replace the ones with the same id. "
|
|
"Call it several times with a few items each. Your working graph is "
|
|
"attached as target-architecture.json when you submit.",
|
|
_schema(lists, []),
|
|
graph_put,
|
|
),
|
|
ToolSpec(
|
|
"graph_remove",
|
|
"Remove items from your working graph by id (a not-applicable entry by "
|
|
"its recommendation id).",
|
|
_schema({"ids": {"type": "array", "items": {"type": "string"}}}, ["ids"]),
|
|
graph_remove,
|
|
),
|
|
ToolSpec(
|
|
"graph_read",
|
|
"Read your working graph.",
|
|
{"type": "object", "properties": {}},
|
|
graph_read,
|
|
),
|
|
]
|
|
|
|
|
|
def _counts(graph: Mapping[str, Sequence[Any]]) -> str:
|
|
return (
|
|
f"The graph has {len(graph['elements'])} Elements, "
|
|
f"{len(graph['relationships'])} Relationships and "
|
|
f"{len(graph['checks'])} Checks."
|
|
)
|
|
|
|
|
|
def summary(working: Mapping[str, Any]) -> dict[str, Any] | None:
|
|
"""What a Specialist is told it already has, at the start of a run."""
|
|
told: dict[str, Any] = {}
|
|
files = working.get(FILES)
|
|
if isinstance(files, Mapping) and files:
|
|
told["files"] = sorted(files)
|
|
graph = working.get(GRAPH)
|
|
if isinstance(graph, Mapping) and any(graph.get(name) for name in _GRAPH_LISTS):
|
|
told["graph"] = {name: len(graph.get(name) or ()) for name in _GRAPH_LISTS}
|
|
return told or None
|