kfactory 2.5.2__tar.gz → 2.6.0__tar.gz

{kfactory-2.5.2 → kfactory-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kfactory
-Version: 2.5.2
+Version: 2.6.0
 Summary: KLayout API implementation of gdsfactory
 Author-email: gdsfactory community <contact@gdsfactory.com>
 Classifier: Programming Language :: Python :: 3.11
@@ -77,14 +77,14 @@ Requires-Dist: ipytree>=0.2.2; extra == "ipy"
 Requires-Dist: ipywidgets>=8.1.5; extra == "ipy"
 Dynamic: license-file
 
-# KFactory 2.5.2
+# KFactory 2.6.0
 
 [![codecov](https://codecov.io/gh/gdsfactory/kfactory/graph/badge.svg?token=dArcfnQE4w)](https://codecov.io/gh/gdsfactory/kfactory)
 
 Kfactory is the backend for [gdsfactory](https://github.com/gdsfactory/gdsfactory). It is built upon [KLayout](https://klayout.de).
 It offers basic operations like gdsfactory, so it can be used on its own as a layout tool as well.
 
-It is recommended to pin the version of KFactory in `requirements.txt` or `pyproject.toml` with `kfactory==2.5.2` for example.
+It is recommended to pin the version of KFactory in `requirements.txt` or `pyproject.toml` with `kfactory==2.6.0` for example.
 
 Features similar to gdsfactory:
 

{kfactory-2.5.2 → kfactory-2.6.0}/README.md

@@ -1,11 +1,11 @@
-# KFactory 2.5.2
+# KFactory 2.6.0
 
 [![codecov](https://codecov.io/gh/gdsfactory/kfactory/graph/badge.svg?token=dArcfnQE4w)](https://codecov.io/gh/gdsfactory/kfactory)
 
 Kfactory is the backend for [gdsfactory](https://github.com/gdsfactory/gdsfactory). It is built upon [KLayout](https://klayout.de).
 It offers basic operations like gdsfactory, so it can be used on its own as a layout tool as well.
 
-It is recommended to pin the version of KFactory in `requirements.txt` or `pyproject.toml` with `kfactory==2.5.2` for example.
+It is recommended to pin the version of KFactory in `requirements.txt` or `pyproject.toml` with `kfactory==2.6.0` for example.
 
 Features similar to gdsfactory:
 

{kfactory-2.5.2 → kfactory-2.6.0}/pyproject.toml

@@ -15,7 +15,7 @@ classifiers = [
 requires-python = ">=3.11"
 
 
-version = "2.5.2"
+version = "2.6.0"
 authors = [{ name = "gdsfactory community", email = "contact@gdsfactory.com" }]
 dependencies = [
     "aenum >= 3.1.16, < 4",
@@ -217,7 +217,7 @@ omit = ["src/kfactory/cli/**/*.py"]
 # github_url = "https://github.com/<user or organization>/<project>/"
 
 [tool.tbump.version]
-current = "2.5.2"
+current = "2.6.0"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory/__init__.py

@@ -6,7 +6,7 @@ Uses the klayout package as a backend.
 # The import order matters, we need to first import the important stuff.
 # isort:skip_file
 
-__version__ = "2.5.2"
+__version__ = "2.6.0"
 
 import klayout.db as kdb
 from klayout import lay

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory/exceptions.py

@@ -11,6 +11,7 @@ if TYPE_CHECKING:
 
 __all__ = [
     "CellNameError",
+    "DuplicateCellNameError",
     "InvalidLayerError",
     "LockedError",
     "MergeError",
@@ -139,5 +140,13 @@ class CellNameError(ValueError):
     """Raised if a KCell is created and the automatic assigned name is taken."""
 
 
+class DuplicateCellNameError(RuntimeError):
+    """Raised when writing a layout with multiple cells sharing the same name.
+
+    GDS/OASIS formats require unique cell names. This error provides details
+    about which names are duplicated and which cells are involved.
+    """
+
+
 class InvalidLayerError(ValueError):
     """Raised when a layer is not valid."""

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory/kcell.py

@@ -60,7 +60,7 @@ from .cross_section import (
     SymmetricalCrossSection,
     TCrossSection,
 )
-from .exceptions import LockedError, MergeError
+from .exceptions import DuplicateCellNameError, LockedError, MergeError
 from .geometry import DBUGeometricObject, GeometricObject, UMGeometricObject
 from .instance import DInstance, Instance, ProtoInstance, ProtoTInstance, VInstance
 from .instances import (
@@ -133,6 +133,119 @@ __all__ = [
 ]
 
 
+def _cell_detail(
+    ci: int,
+    layout: kdb.Layout,
+    tkcells: Mapping[int, TKCell] | None,
+) -> str:
+    """Build a concise description of a cell for error/warning messages."""
+    tkcell = tkcells.get(ci) if tkcells else None
+    parts = [f"cell_index={ci}"]
+
+    if tkcell is not None:
+        factory_name = tkcell.basename or tkcell.function_name
+        if factory_name:
+            parts.append(f"factory={factory_name!r}")
+            factory = tkcell.kcl.factories.get(factory_name) or (
+                tkcell.kcl.virtual_factories.get(factory_name)
+            )
+            if factory is not None:
+                lineno = getattr(
+                    getattr(factory._f_orig, "__code__", None),
+                    "co_firstlineno",
+                    None,
+                )
+                loc = str(factory.file)
+                if lineno is not None:
+                    loc += f":{lineno}"
+                parts.append(loc)
+        else:
+            c = layout.cell(ci)
+            cell_name = c.name if c is not None and not c._destroyed() else None
+            parts.append(f"no factory, name={cell_name!r}")
+
+    c = layout.cell(ci)
+    if c is not None and not c._destroyed():
+        parent_names = []
+        for parent_ci in c.caller_cells():
+            pc = layout.cell(parent_ci)
+            if pc is not None and not pc._destroyed():
+                parent_names.append(pc.name)
+        if parent_names:
+            parts.append(f"parent(s): {parent_names}")
+
+    return ", ".join(parts)
+
+
+def _check_duplicate_cell_names(
+    layout: kdb.Layout,
+    cell_indices: set[int],
+    *,
+    auto_rename: bool = False,
+    tkcells: Mapping[int, TKCell] | None = None,
+) -> None:
+    """Check for duplicate cell names before writing a layout.
+
+    GDS/OASIS require unique cell names. When duplicates are found among
+    `cell_indices`:
+
+    - If ``auto_rename`` is *False* (the default), raise
+      :class:`~kfactory.exceptions.DuplicateCellNameError`.
+    - If ``auto_rename`` is *True*, rename duplicates with ``$1``, ``$2``, …
+      suffixes (matching KLayout's own convention) and log a warning.
+    """
+    from collections import defaultdict
+
+    name_to_indices: dict[str, list[int]] = defaultdict(list)
+    for ci in cell_indices:
+        c = layout.cell(ci)
+        if c is not None and not c._destroyed():
+            name_to_indices[c.name].append(ci)
+
+    duplicates = {
+        name: indices for name, indices in name_to_indices.items() if len(indices) > 1
+    }
+    if not duplicates:
+        return
+
+    if not auto_rename:
+        lines = []
+        for name, indices in duplicates.items():
+            detail_lines = [
+                f"    - {_cell_detail(ci, layout, tkcells)}" for ci in indices
+            ]
+            lines.append(f"  {name!r}:\n" + "\n".join(detail_lines))
+        raise DuplicateCellNameError(
+            "Duplicate cell names detected — GDS/OASIS require unique cell"
+            " names.\n" + "\n".join(lines) + "\n"
+            "Pass `deduplicate_cell_names=True` to auto-rename duplicates,"
+            " or set `kf.config.debug_names = True` to catch conflicts"
+            " earlier at assignment time."
+        )
+
+    for name, indices in duplicates.items():
+        for ci in indices[1:]:
+            c = layout.cell(ci)
+            if c is None or c._destroyed():
+                continue
+            unique = layout.unique_cell_name(name)
+            was_locked = c.is_locked()
+            if was_locked:
+                c.locked = False
+            c.name = unique
+            if was_locked:
+                c.locked = True
+            detail = _cell_detail(ci, layout, tkcells)
+            logger.warning(
+                "Renamed duplicate cell {old!r} ({detail}) -> {new!r}."
+                " Set `kf.config.debug_names = True` to catch name"
+                " conflicts earlier.",
+                old=name,
+                detail=detail,
+                new=unique,
+            )
+
+
 class BaseKCell(BaseModel, ABC, arbitrary_types_allowed=True):
     """KLayout cell and change its class to KCell.
 
@@ -495,7 +608,7 @@ class TKCell(BaseKCell):
                     )
                 )
                 if config.debug_names:
-                    raise ValueError(
+                    raise DuplicateCellNameError(
                         "Name conflict in "
                         f"{frame_info.frame.f_locals['f'].__code__.co_filename}::"
                         f"{frame_info.frame.f_locals['f'].__name__} at line "
@@ -537,7 +650,7 @@ class TKCell(BaseKCell):
                         )
                     )
                     if config.debug_names:
-                        raise ValueError(
+                        raise DuplicateCellNameError(
                             "Name conflict in "
                             f"{module_name}{function_name} at line "
                             f"{frame_info.lineno}\n"
@@ -574,7 +687,7 @@ class TKCell(BaseKCell):
                         )
                     )
                     if config.debug_names:
-                        raise ValueError(
+                        raise DuplicateCellNameError(
                             "Name conflict in "
                             f"{frame_info.filename}"
                             f"{function_name} at line {frame_info.lineno}\n"
@@ -1252,10 +1365,17 @@ class ProtoTKCell(ProtoKCell[TUnit, TKCell], Generic[TUnit], ABC):  # noqa: PYI0
         convert_external_cells: bool = False,
         set_meta_data: bool = True,
         autoformat_from_file_extension: bool = True,
+        deduplicate_cell_names: bool = False,
     ) -> None:
         """Write a KCell to a GDS.
 
         See [KCLayout.write][kfactory.kcell.KCLayout.write] for more info.
+
+        Args:
+            deduplicate_cell_names: If True, auto-rename duplicate cells with
+                ``$1``, ``$2``, … suffixes before writing. If False (the
+                default), raise :class:`~kfactory.exceptions.DuplicateCellNameError`
+                when duplicates are detected.
         """
         if save_options is None:
             save_options = save_layout_options()
@@ -1289,17 +1409,31 @@ class ProtoTKCell(ProtoKCell[TUnit, TKCell], Generic[TUnit], ABC):  # noqa: PYI0
         filename = str(filename)
         if autoformat_from_file_extension:
             save_options.set_format_from_filename(filename)
-        self._base.kdb_cell.write(filename, save_options)
+        try:
+            self._base.kdb_cell.write(filename, save_options)
+        except RuntimeError:
+            relevant_cells = {self.cell_index(), *self.called_cells()}
+            _check_duplicate_cell_names(
+                self.layout(), relevant_cells, auto_rename=deduplicate_cell_names
+            )
+            self._base.kdb_cell.write(filename, save_options)
 
     def write_bytes(
         self,
         save_options: kdb.SaveLayoutOptions | None = None,
         convert_external_cells: bool = False,
         set_meta_data: bool = True,
+        deduplicate_cell_names: bool = False,
     ) -> bytes:
         """Write a KCell to a binary format as oasis.
 
         See [KCLayout.write][kfactory.kcell.KCLayout.write] for more info.
+
+        Args:
+            deduplicate_cell_names: If True, auto-rename duplicate cells with
+                ``$1``, ``$2``, … suffixes before writing. If False (the
+                default), raise :class:`~kfactory.exceptions.DuplicateCellNameError`
+                when duplicates are detected.
         """
         if save_options is None:
             save_options = save_layout_options()
@@ -1333,7 +1467,14 @@ class ProtoTKCell(ProtoKCell[TUnit, TKCell], Generic[TUnit], ABC):  # noqa: PYI0
         save_options.format = save_options.format or "OASIS"
         save_options.clear_cells()
         save_options.select_cell(self.cell_index())
-        return self.kcl.layout.write_bytes(save_options)
+        try:
+            return self.kcl.layout.write_bytes(save_options)
+        except RuntimeError:
+            relevant_cells = {self.cell_index(), *self.called_cells()}
+            _check_duplicate_cell_names(
+                self.layout(), relevant_cells, auto_rename=deduplicate_cell_names
+            )
+            return self.kcl.layout.write_bytes(save_options)
 
     def read(
         self,

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory/layout.py

@@ -65,6 +65,7 @@ from .kcell import (
     TKCell,
     TVCell,
     VKCell,
+    _check_duplicate_cell_names,
     show,
 )
 from .layer import LayerEnum, LayerInfos, LayerStack, layerenum_from_dict
@@ -2034,6 +2035,7 @@ class KCLayout(
         set_meta_data: bool = True,
         convert_external_cells: bool = False,
         autoformat_from_file_extension: bool = True,
+        deduplicate_cell_names: bool = False,
     ) -> None:
         """Write a GDS file into the existing Layout.
 
@@ -2047,6 +2049,11 @@ class KCLayout(
             autoformat_from_file_extension: Set the format of the output file
                 automatically from the file extension of `filename`. This is necessary
                 for the options. If not set, this will default to `GDSII`.
+            deduplicate_cell_names: If True, auto-rename duplicate cells with
+                ``$1``, ``$2``, … suffixes before writing. If False (the
+                default), raise
+                :class:`~kfactory.exceptions.DuplicateCellNameError` when
+                duplicates are detected.
         """
         if options is None:
             options = save_layout_options()
@@ -2074,8 +2081,62 @@ class KCLayout(
 
         if autoformat_from_file_extension:
             options.set_format_from_filename(filename)
+        try:
+            return self.layout.write(filename, options)
+        except RuntimeError:
+            all_indices = {
+                c.cell_index() for c in self.layout.each_cell() if not c._destroyed()
+            }
+            _check_duplicate_cell_names(
+                self.layout,
+                all_indices,
+                auto_rename=deduplicate_cell_names,
+                tkcells=self.tkcells,
+            )
+            return self.layout.write(filename, options)
+
+    def write_bytes(
+        self,
+        options: kdb.SaveLayoutOptions | None = None,
+        convert_external_cells: bool = False,
+        set_meta_data: bool = True,
+        deduplicate_cell_names: bool = False,
+    ) -> bytes:
+        if options is None:
+            options = save_layout_options()
+        for kc in list(self.kcells.values()):
+            kc.insert_vinsts()
+        match (set_meta_data, convert_external_cells):
+            case (True, True):
+                self.set_meta_data()
+                for kcell in self.kcells.values():
+                    if not kcell.destroyed():
+                        kcell.set_meta_data()
+                        if kcell.is_library_cell():
+                            kcell.convert_to_static(recursive=True)
+            case (True, False):
+                self.set_meta_data()
+                for kcell in self.kcells.values():
+                    if not kcell.destroyed():
+                        kcell.set_meta_data()
+            case (False, True):
+                for kcell in self.kcells.values():
+                    if kcell.is_library_cell() and not kcell.destroyed():
+                        kcell.convert_to_static(recursive=True)
 
-        return self.layout.write(filename, options)
+        try:
+            return self.layout.write_bytes(options)
+        except RuntimeError:
+            all_indices = {
+                c.cell_index() for c in self.layout.each_cell() if not c._destroyed()
+            }
+            _check_duplicate_cell_names(
+                self.layout,
+                all_indices,
+                auto_rename=deduplicate_cell_names,
+                tkcells=self.tkcells,
+            )
+            return self.layout.write_bytes(options)
 
     def top_kcells(self) -> list[KCell]:
         """Return the top KCells."""

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory/schematic.py

@@ -761,12 +761,12 @@ class TSchematic(BaseModel, Generic[TUnit], extra="forbid"):
 
     name: str | None = None
     instances: dict[str, SchematicInstance[TUnit]] = Field(default_factory=dict)
-    placements: dict[str, MirrorPlacement | Placement[TUnit]] = Field(
+    placements: dict[str, Placement[TUnit] | MirrorPlacement] = Field(
         default_factory=dict
     )
     connections: list[Connection[TUnit]] = Field(default_factory=list)
     routes: dict[str, Route[TUnit]] = Field(default_factory=dict)
-    ports: dict[str, Port[TUnit] | PortRef | PortArrayRef] = Field(default_factory=dict)
+    ports: dict[str, Port[TUnit] | PortArrayRef | PortRef] = Field(default_factory=dict)
     kcl: KCLayout = Field(exclude=True, default_factory=get_default_kcl)
     unit: Literal["dbu", "um"]
     info: dict[str, JSONSerializable] = Field(default_factory=dict)

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kfactory
-Version: 2.5.2
+Version: 2.6.0
 Summary: KLayout API implementation of gdsfactory
 Author-email: gdsfactory community <contact@gdsfactory.com>
 Classifier: Programming Language :: Python :: 3.11
@@ -77,14 +77,14 @@ Requires-Dist: ipytree>=0.2.2; extra == "ipy"
 Requires-Dist: ipywidgets>=8.1.5; extra == "ipy"
 Dynamic: license-file
 
-# KFactory 2.5.2
+# KFactory 2.6.0
 
 [![codecov](https://codecov.io/gh/gdsfactory/kfactory/graph/badge.svg?token=dArcfnQE4w)](https://codecov.io/gh/gdsfactory/kfactory)
 
 Kfactory is the backend for [gdsfactory](https://github.com/gdsfactory/gdsfactory). It is built upon [KLayout](https://klayout.de).
 It offers basic operations like gdsfactory, so it can be used on its own as a layout tool as well.
 
-It is recommended to pin the version of KFactory in `requirements.txt` or `pyproject.toml` with `kfactory==2.5.2` for example.
+It is recommended to pin the version of KFactory in `requirements.txt` or `pyproject.toml` with `kfactory==2.6.0` for example.
 
 Features similar to gdsfactory:
 

{kfactory-2.5.2 → kfactory-2.6.0}/src/kfactory.egg-info/SOURCES.txt

@@ -178,6 +178,7 @@ tests/test_utilities.py
 tests/test_violations.py
 tests/test_virtual.py
 tests/test_vkcell.py
+tests/test_write.py
 tests/test_yaml.py
 tests/cli/__init__.py
 tests/cli/test_cli.py

kfactory-2.6.0/tests/test_write.py

@@ -0,0 +1,74 @@
+"""Tests for KCell/KCLayout write and write_bytes.
+
+Covers the happy path (a file / bytes are produced) and the duplicate cell name
+detection used by ``write``/``write_bytes``: raise a
+:class:`~kfactory.exceptions.DuplicateCellNameError` by default, or auto-rename
+with ``$1`` suffixes when ``deduplicate_cell_names=True``.
+"""
+
+from pathlib import Path
+
+import pytest
+
+import kfactory as kf
+from kfactory.exceptions import DuplicateCellNameError
+from tests.conftest import Layers
+
+
+def test_write_and_write_bytes(
+    kcl: kf.KCLayout, layers: Layers, tmp_path: Path
+) -> None:
+    top = kcl.kcell("top")
+    child_a = kcl.kcell("child_a")
+    child_a.shapes(kcl.find_layer(layers.WG)).insert(kf.kdb.Box(0, 0, 1000, 1000))
+    child_b = kcl.kcell("child_b")
+    child_b.shapes(kcl.find_layer(layers.WG)).insert(kf.kdb.Box(0, 0, 500, 500))
+    top << child_a
+    top << child_b
+
+    def make_duplicate() -> None:
+        # Force a raw duplicate name, bypassing the KCell name setter which
+        # would otherwise log/raise depending on ``config.debug_names``.
+        child_b.kdb_cell.name = "child_a"
+
+    def dedup_names() -> list[str]:
+        return sorted(c.name for c in kcl.layout.each_cell())
+
+    path = tmp_path / "out.gds"
+
+    # Happy path: no duplicates -> file / bytes are produced.
+    kcl.write(path)
+    assert path.exists()
+    assert len(kcl.write_bytes()) > 0
+    top.write(path)
+    assert path.exists()
+    assert len(top.write_bytes()) > 0
+
+    # KCLayout.write
+    make_duplicate()
+    with pytest.raises(DuplicateCellNameError):
+        kcl.write(path)
+    kcl.write(path, deduplicate_cell_names=True)
+    assert path.exists()
+    assert dedup_names() == ["child_a", "child_a$1", "top"]
+
+    # KCLayout.write_bytes
+    make_duplicate()
+    with pytest.raises(DuplicateCellNameError):
+        kcl.write_bytes()
+    assert len(kcl.write_bytes(deduplicate_cell_names=True)) > 0
+    assert dedup_names() == ["child_a", "child_a$1", "top"]
+
+    # KCell.write
+    make_duplicate()
+    with pytest.raises(DuplicateCellNameError):
+        top.write(path)
+    top.write(path, deduplicate_cell_names=True)
+    assert dedup_names() == ["child_a", "child_a$1", "top"]
+
+    # KCell.write_bytes
+    make_duplicate()
+    with pytest.raises(DuplicateCellNameError):
+        top.write_bytes()
+    assert len(top.write_bytes(deduplicate_cell_names=True)) > 0
+    assert dedup_names() == ["child_a", "child_a$1", "top"]