pyedb 0.50.0__py3-none-any.whl → 0.51.2__py3-none-any.whl

pyedb/grpc/database/terminal/bundle_terminal.py

@@ -50,7 +50,7 @@ class BundleTerminal(GrpcBundleTerminal):
         self._pedb = pedb
         self._edb_object = edb_object
 
-    def decouple(self):
+    def decouple(self) -> bool:
         """Ungroup a bundle of terminals.
 
         Returns
@@ -60,7 +60,7 @@ class BundleTerminal(GrpcBundleTerminal):
         return self.ungroup()
 
     @property
-    def component(self):
+    def component(self) -> Component:
         """Component.
 
         Returns
@@ -70,7 +70,7 @@ class BundleTerminal(GrpcBundleTerminal):
         return Component(self._pedb, self.component)
 
     @property
-    def impedance(self):
+    def impedance(self) -> float:
         """Impedance value.
 
         Returns
@@ -85,7 +85,7 @@ class BundleTerminal(GrpcBundleTerminal):
         self.impedance = GrpcValue(value)
 
     @property
-    def net(self):
+    def net(self) -> Net:
         """Returns Net object.
 
         Returns
@@ -95,7 +95,7 @@ class BundleTerminal(GrpcBundleTerminal):
         return Net(self._pedb, self.net)
 
     @property
-    def hfss_pi_type(self):
+    def hfss_pi_type(self) -> str:
         """Returns HFSS PI type.
 
         Returns
@@ -118,7 +118,7 @@ class BundleTerminal(GrpcBundleTerminal):
             self.hfss_pi_type = GrpcHfssPIType.LUMPED
 
     @property
-    def reference_layer(self):
+    def reference_layer(self) -> Layer:
         """Returns reference layer.
 
         Returns
@@ -135,7 +135,7 @@ class BundleTerminal(GrpcBundleTerminal):
             self.reference_layer = self._pedb.stackup.signal_layer[value]._edb_object
 
     @property
-    def reference_terminal(self):
+    def reference_terminal(self) -> Terminal:
         """Returns reference terminal.
 
         Returns
@@ -150,7 +150,7 @@ class BundleTerminal(GrpcBundleTerminal):
             self.reference_terminal = value._edb_object
 
     @property
-    def rlc_boundary_parameters(self):
+    def rlc_boundary_parameters(self) -> Rlc:
         """Returns Rlc parameters
 
         Returns
@@ -160,7 +160,7 @@ class BundleTerminal(GrpcBundleTerminal):
         return Rlc(self._pedb, self.rlc)
 
     @property
-    def source_amplitude(self):
+    def source_amplitude(self) -> float:
         """Returns source amplitude.
 
         Returns
@@ -174,7 +174,7 @@ class BundleTerminal(GrpcBundleTerminal):
         self.source_amplitude = GrpcValue(value)
 
     @property
-    def source_phase(self):
+    def source_phase(self) -> float:
         """Returns source phase.
 
         Returns
@@ -188,7 +188,7 @@ class BundleTerminal(GrpcBundleTerminal):
         self.source_phase = GrpcValue(value)
 
     @property
-    def term_to_ground(self):
+    def term_to_ground(self) -> str:
         """Returns terminal to ground.
 
         Returns
@@ -208,7 +208,7 @@ class BundleTerminal(GrpcBundleTerminal):
             self.term_to_ground = GrpcSourceTermToGroundType.POSITIVE
 
     @property
-    def terminals(self):
+    def terminals(self) -> list[Terminal]:
         """Returns terminals list.
 
         Returns

pyedb/grpc/database/terminal/edge_terminal.py

@@ -50,7 +50,7 @@ class EdgeTerminal(GrpcEdgeTerminal):
         self._edb_object.set_product_property(GrpcProductIdType.DESIGNER, 1, value)
 
     @property
-    def is_wave_port(self):
+    def is_wave_port(self) -> bool:
         if self._hfss_port_property:
             return True
         return False
@@ -112,11 +112,12 @@ class EdgeTerminal(GrpcEdgeTerminal):
         return self._pedb.ports[bundle_terminal.name]
 
     @property
-    def is_port(self):
+    def is_port(self) -> bool:
+        """Added for dotnet compatibility"""
         return True
 
     @property
-    def ref_terminal(self):
+    def ref_terminal(self) -> any:
         """Return refeference terminal.
 
         ..deprecated:: 0.44.0
@@ -132,7 +133,7 @@ class EdgeTerminal(GrpcEdgeTerminal):
         self.reference_terminal = value
 
     @property
-    def hfss_type(self):
+    def hfss_type(self) -> str:
         return self._hfss_type
 
     @hfss_type.setter
@@ -140,5 +141,5 @@ class EdgeTerminal(GrpcEdgeTerminal):
         self._hfss_type = value
 
     @property
-    def terminal_type(self):
+    def terminal_type(self) -> str:
         return "EdgeTerminal"

pyedb/grpc/database/terminal/padstack_instance_terminal.py

@@ -37,7 +37,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         self._pedb = pedb
 
     @property
-    def position(self):
+    def position(self) -> list[float]:
         """Terminal position.
 
         Returns
@@ -48,19 +48,19 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         return [pos_x.value, pos_y.value]
 
     @property
-    def padstack_instance(self):
+    def padstack_instance(self) -> any:
         from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
 
         return PadstackInstance(self._pedb, super().padstack_instance)
 
     @property
-    def component(self):
+    def component(self) -> any:
         from pyedb.grpc.database.hierarchy.component import Component
 
         return Component(self._pedb, super().component)
 
     @property
-    def location(self):
+    def location(self) -> list[float]:
         """Terminal position.
 
         Returns
@@ -72,7 +72,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         return [pos_x.value, pos_y.value]
 
     @property
-    def net_name(self):
+    def net_name(self) -> str:
         """Net name.
 
         Returns
@@ -92,7 +92,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
             self.net.name = val
 
     @property
-    def magnitude(self):
+    def magnitude(self) -> float:
         """Source amplitude.
 
         Returns
@@ -106,7 +106,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         self.source_amplitude = value
 
     @property
-    def phase(self):
+    def phase(self) -> float:
         """Source phase.
 
         Returns
@@ -120,7 +120,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         self.source_phase = value
 
     @property
-    def source_amplitude(self):
+    def source_amplitude(self) -> float:
         """Source amplitude.
 
         Returns
@@ -134,7 +134,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         super(PadstackInstanceTerminal, self.__class__).source_amplitude.__set__(self, value)
 
     @property
-    def source_phase(self):
+    def source_phase(self) -> float:
         """Source phase.
 
         Returns
@@ -148,7 +148,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         super(PadstackInstanceTerminal, self.__class__).source_phase.__set__(self, value)
 
     @property
-    def impedance(self):
+    def impedance(self) -> float:
         """Impdeance value.
 
         Returns
@@ -162,7 +162,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         super(PadstackInstanceTerminal, self.__class__).impedance.__set__(self, value)
 
     @property
-    def boundary_type(self):
+    def boundary_type(self) -> str:
         """Boundary type.
 
         Returns
@@ -185,7 +185,7 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         super(PadstackInstanceTerminal, self.__class__).boundary_type.__set__(self, mapping[value.name.lower()])
 
     @property
-    def is_port(self):
+    def is_port(self) -> bool:
         if self.boundary_type == "port":
             return True
         return False
@@ -207,5 +207,5 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
             self.reference_terminal = value
 
     @property
-    def terminal_type(self):
+    def terminal_type(self) -> str:
         return "PadstackInstanceTerminal"

pyedb/grpc/database/terminal/pingroup_terminal.py

@@ -38,7 +38,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         self._pedb = pedb
 
     @property
-    def boundary_type(self):
+    def boundary_type(self) -> str:
         """Boundary type.
 
         Returns
@@ -60,13 +60,13 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         super(PinGroupTerminal, self.__class__).boundary_type.__set__(self, value)
 
     @property
-    def is_port(self):
+    def is_port(self) -> bool:
         if self.boundary_type == "port":
             return True
         return False
 
     @property
-    def magnitude(self):
+    def magnitude(self) -> float:
         """Source magnitude.
 
         Returns
@@ -81,7 +81,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         self.source_amplitude = value
 
     @property
-    def phase(self):
+    def phase(self) -> float:
         """Source phase.
 
         Returns
@@ -96,7 +96,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         self.source_phase = value
 
     @property
-    def source_amplitude(self):
+    def source_amplitude(self) -> float:
         """Source amplitude.
 
         Returns
@@ -111,7 +111,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         super(PinGroupTerminal, self.__class__).source_amplitude.__set__(self, value)
 
     @property
-    def source_phase(self):
+    def source_phase(self) -> float:
         """Source phase.
 
         Returns
@@ -126,7 +126,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         super(PinGroupTerminal, self.__class__).source_phase.__set__(self, value)
 
     @property
-    def impedance(self):
+    def impedance(self) -> float:
         """Terminal impedance.
 
         Returns
@@ -141,7 +141,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         super(PinGroupTerminal, self.__class__).impedance.__set__(self, value)
 
     @property
-    def net(self):
+    def net(self) -> Net:
         """Terminal net.
 
         Returns
@@ -157,7 +157,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         super(PinGroupTerminal, self.__class__).net.__set__(self, value)
 
     @property
-    def pin_group(self):
+    def pin_group(self) -> any:
         """Pingroup.
 
         Returns
@@ -171,7 +171,7 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         return PinGroup(self._pedb, super().pin_group)
 
     @property
-    def terminal_type(self):
+    def terminal_type(self) -> str:
         return "PinGroupTerminal"
 
     @property
@@ -192,11 +192,11 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         self.reference_terminal = value
 
     @property
-    def hfss_type(self):
+    def hfss_type(self) -> str:
         return "circuit"
 
     @property
-    def is_current_source(self):
+    def is_current_source(self) -> bool:
         if self.boundary_type == "current_source":
             return True
         return False

pyedb/grpc/database/terminal/point_terminal.py

@@ -33,7 +33,7 @@ class PointTerminal(GrpcPointTerminal):
         self._pedb = pedb
 
     @property
-    def location(self):
+    def location(self) -> list[float]:
         """Terminal position.
 
         Returns
@@ -51,7 +51,7 @@ class PointTerminal(GrpcPointTerminal):
         self.point = GrpcPointData(value)
 
     @property
-    def layer(self):
+    def layer(self) -> any:
         """Terminal layer.
 
         Returns
@@ -69,7 +69,7 @@ class PointTerminal(GrpcPointTerminal):
             super(PointTerminal, self.__class__).layer.__set__(self, value)
 
     @property
-    def ref_terminal(self):
+    def ref_terminal(self) -> any:
         """Reference terminal.
 
         Returns
@@ -84,7 +84,7 @@ class PointTerminal(GrpcPointTerminal):
         super().reference_terminal = value
 
     @property
-    def reference_terminal(self):
+    def reference_terminal(self) -> any:
         """Reference terminal.
 
         Returns
@@ -99,10 +99,10 @@ class PointTerminal(GrpcPointTerminal):
         super(PointTerminal, self.__class__).reference_terminal.__set__(self, value)
 
     @property
-    def terminal_type(self):
+    def terminal_type(self) -> str:
         return "PointTerminal"
 
     @property
-    def is_port(self):
+    def is_port(self) -> bool:
         """Adding DotNet compatibility."""
         return True

pyedb/grpc/database/terminal/terminal.py

@@ -28,8 +28,8 @@ from ansys.edb.core.terminal.terminal import Terminal as GrpcTerminal
 from ansys.edb.core.terminal.terminal import TerminalType as GrpcTerminalType
 from ansys.edb.core.utility.value import Value as GrpcValue
 
-from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance
-from pyedb.dotnet.database.edb_data.primitives_data import cast
+from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
+from pyedb.grpc.database.primitive.primitive import Primitive
 
 
 class Terminal(GrpcTerminal):
@@ -89,7 +89,7 @@ class Terminal(GrpcTerminal):
         return p
 
     @property
-    def ref_terminal(self):
+    def ref_terminal(self) -> any:
         """Reference terminal.
 
         Returns
@@ -112,7 +112,7 @@ class Terminal(GrpcTerminal):
         self._edb_properties = "HFSS({})".format(txt)
 
     @property
-    def hfss_type(self):
+    def hfss_type(self) -> str:
         """HFSS port type."""
         return self._hfss_port_property["HFSS Type"]
 
@@ -123,7 +123,7 @@ class Terminal(GrpcTerminal):
         self._hfss_port_property = p
 
     @property
-    def layer(self):
+    def layer(self) -> str:
         """Get layer of the terminal.
 
         Returns
@@ -142,7 +142,7 @@ class Terminal(GrpcTerminal):
             self.reference_layer = self._pedb.stackup.layers[value]
 
     @property
-    def do_renormalize(self):
+    def do_renormalize(self) -> bool:
         """Determine whether port renormalization is enabled.
 
         Returns
@@ -157,7 +157,7 @@ class Terminal(GrpcTerminal):
         self.port_post_processing_prop.do_renormalize = value
 
     @property
-    def net_name(self):
+    def net_name(self) -> str:
         """Net name.
 
         Returns
@@ -168,7 +168,7 @@ class Terminal(GrpcTerminal):
         return self.net.name
 
     @property
-    def terminal_type(self):
+    def terminal_type(self) -> str:
         """Terminal Type. Accepted values for setter: `"edge"`, `"point"`, `"terminal_instance"`,
         `"padstack_instance"`, `"bundle_terminal"`, `"pin_group"`.
 
@@ -183,7 +183,7 @@ class Terminal(GrpcTerminal):
         self.type = self._terminal_type_mapping[value]
 
     @property
-    def boundary_type(self):
+    def boundary_type(self) -> str:
         """Boundary type.
 
         Returns
@@ -198,7 +198,7 @@ class Terminal(GrpcTerminal):
         super(Terminal, self.__class__).boundary_type.__set__(self, self._boundary_type_mapping[value])
 
     @property
-    def is_port(self):
+    def is_port(self) -> bool:
         """Whether it is a port.
 
         Returns
@@ -209,7 +209,7 @@ class Terminal(GrpcTerminal):
         return True if self.boundary_type == "port" else False
 
     @property
-    def is_current_source(self):
+    def is_current_source(self) -> bool:
         """Whether it is a current source.
 
         Returns
@@ -220,7 +220,7 @@ class Terminal(GrpcTerminal):
         return True if self.boundary_type == "current_source" else False
 
     @property
-    def is_voltage_source(self):
+    def is_voltage_source(self) -> bool:
         """Whether it is a voltage source.
 
         Returns
@@ -231,7 +231,7 @@ class Terminal(GrpcTerminal):
         return True if self.boundary_type == "voltage_source" else False
 
     @property
-    def impedance(self):
+    def impedance(self) -> float:
         """Impedance of the port.
 
         Returns
@@ -246,7 +246,7 @@ class Terminal(GrpcTerminal):
         self.impedance = GrpcValue(value)
 
     @property
-    def reference_object(self):  # pragma : no cover
+    def reference_object(self) -> any:
         """This returns the object assigned as reference. It can be a primitive or a padstack instance.
 
 
@@ -276,7 +276,7 @@ class Terminal(GrpcTerminal):
         return self._reference_object
 
     @property
-    def reference_net_name(self):
+    def reference_net_name(self) -> str:
         """Net name to which reference_object belongs.
 
         Returns
@@ -289,7 +289,7 @@ class Terminal(GrpcTerminal):
 
         return ""
 
-    def get_padstack_terminal_reference_pin(self, gnd_net_name_preference=None):  # pragma : no cover
+    def get_padstack_terminal_reference_pin(self, gnd_net_name_preference=None) -> PadstackInstance:
         """Get a list of pad stacks instances and serves Coax wave ports,
         pingroup terminals, PadEdge terminals.
 
@@ -311,7 +311,7 @@ class Terminal(GrpcTerminal):
         pins = self._pedb.components.get_pin_from_component(self.component.name)
         return self._get_closest_pin(padStackInstance, pins, gnd_net_name_preference)
 
-    def get_pin_group_terminal_reference_pin(self, gnd_net_name_preference=None):  # pragma : no cover
+    def get_pin_group_terminal_reference_pin(self, gnd_net_name_preference=None) -> PadstackInstance:
         """Return a list of pins and serves terminals connected to pingroups.
 
         Parameters
@@ -339,12 +339,12 @@ class Terminal(GrpcTerminal):
             else:
                 try:
                     _, refTermPSI, _ = refTerm.get_parameters()
-                    return EDBPadstackInstance(refTermPSI, self._pedb)
+                    return PadstackInstance(self._pedb, refTermPSI)
                 except AttributeError:
                     return False
         return False
 
-    def get_edge_terminal_reference_primitive(self):  # pragma : no cover
+    def get_edge_terminal_reference_primitive(self) -> any:
         """Check and return a primitive instance that serves Edge ports,
         wave-ports and coupled-edge ports that are directly connected to primitives.
 
@@ -361,10 +361,10 @@ class Terminal(GrpcTerminal):
         for primitive in self._pedb.layout.primitives:
             if primitive.layer.name == layer_name:
                 if primitive.polygon_data.point_in_polygon(point_data):
-                    return cast(primitive, self._pedb)
+                    return (primitive, self._pedb)
         return None  # pragma: no cover
 
-    def get_point_terminal_reference_primitive(self):  # pragma : no cover
+    def get_point_terminal_reference_primitive(self) -> Primitive:  # pragma : no cover
         """Find and return the primitive reference for the point terminal or the padstack instance.
 
         Returns
@@ -381,7 +381,7 @@ class Terminal(GrpcTerminal):
             if primitive.layer.name == layer_name:
                 prim_shape_data = primitive.GetPolygonData()
                 if primitive.polygon_data.point_in_polygon(point_data):
-                    return cast(primitive, self._pedb)
+                    return Primitive(self._pedb, primitive)
         for vias in self._pedb.padstacks.instances.values():
             if layer_name in vias.layer_range_names:
                 plane = self._pedb.modeler.Shape(
@@ -392,7 +392,7 @@ class Terminal(GrpcTerminal):
                     return vias
         return False
 
-    def get_pad_edge_terminal_reference_pin(self, gnd_net_name_preference=None):
+    def get_pad_edge_terminal_reference_pin(self, gnd_net_name_preference=None) -> PadstackInstance:
         """Get the closest pin padstack instances and serves any edge terminal connected to a pad.
 
         Parameters
@@ -438,10 +438,10 @@ class Terminal(GrpcTerminal):
                 closest_pin_distance = distance
                 pin_obj = pin
         if pin_obj:
-            return EDBPadstackInstance(pin_obj, self._pedb)
+            return PadstackInstance(self._pedb.pin_obj)
 
     @property
-    def magnitude(self):
+    def magnitude(self) -> float:
         """Get the magnitude of the source.
 
         Returns
@@ -455,7 +455,7 @@ class Terminal(GrpcTerminal):
         self.source_amplitude = GrpcValue(value)
 
     @property
-    def phase(self):
+    def phase(self) -> float:
         """Get the phase of the source.
 
         Returns

pyedb/grpc/database/utility/heat_sink.py

@@ -46,7 +46,7 @@ class HeatSink:
         }
 
     @property
-    def fin_base_height(self):
+    def fin_base_height(self) -> float:
         """The base elevation of the fins.
 
         Returns
@@ -61,7 +61,7 @@ class HeatSink:
         self._edb_object.fin_base_height = GrpcValue(value)
 
     @property
-    def fin_height(self):
+    def fin_height(self) -> float:
         """Fin height.
 
         Returns
@@ -77,7 +77,7 @@ class HeatSink:
         self._edb_object.fin_height = GrpcValue(value)
 
     @property
-    def fin_orientation(self):
+    def fin_orientation(self) -> str:
         """Fin orientation.
 
         Returns
@@ -92,7 +92,7 @@ class HeatSink:
         self._edb_object.fin_orientation = self._fin_orientation_type[value]
 
     @property
-    def fin_spacing(self):
+    def fin_spacing(self) -> float:
         """Fin spacing.
 
         Returns
@@ -108,7 +108,7 @@ class HeatSink:
         self._edb_object.fin_spacing = GrpcValue(value)
 
     @property
-    def fin_thickness(self):
+    def fin_thickness(self) -> float:
         """Fin thickness.
 
         Returns