Merge pull request #87 from tnemrap/fix/create-schematic-path

fix: create_schematic now respects the path parameter
This commit is contained in:
Tom
2026-04-18 14:33:58 +02:00
committed by GitHub
3 changed files with 97 additions and 4 deletions

View File

@@ -13,7 +13,7 @@ class SchematicManager:
"""Core schematic operations using kicad-skip"""
@staticmethod
def create_schematic(name: str, metadata: Optional[Any] = None) -> Any:
def create_schematic(name: str, metadata: Optional[Any] = None, *, path: Optional[str] = None) -> Any:
"""Create a new empty schematic from template"""
try:
# Determine template path (use template_with_symbols for component cloning support)
@@ -25,7 +25,8 @@ class SchematicManager:
)
# Determine output path
output_path = name if name.endswith(".kicad_sch") else f"{name}.kicad_sch"
base_name = name if name.endswith(".kicad_sch") else f"{name}.kicad_sch"
output_path = os.path.join(path, base_name) if path else base_name
if os.path.exists(template_path):
# Copy template to target location

View File

@@ -622,8 +622,11 @@ class KiCADInterface:
"message": "Schematic name is required. Provide 'name', 'projectName', or 'filename' parameter.",
}
schematic = SchematicManager.create_schematic(project_name, metadata)
file_path = f"{path}/{project_name}.kicad_sch"
sch_path = path if path and path != "." else None
schematic = SchematicManager.create_schematic(project_name, path=sch_path, metadata=metadata)
base_name = project_name if project_name.endswith(".kicad_sch") else f"{project_name}.kicad_sch"
normalized_path = path or "."
file_path = os.path.join(normalized_path, base_name)
success = SchematicManager.save_schematic(schematic, file_path)
return {"success": success, "file_path": file_path}

View File

@@ -0,0 +1,89 @@
"""
Unit tests for create_schematic path parameter bug fix.
Verifies that create_schematic respects the `path` argument and writes
the schematic file to the correct directory instead of the process cwd.
"""
import os
import sys
import importlib.util
import tempfile
from unittest.mock import patch, MagicMock
# pcbnew and skip are only available inside KiCAD — stub them so the
# schematic module can be imported in a plain Python environment.
sys.modules.setdefault("pcbnew", MagicMock())
sys.modules.setdefault("skip", MagicMock())
# Import the module directly (bypasses python/commands/__init__.py which
# would otherwise pull in board/component commands that also need pcbnew).
_spec = importlib.util.spec_from_file_location(
"schematic_module",
os.path.join(os.path.dirname(__file__), "..", "python", "commands", "schematic.py"),
)
_mod = importlib.util.module_from_spec(_spec)
_spec.loader.exec_module(_mod)
SchematicManager = _mod.SchematicManager
_OPEN_MOCK = MagicMock(return_value=MagicMock(
__enter__=MagicMock(return_value=MagicMock(
read=MagicMock(return_value="(uuid 00000000-0000-0000-0000-000000000000)")
)),
__exit__=MagicMock(return_value=False),
))
def test_create_schematic_uses_path_argument():
"""
create_schematic should write the .kicad_sch file inside `path`
when that argument is provided, not in the process working directory.
"""
with tempfile.TemporaryDirectory() as tmpdir:
with patch.object(_mod, "Schematic") as mock_sch_cls, \
patch("shutil.copy"), \
patch("os.path.exists", return_value=True), \
patch("builtins.open", _OPEN_MOCK):
mock_sch_cls.return_value = MagicMock()
SchematicManager.create_schematic("myschematic", path=tmpdir)
used_path = mock_sch_cls.call_args[0][0]
assert used_path.startswith(tmpdir), (
f"Expected path inside {tmpdir!r}, got {used_path!r}"
)
assert used_path.endswith("myschematic.kicad_sch")
def test_create_schematic_without_path_uses_relative():
"""
When no path is given, behaviour is unchanged — file goes to cwd-relative name.
"""
with patch.object(_mod, "Schematic") as mock_sch_cls, \
patch("shutil.copy"), \
patch("os.path.exists", return_value=True), \
patch("builtins.open", _OPEN_MOCK):
mock_sch_cls.return_value = MagicMock()
SchematicManager.create_schematic("myschematic")
used_path = mock_sch_cls.call_args[0][0]
assert used_path == "myschematic.kicad_sch"
def test_create_schematic_accepts_full_sch_filename():
"""
If name already ends with .kicad_sch, it should not double the suffix.
"""
with tempfile.TemporaryDirectory() as tmpdir:
with patch.object(_mod, "Schematic") as mock_sch_cls, \
patch("shutil.copy"), \
patch("os.path.exists", return_value=True), \
patch("builtins.open", _OPEN_MOCK):
mock_sch_cls.return_value = MagicMock()
SchematicManager.create_schematic("myschematic.kicad_sch", path=tmpdir)
used_path = mock_sch_cls.call_args[0][0]
assert used_path.endswith("myschematic.kicad_sch")
assert "myschematic.kicad_sch.kicad_sch" not in used_path