mirror of
https://github.com/basicmachines-co/basic-memory
synced 2026-06-21 13:47:35 +00:00
219 lines
8.0 KiB
Python
219 lines
8.0 KiB
Python
"""Parser for Basic Memory entity markdown files."""
|
|
|
|
from typing import Dict, Any, Optional
|
|
|
|
from loguru import logger
|
|
|
|
from basic_memory.markdown.base_parser import MarkdownParser, ParseError
|
|
from basic_memory.markdown.schemas import (
|
|
Entity,
|
|
EntityFrontmatter,
|
|
EntityContent,
|
|
EntityMetadata,
|
|
Observation,
|
|
Relation,
|
|
)
|
|
|
|
|
|
class EntityParser(MarkdownParser[Entity]):
|
|
"""
|
|
Parser for entity markdown files.
|
|
|
|
Entity files must have:
|
|
- YAML frontmatter (type, id, created, modified, tags)
|
|
- Title (# Title)
|
|
- Optional description
|
|
- Observations section (## Observations)
|
|
- Relations section (## Relations)
|
|
- Optional metadata section
|
|
"""
|
|
|
|
async def parse_frontmatter(self, frontmatter: Dict[str, Any]) -> EntityFrontmatter:
|
|
"""Parse entity frontmatter."""
|
|
try:
|
|
# Preprocess fields for schema validation
|
|
processed = frontmatter.copy()
|
|
|
|
# Ensure id is string
|
|
if "id" in processed:
|
|
processed["id"] = str(processed["id"])
|
|
|
|
# Handle tags field
|
|
if "tags" in processed:
|
|
if isinstance(processed["tags"], str):
|
|
# Split comma-separated tags and strip whitespace
|
|
processed["tags"] = [tag.strip() for tag in processed["tags"].split(",")]
|
|
|
|
return EntityFrontmatter(**processed)
|
|
|
|
except Exception as e:
|
|
logger.error(f"Invalid entity frontmatter: {e}")
|
|
raise ParseError(f"Invalid entity frontmatter: {str(e)}") from e
|
|
|
|
async def parse_content(self, title: str, sections: Dict[str, str]) -> EntityContent:
|
|
"""Parse entity content section."""
|
|
try:
|
|
# Get description (if any)
|
|
description = None
|
|
if "description" in sections:
|
|
description = sections["description"]
|
|
|
|
# Parse observations (required)
|
|
observations = []
|
|
if "observations" not in sections:
|
|
raise ParseError("Missing required observations section")
|
|
|
|
for line in sections["observations"].splitlines():
|
|
if line and not line.isspace():
|
|
observation = await self._parse_observation(line)
|
|
if observation:
|
|
observations.append(observation)
|
|
|
|
# Parse relations (optional)
|
|
relations = []
|
|
if "relations" in sections:
|
|
for line in sections["relations"].splitlines():
|
|
if line and not line.isspace():
|
|
relation = await self._parse_relation(line)
|
|
if relation:
|
|
relations.append(relation)
|
|
|
|
return EntityContent(
|
|
title=title, description=description, observations=observations, relations=relations
|
|
)
|
|
|
|
except ParseError:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Invalid entity content: {e}")
|
|
raise ParseError(f"Invalid entity content: {str(e)}") from e
|
|
|
|
async def parse_observation(self, line: str) -> Optional[Observation]:
|
|
"""Parse a single observation line."""
|
|
if not line or line.isspace():
|
|
return None
|
|
|
|
try:
|
|
# Remove leading/trailing whitespace and bullet
|
|
line = line.strip()
|
|
if not line.startswith("-"):
|
|
raise ParseError("Observation must start with -")
|
|
line = line[1:].strip()
|
|
|
|
# Extract optional category [category]
|
|
category = None
|
|
content = line
|
|
if line.startswith("["):
|
|
close_bracket = line.find("]")
|
|
if close_bracket == -1:
|
|
raise ParseError("Unclosed category bracket")
|
|
|
|
category = line[1:close_bracket].strip()
|
|
if not category:
|
|
raise ParseError("Empty category brackets")
|
|
|
|
content = line[close_bracket + 1 :].strip()
|
|
|
|
# Extract context if present (context)
|
|
context = None
|
|
if content.endswith(")"):
|
|
last_open = content.rfind("(")
|
|
if last_open != -1:
|
|
# Check if these parentheses are part of content or a context marker
|
|
# by looking for hashtags between them
|
|
section_after_paren = content[last_open:]
|
|
if "#" not in section_after_paren:
|
|
context = content[last_open + 1 : -1].strip()
|
|
content = content[:last_open].strip()
|
|
|
|
# Extract tags and clean content
|
|
tags = []
|
|
content_parts = []
|
|
for part in content.split():
|
|
if part.startswith("#"):
|
|
# Handle multiple hashtags stuck together
|
|
if "#" in part[1:]:
|
|
multi_tags = part.split("#")
|
|
tags.extend(t for t in multi_tags if t)
|
|
else:
|
|
tags.append(part[1:])
|
|
else:
|
|
content_parts.append(part)
|
|
|
|
content = " ".join(content_parts).strip()
|
|
if not content:
|
|
raise ParseError("Empty content")
|
|
|
|
return Observation(
|
|
category=category, content=content, tags=tags if tags else None, context=context
|
|
)
|
|
|
|
except ParseError:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Failed to parse observation: {e}")
|
|
raise ParseError(f"Failed to parse observation: {str(e)}") from e
|
|
|
|
async def parse_relation(self, line: str) -> Optional[Relation]:
|
|
"""Parse a single relation line."""
|
|
if not line or line.isspace():
|
|
return None
|
|
|
|
try:
|
|
# Remove leading/trailing whitespace and bullet
|
|
line = line.strip()
|
|
if not line.startswith("-"):
|
|
raise ParseError("Relation must start with -")
|
|
line = line[1:].strip()
|
|
|
|
# Extract context if present (context)
|
|
context = None
|
|
if line.endswith(")"):
|
|
context_start = line.rfind("(")
|
|
if context_start != -1:
|
|
context = line[context_start + 1 : -1].strip()
|
|
line = line[:context_start].strip()
|
|
|
|
# Extract relation type and target [[Entity]]
|
|
if "[[" not in line or "]]" not in line:
|
|
raise ParseError("Invalid relation format - missing [[entity]]")
|
|
|
|
# Split into relation type and target
|
|
parts = line.split("[[", 1)
|
|
rel_type = parts[0].strip()
|
|
if not rel_type:
|
|
raise ParseError("Missing relation type")
|
|
|
|
target_part = parts[1]
|
|
close_pos = target_part.find("]]")
|
|
if close_pos == -1:
|
|
raise ParseError("Unclosed [[ ]] in target")
|
|
|
|
target = target_part[:close_pos].strip()
|
|
if not target:
|
|
raise ParseError("Empty target entity")
|
|
|
|
return Relation(type=rel_type, target=target, context=context)
|
|
|
|
except ParseError:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Failed to parse relation: {e}")
|
|
raise ParseError(f"Failed to parse relation: {str(e)}") from e
|
|
|
|
async def parse_metadata(self, metadata: Optional[Dict[str, Any]]) -> EntityMetadata:
|
|
"""Parse entity metadata section."""
|
|
try:
|
|
if not metadata:
|
|
return EntityMetadata()
|
|
return EntityMetadata(metadata=metadata)
|
|
except Exception as e:
|
|
logger.error(f"Invalid entity metadata: {e}")
|
|
raise ParseError(f"Invalid entity metadata: {str(e)}") from e
|
|
|
|
async def create_document(
|
|
self, frontmatter: EntityFrontmatter, content: EntityContent, metadata: EntityMetadata
|
|
) -> Entity:
|
|
"""Create entity from parsed sections."""
|
|
return Entity(frontmatter=frontmatter, content=content, metadata=metadata)
|