vibe-sketcherDocumentation

Source code for vibesketcher.server.cnt_composites

"""REST routes for representative coated and disordered CNT fibre composites (#241).

A preview reads the current document and changes nothing; applying is
checked against the document revision and recorded as an edit; an applied
composite has an undo route that refuses when the model changed since.
Refusals in a preview are returned with ``applicable: false`` and stable codes.
"""

from __future__ import annotations

from typing import Any

from fastapi import APIRouter, HTTPException
from pydantic import BaseModel, ConfigDict, ValidationError

from vibesketcher.document.model import Document
from vibesketcher.server.documents import (
    DocumentResponse,
    RevisionRequest,
    _response,
    _with_edit,
)
from vibesketcher.server.store import Conflict, Entry, NotFound, Store


[docs] class CompositePreviewRequest(BaseModel): model_config = ConfigDict(extra="forbid") composite: dict[str, Any]
[docs] class CompositeRequest(RevisionRequest): composite: dict[str, Any]
[docs] class CompositeUndoRequest(RevisionRequest): structure: str
def _errors(error: ValidationError) -> list[str]: return [f"{'.'.join(str(x) for x in e['loc'])}: {e['msg']}" for e in error.errors()]
[docs] def router(store: Store) -> APIRouter: routes = APIRouter( prefix="/api/documents/{identifier}/periodic/cnt-composite", tags=["periodic composite"] ) def entry_or_404(identifier: str) -> Entry: try: return store.get(identifier) except NotFound: raise HTTPException(404, f"no document {identifier!r}") from None def check(entry: Entry, revision: int) -> None: if revision != entry.document.revision: raise HTTPException(409, {"revision": entry.document.revision}) def commit(entry: Entry, document: Document, request: RevisionRequest, summary: str) -> Any: try: replaced = store.replace( entry.id, _with_edit(document, request, summary), expected=request.revision, warnings=entry.warnings, ) except Conflict as error: raise HTTPException(409, {"message": str(error), "revision": error.current}) from None return _response(replaced) @routes.get("/examples") def composite_examples(identifier: str) -> dict[str, Any]: """The representative example requests tied to the source papers.""" from vibesketcher.document.cnt_composites import EXAMPLES, example entry_or_404(identifier) return {"examples": {name: example(name) for name in sorted(EXAMPLES)}} @routes.post("/preview") def composite_preview(identifier: str, request: CompositePreviewRequest) -> dict[str, Any]: """Tubes, chains, composition, checks, refusals and the model; no change.""" from vibesketcher.document.cnt_composites import parse_composite, preview entry = entry_or_404(identifier) try: composite = parse_composite(request.composite) except ValidationError as error: raise HTTPException(422, {"errors": _errors(error)}) from None result = preview(composite, entry.document) return {"revision": entry.document.revision, **result} @routes.post("") def composite_apply(identifier: str, request: CompositeRequest) -> DocumentResponse: """Add the composite model; refused while the preview has refusals.""" from vibesketcher.document.cnt_composites import apply, parse_composite entry = entry_or_404(identifier) check(entry, request.revision) try: composite = parse_composite(request.composite) document = apply(entry.document, composite) except ValidationError as error: raise HTTPException(422, {"errors": _errors(error)}) from None except ValueError as error: raise HTTPException(422, {"errors": [str(error)]}) from None response: DocumentResponse = commit( entry, document, request, f"Built the CNT composite {composite.identifier}" ) return response @routes.post("/undo") def composite_undo(identifier: str, request: CompositeUndoRequest) -> DocumentResponse: """Remove a composite model again while it is unchanged.""" from vibesketcher.document.cnt_composites import undo entry = entry_or_404(identifier) check(entry, request.revision) try: document = undo(entry.document, request.structure) except ValueError as error: raise HTTPException(409, {"errors": [str(error)]}) from None response: DocumentResponse = commit( entry, document, request, f"Undid the CNT composite {request.structure}" ) return response return routes