kicad-sch-api 0.3.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

kicad_sch_api/cli/netlist.py

@@ -0,0 +1,94 @@
+"""Netlist export functionality using kicad-cli."""
+
+from pathlib import Path
+from typing import Optional
+
+from kicad_sch_api.cli.base import KiCadExecutor
+from kicad_sch_api.cli.types import NetlistFormat
+
+
+def export_netlist(
+    schematic_path: Path,
+    output_path: Optional[Path] = None,
+    format: NetlistFormat = "kicadsexpr",
+    executor: Optional[KiCadExecutor] = None,
+) -> Path:
+    """
+    Export netlist from schematic using kicad-cli.
+
+    Supports 8 different netlist formats for PCB layout and simulation.
+
+    Args:
+        schematic_path: Path to .kicad_sch file
+        output_path: Output netlist path (auto-generated if None)
+        format: Netlist format (see NetlistFormat for options)
+        executor: Custom KiCadExecutor instance (creates default if None)
+
+    Returns:
+        Path to generated netlist file
+
+    Raises:
+        RuntimeError: If kicad-cli not found or netlist generation fails
+        FileNotFoundError: If schematic file doesn't exist
+
+    Example:
+        >>> from pathlib import Path
+        >>> netlist = export_netlist(
+        ...     Path('circuit.kicad_sch'),
+        ...     format='spice'
+        ... )
+        >>> print(f"Netlist: {netlist}")
+
+    Supported formats:
+        - kicadsexpr: KiCad S-expression netlist (default)
+        - kicadxml: KiCad XML netlist
+        - cadstar: Cadstar format
+        - orcadpcb2: OrCAD PCB2 format
+        - spice: SPICE netlist
+        - spicemodel: SPICE with models
+        - pads: PADS format
+        - allegro: Allegro format
+    """
+    schematic_path = Path(schematic_path)
+
+    if not schematic_path.exists():
+        raise FileNotFoundError(f"Schematic not found: {schematic_path}")
+
+    # Auto-generate output path if not provided
+    if output_path is None:
+        ext = _get_extension_for_format(format)
+        output_path = schematic_path.with_suffix(ext)
+    else:
+        output_path = Path(output_path)
+
+    # Create executor if not provided
+    if executor is None:
+        executor = KiCadExecutor()
+
+    # Build command
+    args = [
+        "sch", "export", "netlist",
+        "--format", format,
+        "--output", str(output_path),
+        str(schematic_path),
+    ]
+
+    # Execute command
+    executor.run(args, cwd=schematic_path.parent)
+
+    return output_path
+
+
+def _get_extension_for_format(format: NetlistFormat) -> str:
+    """Get file extension for netlist format."""
+    extensions = {
+        "kicadsexpr": ".net",
+        "kicadxml": ".xml",
+        "cadstar": ".frp",
+        "orcadpcb2": ".net",
+        "spice": ".cir",
+        "spicemodel": ".cir",
+        "pads": ".asc",
+        "allegro": ".alg",
+    }
+    return extensions.get(format, ".net")

kicad_sch_api/cli/types.py

@@ -0,0 +1,43 @@
+"""Type definitions for KiCad CLI operations."""
+
+from typing import Literal
+
+# Netlist export formats
+NetlistFormat = Literal[
+    "kicadsexpr",  # KiCad S-expression netlist (default)
+    "kicadxml",    # KiCad XML netlist
+    "cadstar",     # Cadstar format
+    "orcadpcb2",   # OrCAD PCB2 format
+    "spice",       # SPICE netlist
+    "spicemodel",  # SPICE with models
+    "pads",        # PADS format
+    "allegro",     # Allegro format
+]
+
+# ERC (Electrical Rule Check) formats
+ErcFormat = Literal[
+    "json",    # JSON format (machine-readable)
+    "report",  # Human-readable text report
+]
+
+# ERC severity levels
+ErcSeverity = Literal[
+    "all",         # Report all violations
+    "error",       # Error level only
+    "warning",     # Warning level only
+    "exclusions",  # Excluded violations only
+]
+
+# Units for measurements
+Units = Literal[
+    "mm",    # Millimeters (default)
+    "in",    # Inches
+    "mils",  # Mils (1/1000 inch)
+]
+
+# Execution modes
+ExecutionMode = Literal[
+    "auto",   # Auto-detect (try local, fall back to Docker)
+    "local",  # Force local kicad-cli
+    "docker", # Force Docker mode
+]

kicad_sch_api/collections/__init__.py

@@ -0,0 +1,36 @@
+"""
+Modern collection architecture for KiCAD schematic elements.
+
+This module provides a unified collection framework with:
+- Centralized index management via IndexRegistry
+- Lazy index rebuilding for performance
+- Configurable validation levels
+- Auto-tracking property dictionaries
+- Batch mode for bulk operations
+"""
+
+from .base import (
+    BaseCollection,
+    IndexSpec,
+    IndexRegistry,
+    PropertyDict,
+    ValidationLevel,
+)
+from .components import Component, ComponentCollection
+from .junctions import JunctionCollection
+from .labels import LabelCollection, LabelElement
+from .wires import WireCollection
+
+__all__ = [
+    "BaseCollection",
+    "IndexSpec",
+    "IndexRegistry",
+    "PropertyDict",
+    "ValidationLevel",
+    "Component",
+    "ComponentCollection",
+    "JunctionCollection",
+    "LabelCollection",
+    "LabelElement",
+    "WireCollection",
+]