kicad-sch-api 0.3.5__py3-none-any.whl → 0.4.1__py3-none-any.whl

kicad_sch_api/core/junctions.py

@@ -9,55 +9,34 @@ import logging
 import uuid as uuid_module
 from typing import Any, Dict, List, Optional, Tuple, Union
 
+from .collections import BaseCollection
 from .types import Junction, Point
 
 logger = logging.getLogger(__name__)
 
 
-class JunctionCollection:
+class JunctionCollection(BaseCollection[Junction]):
     """
     Professional junction collection with enhanced management features.
 
+    Inherits from BaseCollection for standard operations and adds junction-specific
+    functionality.
+
     Features:
-    - Fast UUID-based lookup and indexing
+    - Fast UUID-based lookup and indexing (inherited)
     - Position-based junction queries
-    - Bulk operations for performance
+    - Bulk operations for performance (inherited)
     - Validation and conflict detection
     """
 
-    def __init__(self, junctions: Optional[List[Junction]] = None):
+    def __init__(self, junctions: Optional[List[Junction]] = None) -> None:
         """
         Initialize junction collection.
 
         Args:
             junctions: Initial list of junctions
         """
-        self._junctions: List[Junction] = junctions or []
-        self._uuid_index: Dict[str, int] = {}
-        self._modified = False
-
-        # Build UUID index
-        self._rebuild_index()
-
-        logger.debug(f"JunctionCollection initialized with {len(self._junctions)} junctions")
-
-    def _rebuild_index(self):
-        """Rebuild UUID index for fast lookups."""
-        self._uuid_index = {junction.uuid: i for i, junction in enumerate(self._junctions)}
-
-    def __len__(self) -> int:
-        """Number of junctions in collection."""
-        return len(self._junctions)
-
-    def __iter__(self):
-        """Iterate over junctions."""
-        return iter(self._junctions)
-
-    def __getitem__(self, uuid: str) -> Junction:
-        """Get junction by UUID."""
-        if uuid not in self._uuid_index:
-            raise KeyError(f"Junction with UUID '{uuid}' not found")
-        return self._junctions[self._uuid_index[uuid]]
+        super().__init__(junctions, collection_name="junctions")
 
     def add(
         self,
@@ -94,35 +73,12 @@ class JunctionCollection:
         # Create junction
         junction = Junction(uuid=uuid, position=position, diameter=diameter, color=color)
 
-        # Add to collection
-        self._junctions.append(junction)
-        self._uuid_index[uuid] = len(self._junctions) - 1
-        self._modified = True
+        # Add to collection using base class method
+        self._add_item(junction)
 
         logger.debug(f"Added junction at {position}, UUID={uuid}")
         return uuid
 
-    def remove(self, uuid: str) -> bool:
-        """
-        Remove junction by UUID.
-
-        Args:
-            uuid: Junction UUID to remove
-
-        Returns:
-            True if junction was removed, False if not found
-        """
-        if uuid not in self._uuid_index:
-            return False
-
-        index = self._uuid_index[uuid]
-        del self._junctions[index]
-        self._rebuild_index()
-        self._modified = True
-
-        logger.debug(f"Removed junction: {uuid}")
-        return True
-
     def get_at_position(
         self, position: Union[Point, Tuple[float, float]], tolerance: float = 0.01
     ) -> Optional[Junction]:
@@ -139,7 +95,7 @@ class JunctionCollection:
         if isinstance(position, tuple):
             position = Point(position[0], position[1])
 
-        for junction in self._junctions:
+        for junction in self._items:
             if junction.position.distance_to(position) <= tolerance:
                 return junction
 
@@ -162,40 +118,35 @@ class JunctionCollection:
             point = Point(point[0], point[1])
 
         matching_junctions = []
-        for junction in self._junctions:
+        for junction in self._items:
             if junction.position.distance_to(point) <= tolerance:
                 matching_junctions.append(junction)
 
         return matching_junctions
 
     def get_statistics(self) -> Dict[str, Any]:
-        """Get junction collection statistics."""
-        if not self._junctions:
-            return {"total_junctions": 0, "avg_diameter": 0, "positions": []}
+        """Get junction collection statistics (extends base statistics)."""
+        base_stats = super().get_statistics()
+        if not self._items:
+            return {**base_stats, "total_junctions": 0, "avg_diameter": 0, "positions": []}
 
-        avg_diameter = sum(j.diameter for j in self._junctions) / len(self._junctions)
-        positions = [(j.position.x, j.position.y) for j in self._junctions]
+        avg_diameter = sum(j.diameter for j in self._items) / len(self._items)
+        positions = [(j.position.x, j.position.y) for j in self._items]
 
         return {
-            "total_junctions": len(self._junctions),
+            **base_stats,
+            "total_junctions": len(self._items),
             "avg_diameter": avg_diameter,
             "positions": positions,
-            "unique_diameters": len(set(j.diameter for j in self._junctions)),
-            "unique_colors": len(set(j.color for j in self._junctions)),
+            "unique_diameters": len(set(j.diameter for j in self._items)),
+            "unique_colors": len(set(j.color for j in self._items)),
         }
 
-    def clear(self):
-        """Remove all junctions from collection."""
-        self._junctions.clear()
-        self._uuid_index.clear()
-        self._modified = True
-        logger.debug("Cleared all junctions")
-
     @property
     def modified(self) -> bool:
         """Check if collection has been modified."""
-        return self._modified
+        return self.is_modified()
 
-    def mark_saved(self):
+    def mark_saved(self) -> None:
         """Mark collection as saved (reset modified flag)."""
-        self._modified = False
+        self.reset_modified_flag()

kicad_sch_api/core/labels.py

@@ -10,7 +10,8 @@ import uuid
 from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Union
 
 from ..utils.validation import SchematicValidator, ValidationError, ValidationIssue
-from .types import Point, Label
+from .collections import BaseCollection
+from .types import Label, Point
 
 logger = logging.getLogger(__name__)
 
@@ -114,10 +115,13 @@ class LabelElement:
         return f"<Label '{self.text}' @ {self.position}>"
 
 
-class LabelCollection:
+class LabelCollection(BaseCollection[LabelElement]):
     """
     Collection class for efficient label element management.
 
+    Inherits from BaseCollection for standard operations and adds label-specific
+    functionality including text-based indexing.
+
     Provides fast lookup, filtering, and bulk operations for schematic label elements.
     """
 
@@ -128,18 +132,17 @@ class LabelCollection:
         Args:
             labels: Initial list of label data
         """
-        self._labels: List[LabelElement] = []
-        self._uuid_index: Dict[str, LabelElement] = {}
+        # Initialize base collection
+        super().__init__([], collection_name="labels")
+
+        # Additional label-specific index
         self._text_index: Dict[str, List[LabelElement]] = {}
-        self._modified = False
 
         # Add initial labels
         if labels:
             for label_data in labels:
                 self._add_to_indexes(LabelElement(label_data, self))
 
-        logger.debug(f"LabelCollection initialized with {len(self._labels)} labels")
-
     def add(
         self,
         text: str,
@@ -201,9 +204,7 @@ class LabelCollection:
         logger.debug(f"Added label: {label_element}")
         return label_element
 
-    def get(self, label_uuid: str) -> Optional[LabelElement]:
-        """Get label by UUID."""
-        return self._uuid_index.get(label_uuid)
+    # get() method inherited from BaseCollection
 
     def get_by_text(self, text: str) -> List[LabelElement]:
         """Get all labels with the given text."""
@@ -219,13 +220,19 @@ class LabelCollection:
         Returns:
             True if label was removed, False if not found
         """
-        label_element = self._uuid_index.get(label_uuid)
+        label_element = self.get(label_uuid)
         if not label_element:
             return False
 
-        # Remove from indexes
-        self._remove_from_indexes(label_element)
-        self._mark_modified()
+        # Remove from text index
+        text = label_element.text
+        if text in self._text_index:
+            self._text_index[text].remove(label_element)
+            if not self._text_index[text]:
+                del self._text_index[text]
+
+        # Remove using base class method
+        super().remove(label_uuid)
 
         logger.debug(f"Removed label: {label_element}")
         return True
@@ -245,7 +252,7 @@ class LabelCollection:
             return self._text_index.get(text, []).copy()
         else:
             matches = []
-            for label_element in self._labels:
+            for label_element in self._items:
                 if text.lower() in label_element.text.lower():
                     matches.append(label_element)
             return matches
@@ -260,7 +267,7 @@ class LabelCollection:
         Returns:
             List of labels matching predicate
         """
-        return [label for label in self._labels if predicate(label)]
+        return [label for label in self._items if predicate(label)]
 
     def bulk_update(self, criteria: Callable[[LabelElement], bool], updates: Dict[str, Any]):
         """
@@ -271,7 +278,7 @@ class LabelCollection:
             updates: Dictionary of property updates
         """
         updated_count = 0
-        for label_element in self._labels:
+        for label_element in self._items:
             if criteria(label_element):
                 for prop, value in updates.items():
                     if hasattr(label_element, prop):
@@ -284,15 +291,12 @@ class LabelCollection:
 
     def clear(self):
         """Remove all labels from collection."""
-        self._labels.clear()
-        self._uuid_index.clear()
         self._text_index.clear()
-        self._mark_modified()
+        super().clear()
 
     def _add_to_indexes(self, label_element: LabelElement):
-        """Add label to internal indexes."""
-        self._labels.append(label_element)
-        self._uuid_index[label_element.uuid] = label_element
+        """Add label to internal indexes (base + text index)."""
+        self._add_item(label_element)
 
         # Add to text index
         text = label_element.text
@@ -300,18 +304,6 @@ class LabelCollection:
             self._text_index[text] = []
         self._text_index[text].append(label_element)
 
-    def _remove_from_indexes(self, label_element: LabelElement):
-        """Remove label from internal indexes."""
-        self._labels.remove(label_element)
-        del self._uuid_index[label_element.uuid]
-
-        # Remove from text index
-        text = label_element.text
-        if text in self._text_index:
-            self._text_index[text].remove(label_element)
-            if not self._text_index[text]:
-                del self._text_index[text]
-
     def _update_text_index(self, old_text: str, label_element: LabelElement):
         """Update text index when label text changes."""
         # Remove from old text index
@@ -326,23 +318,7 @@ class LabelCollection:
             self._text_index[new_text] = []
         self._text_index[new_text].append(label_element)
 
-    def _mark_modified(self):
-        """Mark collection as modified."""
-        self._modified = True
-
-    # Collection interface methods
-    def __len__(self) -> int:
-        """Return number of labels."""
-        return len(self._labels)
-
-    def __iter__(self) -> Iterator[LabelElement]:
-        """Iterate over labels."""
-        return iter(self._labels)
-
-    def __getitem__(self, index: int) -> LabelElement:
-        """Get label by index."""
-        return self._labels[index]
-
+    # Collection interface methods - __len__, __iter__, __getitem__ inherited from BaseCollection
     def __bool__(self) -> bool:
         """Return True if collection has labels."""
-        return len(self._labels) > 0
+        return len(self._items) > 0

kicad_sch_api/core/managers/__init__.py

@@ -0,0 +1,26 @@
+"""
+Schematic management modules for separating responsibilities.
+
+This package contains specialized managers for different aspects of schematic
+manipulation, enabling clean separation of concerns and better maintainability.
+"""
+
+from .file_io import FileIOManager
+from .format_sync import FormatSyncManager
+from .graphics import GraphicsManager
+from .metadata import MetadataManager
+from .sheet import SheetManager
+from .text_elements import TextElementManager
+from .validation import ValidationManager
+from .wire import WireManager
+
+__all__ = [
+    "FileIOManager",
+    "FormatSyncManager",
+    "GraphicsManager",
+    "MetadataManager",
+    "SheetManager",
+    "TextElementManager",
+    "ValidationManager",
+    "WireManager",
+]

kicad_sch_api/core/managers/file_io.py

@@ -0,0 +1,244 @@
+"""
+File I/O Manager for KiCAD schematic operations.
+
+Handles all file system interactions including loading, saving, and backup operations
+while maintaining exact format preservation.
+"""
+
+import logging
+import time
+from pathlib import Path
+from typing import Any, Dict, Optional, Union
+
+from ...utils.validation import ValidationError
+from ..config import config
+from ..formatter import ExactFormatter
+from ..parser import SExpressionParser
+
+logger = logging.getLogger(__name__)
+
+
+class FileIOManager:
+    """
+    Manages file I/O operations for KiCAD schematics.
+
+    Responsible for:
+    - Loading schematic files with validation
+    - Saving with format preservation
+    - Creating backup files
+    - Managing file paths and metadata
+    """
+
+    def __init__(self):
+        """Initialize the FileIOManager."""
+        self._parser = SExpressionParser(preserve_format=True)
+        self._formatter = ExactFormatter()
+
+    def load_schematic(self, file_path: Union[str, Path]) -> Dict[str, Any]:
+        """
+        Load a KiCAD schematic file.
+
+        Args:
+            file_path: Path to .kicad_sch file
+
+        Returns:
+            Parsed schematic data
+
+        Raises:
+            FileNotFoundError: If file doesn't exist
+            ValidationError: If file is invalid or corrupted
+        """
+        start_time = time.time()
+        file_path = Path(file_path)
+
+        if not file_path.exists():
+            raise FileNotFoundError(f"Schematic file not found: {file_path}")
+
+        if not file_path.suffix == ".kicad_sch":
+            raise ValidationError(f"Not a KiCAD schematic file: {file_path}")
+
+        logger.info(f"Loading schematic: {file_path}")
+
+        try:
+            schematic_data = self._parser.parse_file(file_path)
+            load_time = time.time() - start_time
+            logger.info(f"Loaded schematic in {load_time:.3f}s")
+
+            return schematic_data
+
+        except Exception as e:
+            logger.error(f"Failed to load schematic {file_path}: {e}")
+            raise ValidationError(f"Invalid schematic file: {e}") from e
+
+    def save_schematic(
+        self,
+        schematic_data: Dict[str, Any],
+        file_path: Union[str, Path],
+        preserve_format: bool = True,
+    ) -> None:
+        """
+        Save schematic data to file.
+
+        Args:
+            schematic_data: Schematic data to save
+            file_path: Target file path
+            preserve_format: Whether to preserve exact formatting
+
+        Raises:
+            PermissionError: If file cannot be written
+            ValidationError: If data is invalid
+        """
+        start_time = time.time()
+        file_path = Path(file_path)
+
+        logger.info(f"Saving schematic: {file_path}")
+
+        try:
+            # Ensure parent directory exists
+            file_path.parent.mkdir(parents=True, exist_ok=True)
+
+            # Convert to S-expression format and save
+            sexp_data = self._parser._schematic_data_to_sexp(schematic_data)
+            formatted_content = self._formatter.format(sexp_data)
+
+            with open(file_path, "w", encoding="utf-8") as f:
+                f.write(formatted_content)
+
+            save_time = time.time() - start_time
+            logger.info(f"Saved schematic in {save_time:.3f}s")
+
+        except PermissionError as e:
+            logger.error(f"Permission denied saving to {file_path}: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Failed to save schematic to {file_path}: {e}")
+            raise ValidationError(f"Save failed: {e}") from e
+
+    def create_backup(self, file_path: Union[str, Path], suffix: str = ".backup") -> Path:
+        """
+        Create a backup copy of the schematic file.
+
+        Args:
+            file_path: Source file to backup
+            suffix: Backup file suffix
+
+        Returns:
+            Path to backup file
+
+        Raises:
+            FileNotFoundError: If source file doesn't exist
+            PermissionError: If backup cannot be created
+        """
+        file_path = Path(file_path)
+
+        if not file_path.exists():
+            raise FileNotFoundError(f"Cannot backup non-existent file: {file_path}")
+
+        # Create backup with timestamp if suffix doesn't include one
+        if suffix == ".backup":
+            timestamp = time.strftime("%Y%m%d_%H%M%S")
+            backup_path = file_path.with_suffix(f".{timestamp}.backup")
+        else:
+            backup_path = file_path.with_suffix(f"{file_path.suffix}{suffix}")
+
+        try:
+            # Copy file content
+            backup_path.write_bytes(file_path.read_bytes())
+            logger.info(f"Created backup: {backup_path}")
+            return backup_path
+
+        except Exception as e:
+            logger.error(f"Failed to create backup {backup_path}: {e}")
+            raise PermissionError(f"Backup failed: {e}") from e
+
+    def validate_file_path(self, file_path: Union[str, Path]) -> Path:
+        """
+        Validate and normalize a file path for schematic operations.
+
+        Args:
+            file_path: Path to validate
+
+        Returns:
+            Normalized Path object
+
+        Raises:
+            ValidationError: If path is invalid
+        """
+        file_path = Path(file_path)
+
+        # Ensure .kicad_sch extension
+        if not file_path.suffix:
+            file_path = file_path.with_suffix(".kicad_sch")
+        elif file_path.suffix != ".kicad_sch":
+            raise ValidationError(f"Invalid schematic file extension: {file_path.suffix}")
+
+        # Validate path characters
+        try:
+            file_path.resolve()
+        except (OSError, ValueError) as e:
+            raise ValidationError(f"Invalid file path: {e}") from e
+
+        return file_path
+
+    def get_file_info(self, file_path: Union[str, Path]) -> Dict[str, Any]:
+        """
+        Get file system information about a schematic file.
+
+        Args:
+            file_path: Path to analyze
+
+        Returns:
+            Dictionary with file information
+
+        Raises:
+            FileNotFoundError: If file doesn't exist
+        """
+        file_path = Path(file_path)
+
+        if not file_path.exists():
+            raise FileNotFoundError(f"File not found: {file_path}")
+
+        stat = file_path.stat()
+
+        return {
+            "path": str(file_path.resolve()),
+            "size": stat.st_size,
+            "modified": stat.st_mtime,
+            "created": getattr(stat, "st_birthtime", stat.st_ctime),
+            "readable": file_path.is_file() and file_path.exists(),
+            "writable": file_path.parent.exists() and file_path.parent.is_dir(),
+            "extension": file_path.suffix,
+        }
+
+    def create_empty_schematic_data(self) -> Dict[str, Any]:
+        """
+        Create empty schematic data structure.
+
+        Returns:
+            Empty schematic data dictionary
+        """
+        return {
+            "kicad_sch": {
+                "version": 20230819,
+                "generator": config.file_format.generator_default,
+                "uuid": None,  # Will be set by calling code
+                "paper": config.paper.default,
+                "lib_symbols": {},
+                "symbol": [],
+                "wire": [],
+                "junction": [],
+                "label": [],
+                "hierarchical_label": [],
+                "global_label": [],
+                "text": [],
+                "text_box": [],
+                "polyline": [],
+                "rectangle": [],
+                "circle": [],
+                "arc": [],
+                "image": [],
+                "sheet": [],
+                "sheet_instances": [],
+                "symbol_instances": [],
+            }
+        }