mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-09-22 00:32:49 +00:00
d9114469e3
BREAKING CHANGE: Removed the iter_nodes abstract method from BaseFileGraph and its implementations in LocalFileGraph and Neo4jFileGraph as it was no longer being used in the codebase.
72 lines
2.5 KiB
Python
72 lines
2.5 KiB
Python
"""Abstract base for the file-graph engine.
|
|
|
|
The file-graph owns ``FileNode`` records keyed by vault-relative path
|
|
and serves graph traversal over wikilink links. file_graph trusts
|
|
``FileLink.path`` directly — there is no internal wikilink resolution.
|
|
Pre-resolution forms (raw stem-form wikilinks like ``[[Foo]]``) are a
|
|
vault convention resolved by the external ``utils.wikilink_resolver``
|
|
before nodes are upserted.
|
|
|
|
Contract — six abstract methods, two blocks:
|
|
|
|
Node CRUD upsert_node, delete_node, get_node, iter_nodes
|
|
Link access get_outlinks, get_inlinks
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
from abc import abstractmethod
|
|
from collections.abc import AsyncIterator
|
|
from pathlib import Path
|
|
|
|
from ..base_component import BaseComponent
|
|
from ...enumeration import ComponentEnum
|
|
from ...schema import FileLink, FileNode
|
|
|
|
|
|
class BaseFileGraph(BaseComponent):
|
|
"""Pluggable file-graph backend — node CRUD + link adjacency."""
|
|
|
|
component_type = ComponentEnum.FILE_GRAPH
|
|
|
|
def __init__(self, store_name: str = "default", **kwargs):
|
|
super().__init__(**kwargs)
|
|
if not re.match(r"^[a-zA-Z0-9_]+$", store_name):
|
|
raise ValueError(
|
|
f"Invalid store name '{store_name}'. " f"Only alphanumeric and underscores allowed.",
|
|
)
|
|
self.store_name: str = store_name
|
|
self.working_dir: str = self.app_context.app_config.working_dir if self.app_context else ""
|
|
self.store_path: Path = Path(self.working_dir) / "file_graph" / store_name
|
|
self.store_path.mkdir(parents=True, exist_ok=True)
|
|
|
|
# -- Node CRUD ---------------------------------------------------------
|
|
|
|
@abstractmethod
|
|
async def upsert_node(self, node: FileNode) -> None:
|
|
"""Add or replace a node and its outgoing links."""
|
|
|
|
@abstractmethod
|
|
async def delete_node(self, path: str) -> FileNode | None:
|
|
"""Remove a node + its incident links. Returns the removed node, or None."""
|
|
|
|
@abstractmethod
|
|
async def get_node(self, path: str) -> FileNode | None:
|
|
"""Single-node lookup."""
|
|
|
|
# -- Link access -------------------------------------------------------
|
|
|
|
@abstractmethod
|
|
async def get_outlinks(
|
|
self,
|
|
path: str,
|
|
) -> list[tuple[FileNode, FileLink]]:
|
|
"""Resolved outgoing links from ``path``."""
|
|
|
|
@abstractmethod
|
|
async def get_inlinks(
|
|
self,
|
|
path: str,
|
|
) -> list[tuple[FileNode, FileLink]]:
|
|
"""Resolved incoming links to ``path``."""
|