Add concrete iter for InstancePorts and DInstancePorts

src/kfactory/instance_ports.py

@@ -191,7 +191,7 @@ def __getitem__(
     @abstractmethod
     def cell_ports(self) -> ProtoPorts[TUnit]: ...
 
-    def __iter__(self) -> Iterator[ProtoPort[TUnit]]:
+    def each_port(self) -> Iterator[ProtoPort[TUnit]]:
         """Create a copy of the ports to iterate through."""
         if not self.instance.is_regular_array():
             if not self.instance.is_complex():
@@ -220,6 +220,9 @@ def __iter__(self) -> Iterator[ProtoPort[TUnit]]:
                     for p in self.cell_ports
                 )
 
+    @abstractmethod
+    def __iter__(self) -> Iterator[ProtoPort[TUnit]]: ...
+
     def each_by_array_coord(self) -> Iterator[tuple[int, int, ProtoPort[TUnit]]]:
         if not self.instance.is_regular_array():
             if not self.instance.is_complex():
@@ -356,6 +359,9 @@ def __getitem__(
     ) -> Port:
         return Port(base=super().__getitem__(key).base)
 
+    def __iter__(self) -> Iterator[Port]:
+        yield from map(lambda p: p.to_itype(), self.each_port())
+
 
 class DInstancePorts(ProtoTInstancePorts[float]):
     def __init__(self, instance: DInstance) -> None:
@@ -388,6 +394,9 @@ def __getitem__(
     ) -> DPort:
         return DPort(base=super().__getitem__(key).base)
 
+    def __iter__(self) -> Iterator[DPort]:
+        yield from map(lambda p: p.to_dtype(), self.each_port())
+
 
 class VInstancePorts(ProtoInstancePorts[float, VInstance]):
     """Ports of an instance.

tests/test_instance_ports.py

@@ -256,6 +256,30 @@ def test_vinstance_ports_contains(kcl: kf.KCLayout, layers: Layers) -> None:
         trans=kf.kdb.DCplxTrans(mag=2),
     )
     assert ref.ports[0] in ref.ports
+    assert ref.ports[0].name is not None
+    assert ref.ports[0].name in ref.ports
+
+
+def test_iter(kcl: kf.KCLayout, layers: Layers) -> None:
+    kcell = kcl.kcell()
+    iref = kcell.create_inst(
+        kf.factories.straight.straight_dbu_factory(kcl)(
+            width=5000, length=10000, layer=layers.WG
+        ),
+        trans=kf.kdb.ICplxTrans(mag=2),
+    )
+    assert len(list(iref.ports)) == 2
+    assert all(isinstance(p, kf.Port) for p in iref.ports)
+
+    dkcell = kcl.dkcell()
+    dref = dkcell.create_inst(
+        kf.factories.straight.straight_dbu_factory(kcl)(
+            width=5000, length=10000, layer=layers.WG
+        ),
+        trans=kf.kdb.DCplxTrans(mag=2),
+    )
+    assert len(list(dref.ports)) == 2
+    assert all(isinstance(p, kf.DPort) for p in dref.ports)
 
 
 if __name__ == "__main__":