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

kicad_sch_api/core/texts.py

@@ -0,0 +1,343 @@
+"""
+Text element management for KiCAD schematics.
+
+This module provides collection classes for managing text elements,
+featuring fast lookup, bulk operations, and validation.
+"""
+
+import logging
+import uuid
+from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Union
+
+from ..utils.validation import SchematicValidator, ValidationError, ValidationIssue
+from .types import Point, Text
+
+logger = logging.getLogger(__name__)
+
+
+class TextElement:
+    """
+    Enhanced wrapper for schematic text elements with modern API.
+
+    Provides intuitive access to text properties and operations
+    while maintaining exact format preservation.
+    """
+
+    def __init__(self, text_data: Text, parent_collection: "TextCollection"):
+        """
+        Initialize text element wrapper.
+
+        Args:
+            text_data: Underlying text data
+            parent_collection: Parent collection for updates
+        """
+        self._data = text_data
+        self._collection = parent_collection
+        self._validator = SchematicValidator()
+
+    # Core properties with validation
+    @property
+    def uuid(self) -> str:
+        """Text element UUID."""
+        return self._data.uuid
+
+    @property
+    def text(self) -> str:
+        """Text content."""
+        return self._data.text
+
+    @text.setter
+    def text(self, value: str):
+        """Set text content with validation."""
+        if not isinstance(value, str):
+            raise ValidationError(f"Text content must be string, got {type(value)}")
+        self._data.text = value
+        self._collection._mark_modified()
+
+    @property
+    def position(self) -> Point:
+        """Text position."""
+        return self._data.position
+
+    @position.setter
+    def position(self, value: Union[Point, Tuple[float, float]]):
+        """Set text position."""
+        if isinstance(value, tuple):
+            value = Point(value[0], value[1])
+        elif not isinstance(value, Point):
+            raise ValidationError(f"Position must be Point or tuple, got {type(value)}")
+        self._data.position = value
+        self._collection._mark_modified()
+
+    @property
+    def rotation(self) -> float:
+        """Text rotation in degrees."""
+        return self._data.rotation
+
+    @rotation.setter
+    def rotation(self, value: float):
+        """Set text rotation."""
+        self._data.rotation = float(value)
+        self._collection._mark_modified()
+
+    @property
+    def size(self) -> float:
+        """Text size."""
+        return self._data.size
+
+    @size.setter
+    def size(self, value: float):
+        """Set text size with validation."""
+        if value <= 0:
+            raise ValidationError(f"Text size must be positive, got {value}")
+        self._data.size = float(value)
+        self._collection._mark_modified()
+
+    @property
+    def exclude_from_sim(self) -> bool:
+        """Whether text is excluded from simulation."""
+        return self._data.exclude_from_sim
+
+    @exclude_from_sim.setter
+    def exclude_from_sim(self, value: bool):
+        """Set exclude from simulation flag."""
+        self._data.exclude_from_sim = bool(value)
+        self._collection._mark_modified()
+
+    def validate(self) -> List[ValidationIssue]:
+        """Validate this text element."""
+        return self._validator.validate_text(self._data.__dict__)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert text element to dictionary representation."""
+        return {
+            "uuid": self.uuid,
+            "text": self.text,
+            "position": {"x": self.position.x, "y": self.position.y},
+            "rotation": self.rotation,
+            "size": self.size,
+            "exclude_from_sim": self.exclude_from_sim,
+        }
+
+    def __str__(self) -> str:
+        """String representation."""
+        return f"<Text '{self.text}' @ {self.position}>"
+
+
+class TextCollection:
+    """
+    Collection class for efficient text element management.
+
+    Provides fast lookup, filtering, and bulk operations for schematic text elements.
+    """
+
+    def __init__(self, texts: List[Text] = None):
+        """
+        Initialize text collection.
+
+        Args:
+            texts: Initial list of text data
+        """
+        self._texts: List[TextElement] = []
+        self._uuid_index: Dict[str, TextElement] = {}
+        self._content_index: Dict[str, List[TextElement]] = {}
+        self._modified = False
+
+        # Add initial texts
+        if texts:
+            for text_data in texts:
+                self._add_to_indexes(TextElement(text_data, self))
+
+        logger.debug(f"TextCollection initialized with {len(self._texts)} texts")
+
+    def add(
+        self,
+        text: str,
+        position: Union[Point, Tuple[float, float]],
+        rotation: float = 0.0,
+        size: float = 1.27,
+        exclude_from_sim: bool = False,
+        text_uuid: Optional[str] = None,
+    ) -> TextElement:
+        """
+        Add a new text element to the schematic.
+
+        Args:
+            text: Text content
+            position: Text position
+            rotation: Text rotation in degrees
+            size: Text size
+            exclude_from_sim: Whether to exclude from simulation
+            text_uuid: Specific UUID for text (auto-generated if None)
+
+        Returns:
+            Newly created TextElement
+
+        Raises:
+            ValidationError: If text data is invalid
+        """
+        # Validate inputs
+        if not isinstance(text, str) or not text.strip():
+            raise ValidationError("Text content cannot be empty")
+
+        if isinstance(position, tuple):
+            position = Point(position[0], position[1])
+        elif not isinstance(position, Point):
+            raise ValidationError(f"Position must be Point or tuple, got {type(position)}")
+
+        if size <= 0:
+            raise ValidationError(f"Text size must be positive, got {size}")
+
+        # Generate UUID if not provided
+        if not text_uuid:
+            text_uuid = str(uuid.uuid4())
+
+        # Check for duplicate UUID
+        if text_uuid in self._uuid_index:
+            raise ValidationError(f"Text UUID {text_uuid} already exists")
+
+        # Create text data
+        text_data = Text(
+            uuid=text_uuid,
+            position=position,
+            text=text,
+            rotation=rotation,
+            size=size,
+            exclude_from_sim=exclude_from_sim,
+        )
+
+        # Create wrapper and add to collection
+        text_element = TextElement(text_data, self)
+        self._add_to_indexes(text_element)
+        self._mark_modified()
+
+        logger.debug(f"Added text: {text_element}")
+        return text_element
+
+    def get(self, text_uuid: str) -> Optional[TextElement]:
+        """Get text by UUID."""
+        return self._uuid_index.get(text_uuid)
+
+    def remove(self, text_uuid: str) -> bool:
+        """
+        Remove text by UUID.
+
+        Args:
+            text_uuid: UUID of text to remove
+
+        Returns:
+            True if text was removed, False if not found
+        """
+        text_element = self._uuid_index.get(text_uuid)
+        if not text_element:
+            return False
+
+        # Remove from indexes
+        self._remove_from_indexes(text_element)
+        self._mark_modified()
+
+        logger.debug(f"Removed text: {text_element}")
+        return True
+
+    def find_by_content(self, content: str, exact: bool = True) -> List[TextElement]:
+        """
+        Find texts by content.
+
+        Args:
+            content: Content to search for
+            exact: If True, exact match; if False, substring match
+
+        Returns:
+            List of matching text elements
+        """
+        if exact:
+            return self._content_index.get(content, []).copy()
+        else:
+            matches = []
+            for text_element in self._texts:
+                if content.lower() in text_element.text.lower():
+                    matches.append(text_element)
+            return matches
+
+    def filter(self, predicate: Callable[[TextElement], bool]) -> List[TextElement]:
+        """
+        Filter texts by predicate function.
+
+        Args:
+            predicate: Function that returns True for texts to include
+
+        Returns:
+            List of texts matching predicate
+        """
+        return [text for text in self._texts if predicate(text)]
+
+    def bulk_update(self, criteria: Callable[[TextElement], bool], updates: Dict[str, Any]):
+        """
+        Update multiple texts matching criteria.
+
+        Args:
+            criteria: Function to select texts to update
+            updates: Dictionary of property updates
+        """
+        updated_count = 0
+        for text_element in self._texts:
+            if criteria(text_element):
+                for prop, value in updates.items():
+                    if hasattr(text_element, prop):
+                        setattr(text_element, prop, value)
+                        updated_count += 1
+
+        if updated_count > 0:
+            self._mark_modified()
+            logger.debug(f"Bulk updated {updated_count} text properties")
+
+    def clear(self):
+        """Remove all texts from collection."""
+        self._texts.clear()
+        self._uuid_index.clear()
+        self._content_index.clear()
+        self._mark_modified()
+
+    def _add_to_indexes(self, text_element: TextElement):
+        """Add text to internal indexes."""
+        self._texts.append(text_element)
+        self._uuid_index[text_element.uuid] = text_element
+
+        # Add to content index
+        content = text_element.text
+        if content not in self._content_index:
+            self._content_index[content] = []
+        self._content_index[content].append(text_element)
+
+    def _remove_from_indexes(self, text_element: TextElement):
+        """Remove text from internal indexes."""
+        self._texts.remove(text_element)
+        del self._uuid_index[text_element.uuid]
+
+        # Remove from content index
+        content = text_element.text
+        if content in self._content_index:
+            self._content_index[content].remove(text_element)
+            if not self._content_index[content]:
+                del self._content_index[content]
+
+    def _mark_modified(self):
+        """Mark collection as modified."""
+        self._modified = True
+
+    # Collection interface methods
+    def __len__(self) -> int:
+        """Return number of texts."""
+        return len(self._texts)
+
+    def __iter__(self) -> Iterator[TextElement]:
+        """Iterate over texts."""
+        return iter(self._texts)
+
+    def __getitem__(self, index: int) -> TextElement:
+        """Get text by index."""
+        return self._texts[index]
+
+    def __bool__(self) -> bool:
+        """Return True if collection has texts."""
+        return len(self._texts) > 0

kicad_sch_api/core/types.py

@@ -372,6 +372,32 @@ class SchematicRectangle:
         )
 
 
+@dataclass
+class Image:
+    """Image element in schematic."""
+
+    uuid: str
+    position: Point
+    data: str  # Base64-encoded image data
+    scale: float = 1.0
+
+    def __post_init__(self):
+        if not self.uuid:
+            self.uuid = str(uuid4())
+
+
+@dataclass
+class NoConnect:
+    """No-connect symbol in schematic."""
+
+    uuid: str
+    position: Point
+
+    def __post_init__(self):
+        if not self.uuid:
+            self.uuid = str(uuid4())
+
+
 @dataclass
 class Net:
     """Electrical net connecting components."""

kicad_sch_api/geometry/__init__.py

@@ -0,0 +1,26 @@
+"""
+Geometry module for KiCad schematic symbol bounding box calculations.
+
+This module provides accurate bounding box calculations for KiCad symbols,
+including font metrics and symbol geometry analysis.
+
+Migrated from circuit-synth to kicad-sch-api for better architectural separation.
+"""
+
+from .font_metrics import (
+    DEFAULT_PIN_LENGTH,
+    DEFAULT_PIN_NAME_OFFSET,
+    DEFAULT_PIN_NUMBER_SIZE,
+    DEFAULT_PIN_TEXT_WIDTH_RATIO,
+    DEFAULT_TEXT_HEIGHT,
+)
+from .symbol_bbox import SymbolBoundingBoxCalculator
+
+__all__ = [
+    "SymbolBoundingBoxCalculator",
+    "DEFAULT_TEXT_HEIGHT",
+    "DEFAULT_PIN_LENGTH",
+    "DEFAULT_PIN_NAME_OFFSET",
+    "DEFAULT_PIN_NUMBER_SIZE",
+    "DEFAULT_PIN_TEXT_WIDTH_RATIO",
+]

kicad_sch_api/geometry/font_metrics.py

@@ -0,0 +1,20 @@
+"""
+Font metrics and text rendering constants for KiCad schematic text.
+
+These constants are used for accurate text bounding box calculations
+and symbol spacing in schematic layouts.
+"""
+
+# KiCad default text size in mm
+# Increased to better match actual KiCad rendering
+DEFAULT_TEXT_HEIGHT = 2.54  # 100 mils (doubled from 50 mils)
+
+# Default pin dimensions
+DEFAULT_PIN_LENGTH = 2.54  # 100 mils
+DEFAULT_PIN_NAME_OFFSET = 0.508  # 20 mils - offset from pin endpoint to label text
+DEFAULT_PIN_NUMBER_SIZE = 1.27  # 50 mils
+
+# Text width ratio for proportional font rendering
+# KiCad uses proportional fonts where average character width is ~0.65x height
+# This prevents label text from extending beyond calculated bounding boxes
+DEFAULT_PIN_TEXT_WIDTH_RATIO = 0.65  # Width to height ratio for pin text (proportional font average)