mirror of
https://github.com/VectifyAI/PageIndex.git
synced 2026-07-15 21:11:05 +02:00
703017e581
Replace the `...` bodies in DocumentParser / StorageEngine protocol methods with one-line docstrings: silences the CodeQL "statement has no effect" false positives on #272 (`...` is idiomatic for typing.Protocol, but docstrings document the contract and don't trip the analyzer) with no behavior change. Claude-Session: https://claude.ai/code/session_01Kx5DgKbhK1N8autqXH8SmS
43 lines
1.6 KiB
Python
43 lines
1.6 KiB
Python
from __future__ import annotations
|
|
from typing import Protocol, runtime_checkable
|
|
|
|
|
|
@runtime_checkable
|
|
class StorageEngine(Protocol):
|
|
"""Persistence contract for collections and their documents."""
|
|
|
|
def create_collection(self, name: str) -> None:
|
|
"""Create a new collection; error if it already exists."""
|
|
|
|
def get_or_create_collection(self, name: str) -> None:
|
|
"""Create the collection if absent; no-op if it already exists."""
|
|
|
|
def list_collections(self) -> list[str]:
|
|
"""Return all collection names."""
|
|
|
|
def delete_collection(self, name: str) -> None:
|
|
"""Delete a collection and all its documents."""
|
|
|
|
def save_document(self, collection: str, doc_id: str, doc: dict) -> None:
|
|
"""Persist a document under a collection."""
|
|
|
|
def find_document_by_hash(self, collection: str, file_hash: str) -> str | None:
|
|
"""Return the doc_id with this file hash in the collection, or None."""
|
|
|
|
def get_document(self, collection: str, doc_id: str) -> dict:
|
|
"""Return a document's metadata."""
|
|
|
|
def get_document_structure(self, collection: str, doc_id: str) -> list:
|
|
"""Return a document's tree structure."""
|
|
|
|
def get_pages(self, collection: str, doc_id: str) -> list | None:
|
|
"""Return cached page content, or None if not cached."""
|
|
|
|
def list_documents(self, collection: str) -> list[dict]:
|
|
"""Return metadata for all documents in a collection."""
|
|
|
|
def delete_document(self, collection: str, doc_id: str) -> None:
|
|
"""Delete a single document from a collection."""
|
|
|
|
def close(self) -> None:
|
|
"""Release any underlying resources (connections, handles)."""
|