basic-memory 0.16.1__py3-none-any.whl → 0.17.4__py3-none-any.whl

basic_memory/ignore_utils.py

@@ -161,13 +161,13 @@ def load_bmignore_patterns() -> Set[str]:
                 # Skip empty lines and comments
                 if line and not line.startswith("#"):
                     patterns.add(line)
-    except Exception:
+    except Exception:  # pragma: no cover
         # If we can't read .bmignore, fall back to defaults
-        return set(DEFAULT_IGNORE_PATTERNS)
+        return set(DEFAULT_IGNORE_PATTERNS)  # pragma: no cover
 
     # If no patterns were loaded, use defaults
-    if not patterns:
-        return set(DEFAULT_IGNORE_PATTERNS)
+    if not patterns:  # pragma: no cover
+        return set(DEFAULT_IGNORE_PATTERNS)  # pragma: no cover
 
     return patterns
 
@@ -261,7 +261,7 @@ def should_ignore_path(file_path: Path, base_path: Path, ignore_patterns: Set[st
 
             # Glob pattern match on full path
             if fnmatch.fnmatch(relative_posix, pattern) or fnmatch.fnmatch(relative_str, pattern):
-                return True
+                return True  # pragma: no cover
 
         return False
     except ValueError:

basic_memory/importers/base.py

@@ -3,28 +3,43 @@
 import logging
 from abc import abstractmethod
 from pathlib import Path
-from typing import Any, Optional, TypeVar
+from typing import TYPE_CHECKING, Any, Optional, TypeVar
 
 from basic_memory.markdown.markdown_processor import MarkdownProcessor
 from basic_memory.markdown.schemas import EntityMarkdown
 from basic_memory.schemas.importer import ImportResult
 
+if TYPE_CHECKING:  # pragma: no cover
+    from basic_memory.services.file_service import FileService
+
 logger = logging.getLogger(__name__)
 
 T = TypeVar("T", bound=ImportResult)
 
 
 class Importer[T: ImportResult]:
-    """Base class for all import services."""
-
-    def __init__(self, base_path: Path, markdown_processor: MarkdownProcessor):
+    """Base class for all import services.
+
+    All file operations are delegated to FileService, which can be overridden
+    in cloud environments to use S3 or other storage backends.
+    """
+
+    def __init__(
+        self,
+        base_path: Path,
+        markdown_processor: MarkdownProcessor,
+        file_service: "FileService",
+    ):
         """Initialize the import service.
 
         Args:
-            markdown_processor: MarkdownProcessor instance for writing markdown files.
+            base_path: Base path for the project.
+            markdown_processor: MarkdownProcessor instance for markdown serialization.
+            file_service: FileService instance for all file operations.
         """
         self.base_path = base_path.resolve()  # Get absolute path
         self.markdown_processor = markdown_processor
+        self.file_service = file_service
 
     @abstractmethod
     async def import_data(self, source_data, destination_folder: str, **kwargs: Any) -> T:
@@ -40,28 +55,34 @@ class Importer[T: ImportResult]:
         """
         pass  # pragma: no cover
 
-    async def write_entity(self, entity: EntityMarkdown, file_path: Path) -> None:
-        """Write entity to file using markdown processor.
+    async def write_entity(self, entity: EntityMarkdown, file_path: str | Path) -> str:
+        """Write entity to file using FileService.
+
+        This method serializes the entity to markdown and writes it using
+        FileService, which handles directory creation and storage backend
+        abstraction (local filesystem vs cloud storage).
 
         Args:
             entity: EntityMarkdown instance to write.
-            file_path: Path to write the entity to.
+            file_path: Relative path to write the entity to. FileService handles base_path.
+
+        Returns:
+            Checksum of written file.
         """
-        await self.markdown_processor.write_file(file_path, entity)
+        content = self.markdown_processor.to_markdown_string(entity)
+        # FileService.write_file handles directory creation and returns checksum
+        return await self.file_service.write_file(file_path, content)
 
-    def ensure_folder_exists(self, folder: str) -> Path:
-        """Ensure folder exists, create if it doesn't.
+    async def ensure_folder_exists(self, folder: str) -> None:
+        """Ensure folder exists using FileService.
 
-        Args:
-            base_path: Base path of the project.
-            folder: Folder name or path within the project.
+        For cloud storage (S3), this is essentially a no-op since S3 doesn't
+        have actual folders - they're just key prefixes.
 
-        Returns:
-            Path to the folder.
+        Args:
+            folder: Relative folder path within the project. FileService handles base_path.
         """
-        folder_path = self.base_path / folder
-        folder_path.mkdir(parents=True, exist_ok=True)
-        return folder_path
+        await self.file_service.ensure_directory(folder)
 
     @abstractmethod
     def handle_error(

basic_memory/importers/chatgpt_importer.py

@@ -15,6 +15,19 @@ logger = logging.getLogger(__name__)
 class ChatGPTImporter(Importer[ChatImportResult]):
     """Service for importing ChatGPT conversations."""
 
+    def handle_error(  # pragma: no cover
+        self, message: str, error: Optional[Exception] = None
+    ) -> ChatImportResult:
+        """Return a failed ChatImportResult with an error message."""
+        error_msg = f"{message}: {error}" if error else message
+        return ChatImportResult(
+            import_count={},
+            success=False,
+            error_message=error_msg,
+            conversations=0,
+            messages=0,
+        )
+
     async def import_data(
         self, source_data, destination_folder: str, **kwargs: Any
     ) -> ChatImportResult:
@@ -30,7 +43,7 @@ class ChatGPTImporter(Importer[ChatImportResult]):
         """
         try:  # pragma: no cover
             # Ensure the destination folder exists
-            self.ensure_folder_exists(destination_folder)
+            await self.ensure_folder_exists(destination_folder)
             conversations = source_data
 
             # Process each conversation
@@ -41,8 +54,8 @@ class ChatGPTImporter(Importer[ChatImportResult]):
                 # Convert to entity
                 entity = self._format_chat_content(destination_folder, chat)
 
-                # Write file
-                file_path = self.base_path / f"{entity.frontmatter.metadata['permalink']}.md"
+                # Write file using relative path - FileService handles base_path
+                file_path = f"{entity.frontmatter.metadata['permalink']}.md"
                 await self.write_entity(entity, file_path)
 
                 # Count messages
@@ -67,7 +80,7 @@ class ChatGPTImporter(Importer[ChatImportResult]):
 
         except Exception as e:  # pragma: no cover
             logger.exception("Failed to import ChatGPT conversations")
-            return self.handle_error("Failed to import ChatGPT conversations", e)  # pyright: ignore [reportReturnType]
+            return self.handle_error("Failed to import ChatGPT conversations", e)
 
     def _format_chat_content(
         self, folder: str, conversation: Dict[str, Any]

basic_memory/importers/claude_conversations_importer.py

@@ -2,8 +2,7 @@
 
 import logging
 from datetime import datetime
-from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 from basic_memory.markdown.schemas import EntityFrontmatter, EntityMarkdown
 from basic_memory.importers.base import Importer
@@ -16,6 +15,19 @@ logger = logging.getLogger(__name__)
 class ClaudeConversationsImporter(Importer[ChatImportResult]):
     """Service for importing Claude conversations."""
 
+    def handle_error(  # pragma: no cover
+        self, message: str, error: Optional[Exception] = None
+    ) -> ChatImportResult:
+        """Return a failed ChatImportResult with an error message."""
+        error_msg = f"{message}: {error}" if error else message
+        return ChatImportResult(
+            import_count={},
+            success=False,
+            error_message=error_msg,
+            conversations=0,
+            messages=0,
+        )
+
     async def import_data(
         self, source_data, destination_folder: str, **kwargs: Any
     ) -> ChatImportResult:
@@ -31,7 +43,7 @@ class ClaudeConversationsImporter(Importer[ChatImportResult]):
         """
         try:
             # Ensure the destination folder exists
-            folder_path = self.ensure_folder_exists(destination_folder)
+            await self.ensure_folder_exists(destination_folder)
 
             conversations = source_data
 
@@ -40,17 +52,20 @@ class ClaudeConversationsImporter(Importer[ChatImportResult]):
             chats_imported = 0
 
             for chat in conversations:
+                # Get name, providing default for unnamed conversations
+                chat_name = chat.get("name") or f"Conversation {chat.get('uuid', 'untitled')}"
+
                 # Convert to entity
                 entity = self._format_chat_content(
-                    base_path=folder_path,
-                    name=chat["name"],
+                    folder=destination_folder,
+                    name=chat_name,
                     messages=chat["chat_messages"],
                     created_at=chat["created_at"],
                     modified_at=chat["updated_at"],
                 )
 
-                # Write file
-                file_path = self.base_path / Path(f"{entity.frontmatter.metadata['permalink']}.md")
+                # Write file using relative path - FileService handles base_path
+                file_path = f"{entity.frontmatter.metadata['permalink']}.md"
                 await self.write_entity(entity, file_path)
 
                 chats_imported += 1
@@ -65,11 +80,11 @@ class ClaudeConversationsImporter(Importer[ChatImportResult]):
 
         except Exception as e:  # pragma: no cover
             logger.exception("Failed to import Claude conversations")
-            return self.handle_error("Failed to import Claude conversations", e)  # pyright: ignore [reportReturnType]
+            return self.handle_error("Failed to import Claude conversations", e)
 
     def _format_chat_content(
         self,
-        base_path: Path,
+        folder: str,
         name: str,
         messages: List[Dict[str, Any]],
         created_at: str,
@@ -78,7 +93,7 @@ class ClaudeConversationsImporter(Importer[ChatImportResult]):
         """Convert chat messages to Basic Memory entity format.
 
         Args:
-            base_path: Base path for the entity.
+            folder: Destination folder name (relative path).
             name: Chat name.
             messages: List of chat messages.
             created_at: Creation timestamp.
@@ -87,10 +102,10 @@ class ClaudeConversationsImporter(Importer[ChatImportResult]):
         Returns:
             EntityMarkdown instance representing the conversation.
         """
-        # Generate permalink
+        # Generate permalink using folder name (relative path)
         date_prefix = datetime.fromisoformat(created_at.replace("Z", "+00:00")).strftime("%Y%m%d")
         clean_title = clean_filename(name)
-        permalink = f"{base_path.name}/{date_prefix}-{clean_title}"
+        permalink = f"{folder}/{date_prefix}-{clean_title}"
 
         # Format content
         content = self._format_chat_markdown(

basic_memory/importers/claude_projects_importer.py

@@ -14,6 +14,19 @@ logger = logging.getLogger(__name__)
 class ClaudeProjectsImporter(Importer[ProjectImportResult]):
     """Service for importing Claude projects."""
 
+    def handle_error(  # pragma: no cover
+        self, message: str, error: Optional[Exception] = None
+    ) -> ProjectImportResult:
+        """Return a failed ProjectImportResult with an error message."""
+        error_msg = f"{message}: {error}" if error else message
+        return ProjectImportResult(
+            import_count={},
+            success=False,
+            error_message=error_msg,
+            documents=0,
+            prompts=0,
+        )
+
     async def import_data(
         self, source_data, destination_folder: str, **kwargs: Any
     ) -> ProjectImportResult:
@@ -29,9 +42,8 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
         """
         try:
             # Ensure the base folder exists
-            base_path = self.base_path
             if destination_folder:
-                base_path = self.ensure_folder_exists(destination_folder)
+                await self.ensure_folder_exists(destination_folder)
 
             projects = source_data
 
@@ -42,20 +54,26 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
             for project in projects:
                 project_dir = clean_filename(project["name"])
 
-                # Create project directories
-                docs_dir = base_path / project_dir / "docs"
-                docs_dir.mkdir(parents=True, exist_ok=True)
+                # Create project directories using FileService with relative path
+                docs_dir = (
+                    f"{destination_folder}/{project_dir}/docs"
+                    if destination_folder
+                    else f"{project_dir}/docs"
+                )
+                await self.file_service.ensure_directory(docs_dir)
 
                 # Import prompt template if it exists
-                if prompt_entity := self._format_prompt_markdown(project):
-                    file_path = base_path / f"{prompt_entity.frontmatter.metadata['permalink']}.md"
+                if prompt_entity := self._format_prompt_markdown(project, destination_folder):
+                    # Write file using relative path - FileService handles base_path
+                    file_path = f"{prompt_entity.frontmatter.metadata['permalink']}.md"
                     await self.write_entity(prompt_entity, file_path)
                     prompts_imported += 1
 
                 # Import project documents
                 for doc in project.get("docs", []):
-                    entity = self._format_project_markdown(project, doc)
-                    file_path = base_path / f"{entity.frontmatter.metadata['permalink']}.md"
+                    entity = self._format_project_markdown(project, doc, destination_folder)
+                    # Write file using relative path - FileService handles base_path
+                    file_path = f"{entity.frontmatter.metadata['permalink']}.md"
                     await self.write_entity(entity, file_path)
                     docs_imported += 1
 
@@ -68,16 +86,17 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
 
         except Exception as e:  # pragma: no cover
             logger.exception("Failed to import Claude projects")
-            return self.handle_error("Failed to import Claude projects", e)  # pyright: ignore [reportReturnType]
+            return self.handle_error("Failed to import Claude projects", e)
 
     def _format_project_markdown(
-        self, project: Dict[str, Any], doc: Dict[str, Any]
+        self, project: Dict[str, Any], doc: Dict[str, Any], destination_folder: str = ""
     ) -> EntityMarkdown:
         """Format a project document as a Basic Memory entity.
 
         Args:
             project: Project data.
             doc: Document data.
+            destination_folder: Optional destination folder prefix.
 
         Returns:
             EntityMarkdown instance representing the document.
@@ -90,6 +109,13 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
         project_dir = clean_filename(project["name"])
         doc_file = clean_filename(doc["filename"])
 
+        # Build permalink with optional destination folder prefix
+        permalink = (
+            f"{destination_folder}/{project_dir}/docs/{doc_file}"
+            if destination_folder
+            else f"{project_dir}/docs/{doc_file}"
+        )
+
         # Create entity
         entity = EntityMarkdown(
             frontmatter=EntityFrontmatter(
@@ -98,7 +124,7 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
                     "title": doc["filename"],
                     "created": created_at,
                     "modified": modified_at,
-                    "permalink": f"{project_dir}/docs/{doc_file}",
+                    "permalink": permalink,
                     "project_name": project["name"],
                     "project_uuid": project["uuid"],
                     "doc_uuid": doc["uuid"],
@@ -109,11 +135,14 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
 
         return entity
 
-    def _format_prompt_markdown(self, project: Dict[str, Any]) -> Optional[EntityMarkdown]:
+    def _format_prompt_markdown(
+        self, project: Dict[str, Any], destination_folder: str = ""
+    ) -> Optional[EntityMarkdown]:
         """Format project prompt template as a Basic Memory entity.
 
         Args:
             project: Project data.
+            destination_folder: Optional destination folder prefix.
 
         Returns:
             EntityMarkdown instance representing the prompt template, or None if
@@ -129,6 +158,13 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
         # Generate clean project directory name
         project_dir = clean_filename(project["name"])
 
+        # Build permalink with optional destination folder prefix
+        permalink = (
+            f"{destination_folder}/{project_dir}/prompt-template"
+            if destination_folder
+            else f"{project_dir}/prompt-template"
+        )
+
         # Create entity
         entity = EntityMarkdown(
             frontmatter=EntityFrontmatter(
@@ -137,7 +173,7 @@ class ClaudeProjectsImporter(Importer[ProjectImportResult]):
                     "title": f"Prompt Template: {project['name']}",
                     "created": created_at,
                     "modified": modified_at,
-                    "permalink": f"{project_dir}/prompt-template",
+                    "permalink": permalink,
                     "project_name": project["name"],
                     "project_uuid": project["uuid"],
                 }

basic_memory/importers/memory_json_importer.py

@@ -1,9 +1,8 @@
 """Memory JSON import service for Basic Memory."""
 
 import logging
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
-from basic_memory.config import get_project_config
 from basic_memory.markdown.schemas import EntityFrontmatter, EntityMarkdown, Observation, Relation
 from basic_memory.importers.base import Importer
 from basic_memory.schemas.importer import EntityImportResult
@@ -14,6 +13,20 @@ logger = logging.getLogger(__name__)
 class MemoryJsonImporter(Importer[EntityImportResult]):
     """Service for importing memory.json format data."""
 
+    def handle_error(  # pragma: no cover
+        self, message: str, error: Optional[Exception] = None
+    ) -> EntityImportResult:
+        """Return a failed EntityImportResult with an error message."""
+        error_msg = f"{message}: {error}" if error else message
+        return EntityImportResult(
+            import_count={},
+            success=False,
+            error_message=error_msg,
+            entities=0,
+            relations=0,
+            skipped_entities=0,
+        )
+
     async def import_data(
         self, source_data, destination_folder: str = "", **kwargs: Any
     ) -> EntityImportResult:
@@ -27,17 +40,15 @@ class MemoryJsonImporter(Importer[EntityImportResult]):
         Returns:
             EntityImportResult containing statistics and status of the import.
         """
-        config = get_project_config()
         try:
             # First pass - collect all relations by source entity
             entity_relations: Dict[str, List[Relation]] = {}
             entities: Dict[str, Dict[str, Any]] = {}
             skipped_entities: int = 0
 
-            # Ensure the base path exists
-            base_path = config.home  # pragma: no cover
+            # Ensure the destination folder exists if provided
             if destination_folder:  # pragma: no cover
-                base_path = self.ensure_folder_exists(destination_folder)
+                await self.ensure_folder_exists(destination_folder)
 
             # First pass - collect entities and relations
             for line in source_data:
@@ -46,9 +57,9 @@ class MemoryJsonImporter(Importer[EntityImportResult]):
                     # Handle different possible name keys
                     entity_name = data.get("name") or data.get("entityName") or data.get("id")
                     if not entity_name:
-                        logger.warning(f"Entity missing name field: {data}")
-                        skipped_entities += 1
-                        continue
+                        logger.warning(f"Entity missing name field: {data}")  # pragma: no cover
+                        skipped_entities += 1  # pragma: no cover
+                        continue  # pragma: no cover
                     entities[entity_name] = data
                 elif data["type"] == "relation":
                     # Store relation with its source entity
@@ -68,9 +79,18 @@ class MemoryJsonImporter(Importer[EntityImportResult]):
                 # Get entity type with fallback
                 entity_type = entity_data.get("entityType") or entity_data.get("type") or "entity"
 
-                # Ensure entity type directory exists
-                entity_type_dir = base_path / entity_type
-                entity_type_dir.mkdir(parents=True, exist_ok=True)
+                # Build permalink with optional destination folder prefix
+                permalink = (
+                    f"{destination_folder}/{entity_type}/{name}"
+                    if destination_folder
+                    else f"{entity_type}/{name}"
+                )
+
+                # Ensure entity type directory exists using FileService with relative path
+                entity_type_dir = (
+                    f"{destination_folder}/{entity_type}" if destination_folder else entity_type
+                )
+                await self.file_service.ensure_directory(entity_type_dir)
 
                 # Get observations with fallback to empty list
                 observations = entity_data.get("observations", [])
@@ -80,7 +100,7 @@ class MemoryJsonImporter(Importer[EntityImportResult]):
                         metadata={
                             "type": entity_type,
                             "title": name,
-                            "permalink": f"{entity_type}/{name}",
+                            "permalink": permalink,
                         }
                     ),
                     content=f"# {name}\n",
@@ -88,8 +108,8 @@ class MemoryJsonImporter(Importer[EntityImportResult]):
                     relations=entity_relations.get(name, []),
                 )
 
-                # Write entity file
-                file_path = base_path / f"{entity_type}/{name}.md"
+                # Write file using relative path - FileService handles base_path
+                file_path = f"{entity.frontmatter.metadata['permalink']}.md"
                 await self.write_entity(entity, file_path)
                 entities_created += 1
 
@@ -105,4 +125,4 @@ class MemoryJsonImporter(Importer[EntityImportResult]):
 
         except Exception as e:  # pragma: no cover
             logger.exception("Failed to import memory.json")
-            return self.handle_error("Failed to import memory.json", e)  # pyright: ignore [reportReturnType]
+            return self.handle_error("Failed to import memory.json", e)

basic_memory/importers/utils.py

@@ -5,15 +5,18 @@ from datetime import datetime
 from typing import Any
 
 
-def clean_filename(name: str) -> str:  # pragma: no cover
+def clean_filename(name: str | None) -> str:  # pragma: no cover
     """Clean a string to be used as a filename.
 
     Args:
-        name: The string to clean.
+        name: The string to clean (can be None).
 
     Returns:
         A cleaned string suitable for use as a filename.
     """
+    # Handle None or empty input
+    if not name:
+        return "untitled"
     # Replace common punctuation and whitespace with underscores
     name = re.sub(r"[\s\-,.:/\\\[\]\(\)]+", "_", name)
     # Remove any non-alphanumeric or underscore characters