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

kicad_sch_api/__init__.py

@@ -42,7 +42,7 @@ Advanced Usage:
         print(f"Found {len(issues)} validation issues")
 """
 
-__version__ = "0.4.0"
+__version__ = "0.4.3"
 __author__ = "Circuit-Synth"
 __email__ = "info@circuit-synth.com"
 

kicad_sch_api/core/components.py

@@ -448,11 +448,25 @@ class ComponentCollection(BaseCollection[Component]):
         Remove component by reference.
 
         Args:
-            reference: Component reference to remove
+            reference: Component reference to remove (e.g., "R1")
 
         Returns:
-            True if component was removed
+            True if component was removed, False if not found
+
+        Raises:
+            TypeError: If reference is not a string
+
+        Examples:
+            sch.components.remove("R1")
+            sch.components.remove("C2")
+
+        Note:
+            For removing by UUID or component object, use remove_by_uuid() or remove_component()
+            respectively. This maintains a clear, simple API contract.
         """
+        if not isinstance(reference, str):
+            raise TypeError(f"reference must be a string, not {type(reference).__name__}")
+
         component = self._reference_index.get(reference)
         if not component:
             return False
@@ -466,6 +480,70 @@ class ComponentCollection(BaseCollection[Component]):
         logger.info(f"Removed component: {reference}")
         return True
 
+    def remove_by_uuid(self, component_uuid: str) -> bool:
+        """
+        Remove component by UUID.
+
+        Args:
+            component_uuid: Component UUID to remove
+
+        Returns:
+            True if component was removed, False if not found
+
+        Raises:
+            TypeError: If UUID is not a string
+        """
+        if not isinstance(component_uuid, str):
+            raise TypeError(f"component_uuid must be a string, not {type(component_uuid).__name__}")
+
+        if component_uuid not in self._uuid_index:
+            return False
+
+        component = self._items[self._uuid_index[component_uuid]]
+
+        # Remove from component-specific indexes
+        self._remove_from_indexes(component)
+
+        # Remove from base collection
+        super().remove(component_uuid)
+
+        logger.info(f"Removed component by UUID: {component_uuid}")
+        return True
+
+    def remove_component(self, component: "Component") -> bool:
+        """
+        Remove component by component object.
+
+        Args:
+            component: Component object to remove
+
+        Returns:
+            True if component was removed, False if not found
+
+        Raises:
+            TypeError: If component is not a Component instance
+
+        Examples:
+            comp = sch.components.get("R1")
+            sch.components.remove_component(comp)
+        """
+        if not isinstance(component, Component):
+            raise TypeError(
+                f"component must be a Component instance, not {type(component).__name__}"
+            )
+
+        if component.uuid not in self._uuid_index:
+            return False
+
+        # Remove from component-specific indexes
+        self._remove_from_indexes(component)
+
+        # Remove from base collection
+        super().remove(component.uuid)
+
+        logger.info(f"Removed component: {component.reference}")
+        return True
+
     def get(self, reference: str) -> Optional[Component]:
         """Get component by reference."""
         return self._reference_index.get(reference)

kicad_sch_api/core/factories/element_factory.py

@@ -126,7 +126,7 @@ class ElementFactory:
             uuid=label_dict.get("uuid", str(uuid.uuid4())),
             position=pos,
             text=label_dict.get("text", ""),
-            label_type=LabelType(label_dict.get("label_type", "local")),
+            label_type=LabelType(label_dict.get("label_type", "label")),
             rotation=label_dict.get("rotation", 0.0),
             size=label_dict.get("size", 1.27),
             shape=(

kicad_sch_api/core/formatter.py

@@ -125,6 +125,10 @@ class ExactFormatter:
         self.rules["global_label"] = FormatRule(inline=False, quote_indices={1})
         self.rules["hierarchical_label"] = FormatRule(inline=False, quote_indices={1})
 
+        # Text elements
+        self.rules["text"] = FormatRule(inline=False, quote_indices={1})
+        self.rules["text_box"] = FormatRule(inline=False, quote_indices={1})
+
         # Effects and text formatting
         self.rules["effects"] = FormatRule(inline=False)
         self.rules["font"] = FormatRule(inline=False)
@@ -279,6 +283,8 @@ class ExactFormatter:
             "junction",
             "label",
             "hierarchical_label",
+            "text",
+            "text_box",
             "polyline",
             "rectangle",
         ):
@@ -384,7 +390,8 @@ class ExactFormatter:
                 result += f"\n{next_indent}{self._format_element(element, indent_level + 1)}"
             else:
                 if i in rule.quote_indices and isinstance(element, str):
-                    result += f' "{element}"'
+                    escaped_element = self._escape_string(element)
+                    result += f' "{escaped_element}"'
                 else:
                     result += f" {self._format_element(element, 0)}"
 
@@ -396,7 +403,8 @@ class ExactFormatter:
         indent = "\t" * indent_level
         next_indent = "\t" * (indent_level + 1)
 
-        result = f"({lst[0]}"
+        tag = str(lst[0])
+        result = f"({tag}"
 
         for i, element in enumerate(lst[1:], 1):
             if isinstance(element, list):
@@ -425,9 +433,18 @@ class ExactFormatter:
         return True
 
     def _escape_string(self, text: str) -> str:
-        """Escape quotes in string for S-expression formatting."""
-        # Replace double quotes with escaped quotes
-        return text.replace('"', '\\"')
+        """Escape special characters in string for S-expression formatting."""
+        # Escape backslashes first (must be done before other replacements)
+        text = text.replace('\\', '\\\\')
+        # Escape double quotes
+        text = text.replace('"', '\\"')
+        # Escape newlines (convert actual newlines to escaped representation)
+        text = text.replace('\n', '\\n')
+        # Escape carriage returns
+        text = text.replace('\r', '\\r')
+        # Escape tabs
+        text = text.replace('\t', '\\t')
+        return text
 
     def _needs_quoting(self, text: str) -> bool:
         """Check if string needs to be quoted."""

kicad_sch_api/core/parsing_utils.py

@@ -0,0 +1,63 @@
+"""
+Utility functions for parsing S-expression data.
+
+This module contains helper functions used by various parsers
+to handle common parsing patterns safely and consistently.
+"""
+
+import logging
+from typing import Any
+
+import sexpdata
+
+logger = logging.getLogger(__name__)
+
+
+def parse_bool_property(value: Any, default: bool = True) -> bool:
+    """
+    Parse a boolean property from S-expression data.
+
+    Handles both sexpdata.Symbol and string types, converting yes/no to bool.
+    This is the canonical way to parse boolean properties from KiCad files.
+
+    Args:
+        value: Value from S-expression (Symbol, str, bool, or None)
+        default: Default value if parsing fails or value is None
+
+    Returns:
+        bool: Parsed boolean value
+
+    Examples:
+        >>> parse_bool_property(sexpdata.Symbol('yes'))
+        True
+        >>> parse_bool_property('no')
+        False
+        >>> parse_bool_property(None, default=False)
+        False
+        >>> parse_bool_property('YES')  # Case insensitive
+        True
+
+    Note:
+        This function was added to fix a critical bug where Symbol('yes') == 'yes'
+        returned False, causing properties like in_bom and on_board to be parsed
+        incorrectly.
+    """
+    # If value is None, use default
+    if value is None:
+        return default
+
+    # Convert Symbol to string
+    if isinstance(value, sexpdata.Symbol):
+        value = str(value)
+
+    # Handle string values (case-insensitive)
+    if isinstance(value, str):
+        return value.lower() == "yes"
+
+    # Handle boolean values directly
+    if isinstance(value, bool):
+        return value
+
+    # Unexpected type - use default
+    logger.warning(f"Unexpected type for boolean property: {type(value)}, using default={default}")
+    return default

kicad_sch_api/parsers/elements/symbol_parser.py

@@ -10,6 +10,7 @@ from typing import Any, Dict, List, Optional
 
 import sexpdata
 
+from ...core.parsing_utils import parse_bool_property
 from ...core.types import Point
 from ..base import BaseElementParser
 
@@ -74,9 +75,15 @@ class SymbolParser(BaseElementParser):
                                 prop_value = str(prop_value).replace('\\"', '"')
                             symbol_data["properties"][prop_name] = prop_value
                 elif element_type == "in_bom":
-                    symbol_data["in_bom"] = sub_item[1] == "yes" if len(sub_item) > 1 else True
+                    symbol_data["in_bom"] = parse_bool_property(
+                        sub_item[1] if len(sub_item) > 1 else None,
+                        default=True
+                    )
                 elif element_type == "on_board":
-                    symbol_data["on_board"] = sub_item[1] == "yes" if len(sub_item) > 1 else True
+                    symbol_data["on_board"] = parse_bool_property(
+                        sub_item[1] if len(sub_item) > 1 else None,
+                        default=True
+                    )
 
             return symbol_data
 

{kicad_sch_api-0.4.1.dist-info → kicad_sch_api-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kicad-sch-api
-Version: 0.4.1
+Version: 0.4.3
 Summary: Professional KiCAD schematic manipulation library with exact format preservation
 Author-email: Circuit-Synth <shane@circuit-synth.com>
 Maintainer-email: Circuit-Synth <shane@circuit-synth.com>

{kicad_sch_api-0.4.1.dist-info → kicad_sch_api-0.4.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-kicad_sch_api/__init__.py,sha256=ofPkntVvSdgUnaguvhz6tMh556LfEnwxORpq3xPbj38,2919
+kicad_sch_api/__init__.py,sha256=RqnJXbVVuA10zIozkuqnqv42nWBF-opcjChSAPne6nw,2919
 kicad_sch_api/cli.py,sha256=ZzmwzfHEvPgGfCiQBU4G2LBAyRtMNiBRoY21pivJSYc,7621
 kicad_sch_api/py.typed,sha256=e4ldqxwpY7pNDG1olbvj4HSKr8sZ9vxgA_2ek8xXn-Q,70
 kicad_sch_api/cli/__init__.py,sha256=mflSYoGLMJw2EFEByw9GD79pgj_Hebi6htJy7cKV5qM,952
@@ -16,9 +16,9 @@ kicad_sch_api/collections/labels.py,sha256=zg6_xe4ifwIbc8M1E5MDGTh8Ps57oBeqbS9Mc
 kicad_sch_api/collections/wires.py,sha256=o2Y_KIwOmFMytdOc2MjgnoUrK4Woj7wR9ROj4uRTuY0,12394
 kicad_sch_api/core/__init__.py,sha256=ur_KeYBlGKl-e1hLpLdxAhGV2A-PCCGkcqd0r6KSeBA,566
 kicad_sch_api/core/component_bounds.py,sha256=Qc-Fazq_RvASVZ57eGg99NahCIgnWq8FFg1J4HfggK0,17917
-kicad_sch_api/core/components.py,sha256=LUSIxpb8t2LD3bzpObxDguRkFz8VKQqdR53oDZiX8lg,26052
+kicad_sch_api/core/components.py,sha256=powrqJGgqUBvMevMwhWSobrK6n8W525H7vzpPYCUXTs,28448
 kicad_sch_api/core/config.py,sha256=ECR6WLrC8i0itxRLJAZN3TDthbtOfd5NwNbiU6TSlW4,6224
-kicad_sch_api/core/formatter.py,sha256=RGN1Y1Ne5uBhKU4XRINVBb0ph6pm5Khycdv352r3cDw,22207
+kicad_sch_api/core/formatter.py,sha256=ci-URhZFVHdSV4rEfOgTGtJu1tvW5MZEzSI1j2vtexE,22910
 kicad_sch_api/core/geometry.py,sha256=27SgN0padLbQuTi8MV6UUCp6Pyaiv8V9gmYDOhfwny8,2947
 kicad_sch_api/core/ic_manager.py,sha256=Kg0HIOMU-TGXiIkrnwcHFQ1Kfv_3rW2U1cwBKJsKopc,7219
 kicad_sch_api/core/junctions.py,sha256=HdEdaqF5zzFIWuRhJ2HJnVqPah4KJGNmeNv2KzgmFZQ,4757
@@ -26,6 +26,7 @@ kicad_sch_api/core/labels.py,sha256=roiwUrF-YWBOUMD-s2_eyL7x2efOhOde6WWoxI1b5JM,
 kicad_sch_api/core/nets.py,sha256=N1n6U7G7eXKRrc-osV48ReA6mOOLwn4TCwcNp2ISkNQ,9773
 kicad_sch_api/core/no_connects.py,sha256=6HCXzdVO124AdUUsQbCv9Y0f7KWmObkQ4OZLimYgET8,8548
 kicad_sch_api/core/parser.py,sha256=uvFVdSVzv5-RZmD_OKnqm51DIatFfsKF7NzLcWx4gfg,28761
+kicad_sch_api/core/parsing_utils.py,sha256=tqQpuiNePNRx6Izsp9pnCBtlgiEYfMPkVFjkE5Uuofg,1776
 kicad_sch_api/core/pin_utils.py,sha256=XGEow3HzBTyT8a0B_ZC8foMvwzYaENSaqTUwDW1rz24,5417
 kicad_sch_api/core/schematic.py,sha256=W3URcKzjUrsTy3MfDejGuhuLmV2WM2YmFnGTihzGgt0,56489
 kicad_sch_api/core/texts.py,sha256=kBwUxwftqncl-yauiJjdnLXauV6EWq2oLhKw2bAxD_c,9990
@@ -34,7 +35,7 @@ kicad_sch_api/core/wires.py,sha256=lLqcpRodErD4fD4_VMB1HgC9ViPnYPGcT8b-N9S0q-g,7
 kicad_sch_api/core/collections/__init__.py,sha256=i75_p9v330S2hxi4LrAGLmcVjrF8O0nTlGjCCjNbkq0,118
 kicad_sch_api/core/collections/base.py,sha256=H-g1SC7hKD5QvbXPKVQotCK2e5pn04-y1ipkBQGcy3I,7076
 kicad_sch_api/core/factories/__init__.py,sha256=qFx_rAgcTgWRZ572hvzzKNAze-jE0BOLqLrSFzj7T6M,130
-kicad_sch_api/core/factories/element_factory.py,sha256=VbyBlEuIkVGkKf4soVIT8XUlq-T0-SJ_8w38JBfUH_k,8059
+kicad_sch_api/core/factories/element_factory.py,sha256=zUmV1dnMXJl3fxXHdU9OJhqsHf_0D_DBOzWRLFYdG0c,8059
 kicad_sch_api/core/managers/__init__.py,sha256=Ec9H9RSBFt2MeJIhnZFUN9sa2ql0BSrO8FNOa1XsXeU,731
 kicad_sch_api/core/managers/file_io.py,sha256=k7yAfOvS5SqHrn1bCOH_wmOqDQnQe25wvhSPDmI8Cjk,7670
 kicad_sch_api/core/managers/format_sync.py,sha256=ar0FfhwXrU2l5ATV0aW5KtVRfIM2iM1WoyGvXQh-ShY,16963
@@ -65,7 +66,7 @@ kicad_sch_api/parsers/elements/label_parser.py,sha256=KL_AV_-BhA_KV1FLlqNpMj1Nu-
 kicad_sch_api/parsers/elements/library_parser.py,sha256=qHQMI3PatLgHtUWvWhQxbKC-NXJqgOVW33hVkMQ9sEU,6321
 kicad_sch_api/parsers/elements/metadata_parser.py,sha256=IFpgk5eLqp1kcjhpZB-jPThBCVyvdgsLo4YRydlvYD4,1897
 kicad_sch_api/parsers/elements/sheet_parser.py,sha256=xZld-yzW7r1FKABaK89K7U-Zenqz2cHUqtMnADhxCeQ,14246
-kicad_sch_api/parsers/elements/symbol_parser.py,sha256=nIKCZ67CLFHo6m62Xw2rLcOtjGLpyq0LhBdd0fPDiiY,12187
+kicad_sch_api/parsers/elements/symbol_parser.py,sha256=G_N1kbTY2kCBG08gBHuXtmsFcw_dWMzwmVxOaO7F3Gw,12433
 kicad_sch_api/parsers/elements/text_parser.py,sha256=n5G_3czchmPCEdvTVoQsATTW1PQW7KcSjzglqzPlOKQ,9820
 kicad_sch_api/parsers/elements/wire_parser.py,sha256=geWI3jMXM7lZF26k7n7c6RQ55x4gsO4j8Ou0fk0O2j8,8271
 kicad_sch_api/symbols/__init__.py,sha256=NfakJ5-8AQxq5vi8nZVuaUtDpWHfwHm5AD4rC-p9BZI,501
@@ -79,9 +80,9 @@ kicad_sch_api/validation/erc.py,sha256=6WMHyMakKpn1-jXkfO9ltayLRA0OaU1N7GQm-pbZT
 kicad_sch_api/validation/erc_models.py,sha256=wFYMH-cbcdRX1j9LPn28IGUYBLioPDr4lP0m2QuhAnI,6628
 kicad_sch_api/validation/pin_matrix.py,sha256=AdBCvEmOByXACOUoskYxYMcwKvIasxrtJOqWM-WgVi0,7456
 kicad_sch_api/validation/validators.py,sha256=3txkQpR3qAUzp0-m-FnDYf3-_GGj6iaGZj4kSYu-Fe4,13166
-kicad_sch_api-0.4.1.dist-info/licenses/LICENSE,sha256=Em65Nvte1G9MHc0rHqtYuGkCPcshD588itTa358J6gs,1070
-kicad_sch_api-0.4.1.dist-info/METADATA,sha256=y4meDeK6RX_G6PCcQ7pIBw-pgKZv2NzG8kvMGsEusQw,17953
-kicad_sch_api-0.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kicad_sch_api-0.4.1.dist-info/entry_points.txt,sha256=VWKsFi2Jv7G_tmio3cNVhhIBfv_OZFaKa-T_ED84lc8,57
-kicad_sch_api-0.4.1.dist-info/top_level.txt,sha256=n0ex4gOJ1b_fARowcGqRzyOGZcHRhc5LZa6_vVgGxcI,14
-kicad_sch_api-0.4.1.dist-info/RECORD,,
+kicad_sch_api-0.4.3.dist-info/licenses/LICENSE,sha256=Em65Nvte1G9MHc0rHqtYuGkCPcshD588itTa358J6gs,1070
+kicad_sch_api-0.4.3.dist-info/METADATA,sha256=W-b-H9K_70U5sUjAQgu0nbocWOElYs8mHIH1I_omOiw,17953
+kicad_sch_api-0.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kicad_sch_api-0.4.3.dist-info/entry_points.txt,sha256=VWKsFi2Jv7G_tmio3cNVhhIBfv_OZFaKa-T_ED84lc8,57
+kicad_sch_api-0.4.3.dist-info/top_level.txt,sha256=n0ex4gOJ1b_fARowcGqRzyOGZcHRhc5LZa6_vVgGxcI,14
+kicad_sch_api-0.4.3.dist-info/RECORD,,