FIX: Miscellaneous 25.2 fixes

Author: drewm102

src/ansys/edb/core/geometry/polygon_data.py

@@ -9,6 +9,7 @@
 from ansys.edb.core import session
 from ansys.edb.core.geometry.arc_data import ArcData
 from ansys.edb.core.inner import messages, parser
+from ansys.edb.core.inner.utils import client_stream_iterator
 from ansys.edb.core.utility import conversions
 
 
@@ -40,6 +41,17 @@ class IntersectionType(Enum):
 class PolygonData:
     """Represents a polygon data object."""
 
+    @staticmethod
+    def _polygon_data_request_iterator(polys):
+        chunk_entry_creator = lambda poly: messages.polygon_data_message(poly)
+        chunk_entries_getter = lambda chunk: chunk.polygons
+        return client_stream_iterator(
+            polys,
+            polygon_data_pb2.PolygonDataListMessage,
+            chunk_entry_creator,
+            chunk_entries_getter,
+        )
+
     __stub: polygon_data_pb2_grpc.PolygonDataServiceStub = session.StubAccessor(
         session.StubType.polygon_data
     )
@@ -355,7 +367,7 @@ def bbox_of_polygons(cls, polygons):
         -------
         tuple[.PointData, .PointData]
         """
-        return cls.__stub.GetBBox(messages.polygon_data_list_message(polygons))
+        return cls.__stub.GetStreamedBBox(PolygonData._polygon_data_request_iterator(polygons))
 
     @parser.to_circle
     def bounding_circle(self):

src/ansys/edb/core/hierarchy/spice_model.py

@@ -1,6 +1,6 @@
 """SPICE Model."""
 from ansys.edb.core.hierarchy.model import Model
-from ansys.edb.core.inner import messages
+from ansys.edb.core.inner import messages, parser
 from ansys.edb.core.session import SpiceModelServiceStub, StubAccessor, StubType
 
 
@@ -78,3 +78,10 @@ def remove_terminal(self, terminal):
             Terminal name.
         """
         self.__stub.RemoveTerminalPinPair(messages.string_property_message(self, terminal))
+
+    @property
+    @parser.to_string_dict
+    def terminal_pin_pairs(self):
+        """:obj:`dict` of {:obj:`str` : :obj:`str`}: A dictionary showing the mapping of terminals in the layout to \
+        pins in the spice model by name."""
+        return self.__stub.GetTerminalPinPairs(self.msg)

src/ansys/edb/core/inner/factory.py

@@ -1,7 +1,6 @@
 """This module allows for the creating of objects while avoid circular imports."""
 
 from ansys.edb.core.edb_defs import LayoutObjType
-from ansys.edb.core.inner.conn_obj import ConnObj
 
 _type_creator_params_dict = None
 _primitive_type_creator_params_dict = None
@@ -20,6 +19,7 @@ def _initialize_type_creator_params_dict():
     from ansys.edb.core.hierarchy.cell_instance import CellInstance
     from ansys.edb.core.hierarchy.group import Group
     from ansys.edb.core.hierarchy.pin_group import PinGroup
+    from ansys.edb.core.inner.conn_obj import ConnObj
     from ansys.edb.core.layout.voltage_regulator import VoltageRegulator
     from ansys.edb.core.net.differential_pair import DifferentialPair
     from ansys.edb.core.net.extended_net import ExtendedNet
@@ -43,6 +43,7 @@ def _initialize_type_creator_params_dict():
         LayoutObjType.EXTENDED_NET: _CreatorParams(ExtendedNet),
         LayoutObjType.DIFFERENTIAL_PAIR: _CreatorParams(DifferentialPair),
         LayoutObjType.NET: _CreatorParams(Net),
+        LayoutObjType.INVALID_LAYOUT_OBJ: _CreatorParams(ConnObj),
     }
     return _type_creator_params_dict
 
@@ -157,4 +158,4 @@ def create_conn_obj(msg):
     -------
     ansys.edb.core.inner.ConnObj
     """
-    return create_lyt_obj(msg, ConnObj(msg).obj_type)
+    return create_lyt_obj(msg, create_lyt_obj(msg, LayoutObjType.INVALID_LAYOUT_OBJ).obj_type)

src/ansys/edb/core/inner/messages.py

@@ -120,8 +120,8 @@
     NetRefMessage,
 )
 from ansys.api.edb.v1.rlc_pb2 import RlcMessage
+from ansys.api.edb.v1.s_parameter_model_pb2 import SParameterModelMessage
 from ansys.api.edb.v1.simulation_setup_pb2 import MatrixConvergenceEntryMessage
-from ansys.api.edb.v1.sparameter_model_pb2 import SParameterModelMessage
 from ansys.api.edb.v1.spice_model_pb2 import SpiceModelMessage, SpiceModelNewTerminalPinMessage
 from ansys.api.edb.v1.structure_3d_pb2 import ClosureMessage, SetClosureMessage
 from ansys.api.edb.v1.term_inst_pb2 import TermInstCreationMessage

src/ansys/edb/core/inner/parser.py

@@ -95,6 +95,11 @@ def to_mesh_op(fn):
     return _wraps(fn, _to_mesh_op)
 
 
+def to_string_dict(fn):
+    """Decorate a function that returns a message to return it as a ``dict[str, str]``."""
+    return _wraps(fn, _to_string_dict)
+
+
 def _wraps(fn, wrapper_fn):
     if callable(fn):
 
@@ -498,3 +503,8 @@ def _to_mesh_op(message):
     for nli in message.net_layer_info:
         mesh_op.net_layer_info.append((nli.net, nli.layer, nli.is_sheet))
     return mesh_op
+
+
+def _to_string_dict(message):
+    """Convert a message to a dictionary of strings."""
+    return {key: value for (key, value) in message.string_map}

src/ansys/edb/core/inner/rpc_info.py

@@ -299,6 +299,8 @@ def invalidates_cache(self):
         "SetRelativePermitivityAtFrequency": _RpcInfo(buffer=True),
         "GetLossTangentAtFrequency": _RpcInfo(cache=True),
         "SetLossTangentAtFrequency": _RpcInfo(buffer=True),
+        "GetHighFrequencyCorner": _RpcInfo(cache=True),
+        "SetHighFrequencyCorner": _RpcInfo(buffer=True),
         "UseDCRelativePermitivity": _RpcInfo(cache=True),
         "SetUseDCRelativePermitivity": _RpcInfo(buffer=True),
         "GetDCRelativePermitivity": _RpcInfo(cache=True),
@@ -584,6 +586,7 @@ def invalidates_cache(self):
     },
     "ansys.api.edb.v1.LayoutInstanceService": {
         "QueryLayoutObjInstances": _RpcInfo(cache=True),
+        "StreamLayoutObjInstancesQuery": _RpcInfo(read_no_cache=True),
         "GetLayoutObjInstanceInContext": _RpcInfo(cache=True),
         "GetConnectedObjects": _RpcInfo(read_no_cache=True),
         "StreamConnectedObjects": _RpcInfo(read_no_cache=True),
@@ -607,6 +610,7 @@ def invalidates_cache(self):
     },
     "ansys.api.edb.v1.LayoutObjInstanceService": {
         "GetLayers": _RpcInfo(cache=True),
+        "StreamLayers": _RpcInfo(read_no_cache=True),
         "GetGeometries": _RpcInfo(cache=True),
         "GetContext": _RpcInfo(cache=True),
         "GetLayoutInstanceContext": _RpcInfo(cache=True),
@@ -863,6 +867,7 @@ def invalidates_cache(self):
         "GetArea": _RpcInfo(cache=True),
         "Transform": _RpcInfo(cache=True),
         "GetBBox": _RpcInfo(cache=True),
+        "GetStreamedBBox": _RpcInfo(read_no_cache=True),
         "GetConvexHull": _RpcInfo(cache=True),
         "RemoveArcs": _RpcInfo(cache=True),
         "Defeature": _RpcInfo(cache=True),
@@ -1272,12 +1277,6 @@ def invalidates_cache(self):
         "UsesSolderball": _RpcInfo(cache=True),
         "Clone": _RpcInfo(buffer=True, returns_future=True, write_no_cache_invalidation=True),
     },
-    "ansys.api.edb.v1.SParameterModelService": {
-        "Create": _RpcInfo(buffer=True, returns_future=True, write_no_cache_invalidation=True),
-        "GetProperties": _RpcInfo(cache=True),
-        "SetComponentModelName": _RpcInfo(buffer=True),
-        "SetReferenceNet": _RpcInfo(buffer=True),
-    },
     "ansys.api.edb.v1.SpiceModelService": {
         "Create": _RpcInfo(buffer=True, returns_future=True, write_no_cache_invalidation=True),
         "GetProperties": _RpcInfo(cache=True),
@@ -1286,6 +1285,7 @@ def invalidates_cache(self):
         "SetSubCkt": _RpcInfo(buffer=True),
         "AddTerminalPinPair": _RpcInfo(buffer=True),
         "RemoveTerminalPinPair": _RpcInfo(buffer=True),
+        "GetTerminalPinPairs": _RpcInfo(cache=True),
     },
     "ansys.api.edb.v1.StackupLayerService": {
         "Create": _RpcInfo(buffer=True, returns_future=True, write_no_cache_invalidation=True),
@@ -1308,6 +1308,8 @@ def invalidates_cache(self):
         "SetEtchFactorEnabled": _RpcInfo(buffer=True),
         "SetEtchFactor": _RpcInfo(buffer=True),
         "GetEtchFactor": _RpcInfo(cache=True),
+        "SetEtchNetClass": _RpcInfo(buffer=True),
+        "GetEtchNetClass": _RpcInfo(cache=True),
         "GetUseSolverProperties": _RpcInfo(cache=True),
         "SetUseSolverProperties": _RpcInfo(buffer=True),
         "GetHFSSSolverProperties": _RpcInfo(cache=True),
@@ -1323,6 +1325,12 @@ def invalidates_cache(self):
         "GetMeshClosureProp": _RpcInfo(cache=True),
         "SetMeshClosureProp": _RpcInfo(buffer=True),
     },
+    "ansys.api.edb.v1.SParameterModelService": {
+        "Create": _RpcInfo(buffer=True, returns_future=True, write_no_cache_invalidation=True),
+        "GetProperties": _RpcInfo(cache=True),
+        "SetComponentModelName": _RpcInfo(buffer=True),
+        "SetReferenceNet": _RpcInfo(buffer=True),
+    },
     "ansys.api.edb.v1.TerminalService": {
         "FindByName": _RpcInfo(buffer=True, returns_future=True),
         "GetParams": _RpcInfo(cache=True),

src/ansys/edb/core/inner/utils.py

@@ -2,7 +2,6 @@
 from ansys.api.edb.v1.layout_obj_pb2 import LayoutObjTargetMessage
 
 from ansys.edb.core.inner.factory import create_lyt_obj
-from ansys.edb.core.utility.io_manager import get_cache
 
 
 def map_list(iterable_to_operate_on, operator=None):
@@ -23,6 +22,8 @@ def query_lyt_object_collection(
 ):
     """For the provided request, retrieve a collection of objects using the unary_rpc or unary_streaming_rpc methods \
     depending on whether caching is enabled."""
+    from ansys.edb.core.utility.io_manager import get_cache
+
     request = (
         LayoutObjTargetMessage(target=owner.msg, type=obj_type.value)
         if request_requires_type
@@ -53,3 +54,22 @@ def stream_items_from_server(parser, stream, chunk_items_att_name):
         for chunk in stream
         for chunk_entry in getattr(chunk, chunk_items_att_name)
     ]
+
+
+def client_stream_iterator(
+    data_to_stream,
+    chunk_type,
+    chunk_entry_creator,
+    chunk_entries_getter,
+    max_size=32000,
+    starting_chunk=None,
+):
+    """Create an iterator of client side items to be used when streaming items to the server."""
+    chunk = chunk_type() if starting_chunk is None else starting_chunk
+    for data_entry in data_to_stream:
+        chunk_entry = chunk_entry_creator(data_entry)
+        if chunk.ByteSize() + chunk_entry.ByteSize() > max_size:
+            yield chunk
+            chunk = chunk_type()
+        chunk_entries_getter(chunk).append(chunk_entry)
+    yield chunk

src/ansys/edb/core/layout_instance/layout_instance.py

@@ -2,6 +2,7 @@
 import ansys.api.edb.v1.layout_instance_pb2 as layout_instance_pb2
 
 from ansys.edb.core.geometry.point_data import PointData
+from ansys.edb.core.geometry.polygon_data import PolygonData
 from ansys.edb.core.inner import ObjBase, utils
 from ansys.edb.core.inner.messages import (
     layer_ref_message,
@@ -12,6 +13,7 @@
 )
 from ansys.edb.core.layout_instance import layout_obj_instance
 from ansys.edb.core.session import LayoutInstanceServiceStub, StubAccessor, StubType
+from ansys.edb.core.utility.io_manager import get_cache
 
 
 class LayoutInstance(ObjBase):
@@ -65,19 +67,30 @@ def to_msg_filter_list(client_filter, ref_msg_type):
             )
             msg_params[spatial_filter_field] = spatial_filter_msg
 
-        hits = self.__stub.QueryLayoutObjInstances(
-            layout_instance_pb2.LayoutObjInstancesQueryMessage(**msg_params)
-        )
-
-        if hits.HasField("full_partial_hits"):
-            full_partial_hits = hits.full_partial_hits
-            return utils.map_list(
-                full_partial_hits.full.items, layout_obj_instance.LayoutObjInstance
-            ), utils.map_list(
-                full_partial_hits.partial.items, layout_obj_instance.LayoutObjInstance
-            )
+        request = layout_instance_pb2.LayoutObjInstancesQueryMessage(**msg_params)
+        all_hits = []
+        if (cache := get_cache()) is not None:
+            for hits_chunk in self.__stub.StreamLayoutObjInstancesQuery(request):
+                all_hits.append(hits_chunk)
+        else:
+            all_hits.append(self.__stub.QueryLayoutObjInstances(request))
+
+        if isinstance(spatial_filter, PolygonData):
+            full_hits = []
+            partial_hits = []
+            for hits in all_hits:
+                full_partial_hits = hits.full_partial_hits
+                for full_hit in full_partial_hits.full.items:
+                    full_hits.append(layout_obj_instance.LayoutObjInstance(full_hit))
+                for partial_hit in full_partial_hits.partial.items:
+                    partial_hits.append(layout_obj_instance.LayoutObjInstance(partial_hit))
+                return full_hits, partial_hits
         else:
-            return utils.map_list(hits.hits.items, layout_obj_instance.LayoutObjInstance)
+            return [
+                layout_obj_instance.LayoutObjInstance(hit)
+                for hits in all_hits
+                for hit in hits.hits.items
+            ]
 
     def get_layout_obj_instance_in_context(self, layout_obj, context):
         """Get the layout object instance of the given :term:`connectable <Connectable>` in the provided context.

src/ansys/edb/core/primitive/primitive_instance_collection.py

@@ -19,7 +19,7 @@
 from ansys.edb.core.inner.layout_obj import LayoutObj
 import ansys.edb.core.inner.messages as messages
 from ansys.edb.core.inner.parser import msg_to_point_data, msg_to_polygon_data, to_polygon_data
-from ansys.edb.core.inner.utils import stream_items_from_server
+from ansys.edb.core.inner.utils import client_stream_iterator, stream_items_from_server
 from ansys.edb.core.session import StubAccessor, StubType
 
 
@@ -33,15 +33,16 @@ class PrimitiveInstanceCollection(LayoutObj):
 
     @staticmethod
     def _point_request_iterator(points, starting_chunk):
-        chunk = starting_chunk
-        max_size = 8000
-        for point in points:
-            point_msg = messages.point_message(point)
-            if chunk.ByteSize() + point_msg.ByteSize() > max_size:
-                yield chunk
-                chunk = PrimitiveInstanceCollectionDataMessage()
-            chunk.points.points.append(point_msg)
-        yield chunk
+        chunk_entry_creator = lambda point: messages.point_message(point)
+        chunk_entries_getter = lambda chunk: chunk.points.points
+        return client_stream_iterator(
+            points,
+            PrimitiveInstanceCollectionDataMessage,
+            chunk_entry_creator,
+            chunk_entries_getter,
+            8000,
+            starting_chunk,
+        )
 
     @classmethod
     def create(

src/ansys/edb/core/session.py

@@ -126,6 +126,7 @@
 )
 from ansys.api.edb.v1.rectangle_pb2_grpc import RectangleServiceStub
 from ansys.api.edb.v1.rlc_component_property_pb2_grpc import RLCComponentPropertyServiceStub
+from ansys.api.edb.v1.s_parameter_model_pb2_grpc import SParameterModelServiceStub
 from ansys.api.edb.v1.si_wave_dcir_simulation_settings_pb2_grpc import (
     SIWaveDCIRSimulationSettingsServiceStub,
 )
@@ -145,7 +146,6 @@
 )
 from ansys.api.edb.v1.simulation_setup_pb2_grpc import SimulationSetupServiceStub
 from ansys.api.edb.v1.solder_ball_property_pb2_grpc import SolderBallPropertyServiceStub
-from ansys.api.edb.v1.sparameter_model_pb2_grpc import SParameterModelServiceStub
 from ansys.api.edb.v1.spice_model_pb2_grpc import SpiceModelServiceStub
 from ansys.api.edb.v1.stackup_layer_pb2_grpc import StackupLayerServiceStub
 from ansys.api.edb.v1.structure_3d_pb2_grpc import Structure3DServiceStub

src/ansys/edb/core/utility/io_manager.py

@@ -13,6 +13,7 @@
 from google.protobuf.empty_pb2 import Empty
 
 from ansys.edb.core.inner.rpc_info_utils import get_rpc_info
+from ansys.edb.core.inner.utils import client_stream_iterator
 
 # The cache module singleton
 MOD = modules[__name__]
@@ -196,15 +197,11 @@ def _hijack_request(self, service_name, rpc_name, request):
 
     @staticmethod
     def _buffer_request_iterator(buffer):
-        max_size = 32000
-        msg = BufferMessage()
-        for buffer_entry in buffer:
-            buffer_entry_msg = buffer_entry.msg()
-            if msg.ByteSize() + buffer_entry_msg.ByteSize() > max_size:
-                yield msg
-                msg = BufferMessage()
-            msg.buffer.append(buffer_entry_msg)
-        yield msg
+        chunk_entry_creator = lambda buffer_entry: buffer_entry.msg()
+        chunk_entries_getter = lambda chunk: chunk.buffer
+        return client_stream_iterator(
+            buffer, BufferMessage, chunk_entry_creator, chunk_entries_getter
+        )
 
     def flush(self):
         if not self._buffer: