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

pyedb/grpc/database/hierarchy/component.py

@@ -22,7 +22,7 @@
 
 import logging
 import re
-from typing import Optional
+from typing import Optional, Union
 import warnings
 
 from ansys.edb.core.definition.component_model import (
@@ -117,7 +117,7 @@ class Component(GrpcComponentGroup):
         return self._comp_instance
 
     @property
-    def is_enabled(self):
+    def is_enabled(self) -> bool:
         """Component enable.
 
         Returns
@@ -132,7 +132,7 @@ class Component(GrpcComponentGroup):
         self.enabled = value
 
     @property
-    def ic_die_properties(self):
+    def ic_die_properties(self) -> any:
         """IC Die property.
 
         returns
@@ -145,7 +145,7 @@ class Component(GrpcComponentGroup):
             return None
 
     @property
-    def _active_layout(self):  # pragma: no cover
+    def _active_layout(self):
         """Active layout.
 
         Returns
@@ -155,7 +155,7 @@ class Component(GrpcComponentGroup):
         return self._pedb.active_layout
 
     @property
-    def _edb_model(self):  # pragma: no cover
+    def _edb_model(self):
         """Component model.
 
         Returns
@@ -167,7 +167,7 @@ class Component(GrpcComponentGroup):
         return comp_prop.model
 
     @property  # pragma: no cover
-    def _pin_pairs(self):
+    def _pin_pairs(self) -> PinPairModel:
         """Pins pairs.
 
         Returns
@@ -200,7 +200,7 @@ class Component(GrpcComponentGroup):
         return [self._edb_model.rlc(pin_pair) for pin_pair in self._edb_model.pin_pairs()]
 
     @property
-    def model(self):
+    def model(self) -> Union[SparamModel, SpiceModel]:
         """Component model.
 
         Returns
@@ -261,7 +261,7 @@ class Component(GrpcComponentGroup):
             self.component_property = comp_prop
 
     @property
-    def is_mcad(self):
+    def is_mcad(self) -> bool:
         """MCad component.
 
         Returns
@@ -277,7 +277,7 @@ class Component(GrpcComponentGroup):
             super(Component, self.__class__).is_mcad.__set__(self, GrpcValue(value))
 
     @property
-    def is_mcad_3d_comp(self):
+    def is_mcad_3d_comp(self) -> bool:
         """Mcad 3D component.
 
         Returns
@@ -293,7 +293,7 @@ class Component(GrpcComponentGroup):
             super(Component, self.__class__).is_mcad_3d_comp.__set__(self, GrpcValue(value))
 
     @property
-    def is_mcad_hfss(self):
+    def is_mcad_hfss(self) -> bool:
         """MCad HFSS.
 
         Returns
@@ -309,7 +309,7 @@ class Component(GrpcComponentGroup):
             super(Component, self.__class__).is_mcad_hfss.__set__(self, GrpcValue(value))
 
     @property
-    def is_mcad_stride(self):
+    def is_mcad_stride(self) -> bool:
         """MCar stride.
 
         Returns
@@ -324,15 +324,13 @@ class Component(GrpcComponentGroup):
         if isinstance(value, bool):
             super(Component, self.__class__).is_mcad_stride.__set__(self, GrpcValue(value))
 
-    def create_package_def(self, name="", component_part_name=None):
+    def create_package_def(self, name=None) -> bool:
         """Create a package definition and assign it to the component.
 
         Parameters
         ----------
         name: str, optional
             Name of the package definition
-        component_part_name : str, optional
-            Part name of the component.
 
         Returns
         -------
@@ -349,7 +347,7 @@ class Component(GrpcComponentGroup):
             return False
 
     @property
-    def enabled(self):
+    def enabled(self) -> bool:
         """Component active mode.
 
         Returns
@@ -369,7 +367,7 @@ class Component(GrpcComponentGroup):
         self.component_property = cmp_prop
 
     @property
-    def spice_model(self):
+    def spice_model(self) -> SpiceModel:
         """Assigned Spice model.
 
         Returns
@@ -379,10 +377,10 @@ class Component(GrpcComponentGroup):
         if not self.model_type == "SPICEModel":
             return None
         else:
-            return SpiceModel(self._edb_model.msg)
+            return SpiceModel(edb_object=self._edb_model)
 
     @property
-    def s_param_model(self):
+    def s_param_model(self) -> SparamModel:
         """Assigned S-parameter model.
 
         Returns
@@ -392,10 +390,10 @@ class Component(GrpcComponentGroup):
         if not self.model_type == "SParameterModel":
             return None
         else:
-            return GrpcSParameterModel(self._edb_model.msg)
+            return SparamModel(edb_object=self._edb_model)
 
     @property
-    def netlist_model(self):
+    def netlist_model(self) -> GrpcNetlistModel:
         """Assigned netlist model.
 
         Returns
@@ -408,7 +406,7 @@ class Component(GrpcComponentGroup):
             return GrpcNetlistModel(self._edb_model)
 
     @property
-    def solder_ball_height(self):
+    def solder_ball_height(self) -> float:
         """Solder ball height if available.
 
         Returns
@@ -419,7 +417,7 @@ class Component(GrpcComponentGroup):
         try:
             return self.component_property.solder_ball_property.height.value
         except:
-            return None
+            return 0.0
 
     @solder_ball_height.setter
     def solder_ball_height(self, value):
@@ -431,7 +429,7 @@ class Component(GrpcComponentGroup):
             self.component_property = cmp_property
 
     @property
-    def solder_ball_shape(self):
+    def solder_ball_shape(self) -> str:
         """Solder ball shape.
 
         Returns
@@ -467,7 +465,7 @@ class Component(GrpcComponentGroup):
                 self.component_property = cmp_property
 
     @property
-    def solder_ball_diameter(self):
+    def solder_ball_diameter(self) -> float:
         """Solder ball diameter.
 
         Returns
@@ -508,7 +506,7 @@ class Component(GrpcComponentGroup):
             return solder_placement.value
 
     @property
-    def refdes(self):
+    def refdes(self) -> str:
         """Reference Designator Name.
 
         Returns
@@ -523,7 +521,7 @@ class Component(GrpcComponentGroup):
         self.name = name
 
     @property
-    def model_type(self):
+    def model_type(self) -> str:
         """Retrieve assigned model type.
 
         Returns
@@ -542,12 +540,12 @@ class Component(GrpcComponentGroup):
             return _model_type
 
     @property
-    def rlc_values(self):
+    def rlc_values(self) -> list[list[float]]:
         """Get component rlc values.
 
         Returns
         -------
-        List[Rvalue(float), Lvalue(float), Cvalue(float)].
+        list[list[Rvalue(float), Lvalue(float), Cvalue(float)]].
         """
         if not len(self._rlc):
             return [None, None, None]
@@ -589,7 +587,7 @@ class Component(GrpcComponentGroup):
         self.component_property = comp_property
 
     @property
-    def value(self):
+    def value(self) -> float:
         """Retrieve discrete component value.
 
         Returns
@@ -613,7 +611,7 @@ class Component(GrpcComponentGroup):
             self.cap_value = value
 
     @property
-    def res_value(self):
+    def res_value(self) -> float:
         """Resistance value.
 
         Returns
@@ -645,7 +643,7 @@ class Component(GrpcComponentGroup):
         self.component_property = comp_prop
 
     @property
-    def cap_value(self):
+    def cap_value(self) -> float:
         """Capacitance Value.
 
         Returns
@@ -696,7 +694,7 @@ class Component(GrpcComponentGroup):
         return None
 
     @ind_value.setter
-    def ind_value(self, value):  # pragma no cover
+    def ind_value(self, value) -> float:
         if value:
             _rlc = []
             model = PinPairModel(self._pedb, GrpcPinPairModel.create())
@@ -711,7 +709,7 @@ class Component(GrpcComponentGroup):
             self.component_property = comp_prop
 
     @property
-    def is_parallel_rlc(self):
+    def is_parallel_rlc(self) -> bool:
         """Define if model is Parallel or Series.
 
         Returns
@@ -739,7 +737,7 @@ class Component(GrpcComponentGroup):
                     self.component_property = comp_property
 
     @property
-    def center(self):
+    def center(self) -> list[float, float]:
         """Compute the component center.
 
         Returns
@@ -768,7 +766,7 @@ class Component(GrpcComponentGroup):
             super(Component, self.__class__).location.__set__(self, _location)
 
     @property
-    def bounding_box(self):
+    def bounding_box(self) -> list[float]:
         """Component's bounding box.
 
         Returns
@@ -784,7 +782,7 @@ class Component(GrpcComponentGroup):
         return [pt1.x.value, pt1.y.value, pt2.x.value, pt2.y.value]
 
     @property
-    def rotation(self):
+    def rotation(self) -> float:
         """Compute the component rotation in radian.
 
         Returns
@@ -795,7 +793,7 @@ class Component(GrpcComponentGroup):
         return self.transform.rotation.value
 
     @property
-    def pinlist(self):
+    def pinlist(self) -> list[PadstackInstance]:
         """Pins of the component.
 
         Returns
@@ -821,7 +819,7 @@ class Component(GrpcComponentGroup):
         return list(set(nets))
 
     @property
-    def pins(self):
+    def pins(self) -> dict[str, PadstackInstance]:
         """Component pins.
 
         Returns
@@ -838,7 +836,7 @@ class Component(GrpcComponentGroup):
         return _pins
 
     @property
-    def type(self):
+    def type(self) -> str:
         """Component type.
 
         Returns
@@ -876,18 +874,26 @@ class Component(GrpcComponentGroup):
             return
 
     @property
-    def numpins(self):
+    def numpins(self) -> int:
         """Number of Pins of Component.
 
+        ..deprecated:: 0.51.0
+           Use: func:`num_pins` instead.
         Returns
         -------
         int
             Component pins number.
         """
-        return self.num_pins
+
+        warnings.warn("Use num_pins instead.", DeprecationWarning)
+        try:
+            return self.num_pins
+        except Exception as e:
+            self._pedb.logger.error(f"{e}")
+            return 0
 
     @property
-    def partname(self):  # pragma: no cover
+    def partname(self) -> str:
         """Component part name.
 
         Returns
@@ -903,7 +909,7 @@ class Component(GrpcComponentGroup):
         self.part_name = name
 
     @property
-    def part_name(self):
+    def part_name(self) -> str:
         """Component part name.
 
         Returns
@@ -919,7 +925,7 @@ class Component(GrpcComponentGroup):
         self.component_def.name = name
 
     @property
-    def placement_layer(self):
+    def placement_layer(self) -> str:
         """Placement layern name.
 
         Returns
@@ -930,7 +936,7 @@ class Component(GrpcComponentGroup):
         return super().placement_layer.name
 
     @property
-    def layer(self):
+    def layer(self) -> StackupLayer:
         """Placement layern object.
 
         Returns
@@ -941,7 +947,7 @@ class Component(GrpcComponentGroup):
         return StackupLayer(self._pedb, super().placement_layer)
 
     @property
-    def is_top_mounted(self):
+    def is_top_mounted(self) -> bool:
         """Check if a component is mounted on top or bottom of the layout.
 
         Returns
@@ -955,7 +961,7 @@ class Component(GrpcComponentGroup):
         return False
 
     @property
-    def lower_elevation(self):
+    def lower_elevation(self) -> float:
         """Lower elevation of the placement layer.
 
         Returns
@@ -966,7 +972,7 @@ class Component(GrpcComponentGroup):
         return self.layer.lower_elevation
 
     @property
-    def upper_elevation(self):
+    def upper_elevation(self) -> float:
         """Upper elevation of the placement layer.
 
         Returns
@@ -978,7 +984,7 @@ class Component(GrpcComponentGroup):
         return self.layer.upper_elevation
 
     @property
-    def top_bottom_association(self):
+    def top_bottom_association(self) -> int:
         """Top/bottom association of the placement layer.
 
         Returns
@@ -1015,7 +1021,7 @@ class Component(GrpcComponentGroup):
         name: Optional[str] = None,
         sub_circuit_name: Optional[str] = None,
         terminal_pairs: Optional[list] = None,
-    ):
+    ) -> SpiceModel:
         """Assign Spice model to this component.
 
         Parameters
@@ -1064,7 +1070,7 @@ class Component(GrpcComponentGroup):
         else:
             return False
 
-    def assign_s_param_model(self, file_path, name=None, reference_net=None):
+    def assign_s_param_model(self, file_path, name=None, reference_net=None) -> GrpcNPortComponentModel:
         """Assign S-parameter to this component.
 
         Parameters
@@ -1074,6 +1080,9 @@ class Component(GrpcComponentGroup):
         name : str, optional
             Name of the S-parameter model.
 
+        reference_net : str, optional
+            Reference net.
+
         Returns
         -------
         :class:`NPortComponentModel <ansys.edb.core.definition.component_model.ComponentModel>`
@@ -1100,7 +1109,7 @@ class Component(GrpcComponentGroup):
         model = GrpcSParameterModel.create(name=name, ref_net=reference_net)
         return self._set_model(model)
 
-    def use_s_parameter_model(self, name, reference_net=None):
+    def use_s_parameter_model(self, name, reference_net=None) -> bool:
         """Use S-parameter model on the component.
 
         Parameters
@@ -1134,7 +1143,7 @@ class Component(GrpcComponentGroup):
             return self._set_model(s_param_model)
         return False
 
-    def assign_rlc_model(self, res=None, ind=None, cap=None, is_parallel=False):
+    def assign_rlc_model(self, res=None, ind=None, cap=None, is_parallel=False) -> PinPairModel:
         """Assign RLC to this component.
 
         Parameters
@@ -1180,7 +1189,7 @@ class Component(GrpcComponentGroup):
             model.set_rlc(("1", "2"), rlc)
         return self._set_model(model)
 
-    def create_clearance_on_component(self, extra_soldermask_clearance=1e-4):
+    def create_clearance_on_component(self, extra_soldermask_clearance=1e-4) -> bool:
         """Create a Clearance on Soldermask layer by drawing a rectangle.
 
         Parameters
@@ -1229,7 +1238,7 @@ class ICDieProperty:
         self._die_property = self._component.component_property.die_property
 
     @property
-    def die_orientation(self):
+    def die_orientation(self) -> str:
         """Die orientation.
 
         Returns
@@ -1254,7 +1263,7 @@ class ICDieProperty:
         self._component.component_property = component_property
 
     @property
-    def die_type(self):
+    def die_type(self) -> str:
         """Die type.
 
         Returns
@@ -1281,7 +1290,7 @@ class ICDieProperty:
         self._component.component_property = component_property
 
     @property
-    def height(self):
+    def height(self) -> float:
         """Die height.
 
         Returns
@@ -1301,7 +1310,7 @@ class ICDieProperty:
         self._component.component_property = component_property
 
     @property
-    def is_null(self):
+    def is_null(self) -> bool:
         """Test is die is null.
 
         Returns

pyedb/grpc/database/hierarchy/pin_pair_model.py

@@ -34,7 +34,7 @@ class PinPairModel(GrpcPinPairModel):
         super().__init__(edb_object.msg)
 
     @property
-    def rlc(self):
+    def rlc(self) -> tuple[str, str]:
         """Rlc mdodel.
 
         Returns
@@ -45,7 +45,7 @@ class PinPairModel(GrpcPinPairModel):
         return super().rlc(self.pin_pairs()[0])
 
     @property
-    def rlc_enable(self):
+    def rlc_enable(self) -> list[bool]:
         """Enable model.
 
         Returns
@@ -62,7 +62,7 @@ class PinPairModel(GrpcPinPairModel):
         self.rlc.c_enabled = GrpcValue(value[2])
 
     @property
-    def resistance(self):
+    def resistance(self) -> float:
         """Resistance.
 
         Returns
@@ -78,7 +78,7 @@ class PinPairModel(GrpcPinPairModel):
         self.rlc.r = GrpcValue(value)
 
     @property
-    def inductance(self):
+    def inductance(self) -> float:
         """Inductance.
 
         Returns
@@ -94,7 +94,7 @@ class PinPairModel(GrpcPinPairModel):
         self.rlc.l = GrpcValue(value)
 
     @property
-    def capacitance(self):
+    def capacitance(self) -> float:
         """Capacitance.
 
         Returns
@@ -110,7 +110,7 @@ class PinPairModel(GrpcPinPairModel):
         self.rlc.c = GrpcValue(value)
 
     @property
-    def rlc_values(self):  # pragma: no cover
+    def rlc_values(self) -> list[float]:
         """Rlc value.
 
         Returns

pyedb/grpc/database/hierarchy/pingroup.py

@@ -21,6 +21,8 @@
 # SOFTWARE.
 
 
+from typing import Union
+
 from ansys.edb.core.hierarchy.pin_group import PinGroup as GrpcPinGroup
 from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 from ansys.edb.core.utility.value import Value as GrpcValue
@@ -53,7 +55,7 @@ class PinGroup(GrpcPinGroup):
         return self._pedb.active_layout
 
     @property
-    def component(self):
+    def component(self) -> Component:
         """Component.
 
         Return
@@ -69,7 +71,7 @@ class PinGroup(GrpcPinGroup):
             super(PinGroup, self.__class__).component.__set__(self, value)
 
     @property
-    def pins(self):
+    def pins(self) -> dict[str, PadstackInstance]:
         """Pin group pins.
 
         Returns
@@ -79,7 +81,7 @@ class PinGroup(GrpcPinGroup):
         return {i.name: PadstackInstance(self._pedb, i) for i in super().pins}
 
     @property
-    def net(self):
+    def net(self) -> Net:
         """Net.
 
         Returns
@@ -94,7 +96,7 @@ class PinGroup(GrpcPinGroup):
             super(PinGroup, self.__class__).net.__set__(self, value)
 
     @property
-    def net_name(self):
+    def net_name(self) -> str:
         """Net name.
 
         Returns
@@ -106,7 +108,7 @@ class PinGroup(GrpcPinGroup):
         return self.net.name
 
     @property
-    def terminal(self):
+    def terminal(self) -> Union[PinGroupTerminal, None]:
         """Terminal."""
         term = self.pin_group_terminal
         if not term.is_null:
@@ -115,7 +117,7 @@ class PinGroup(GrpcPinGroup):
         else:
             return None
 
-    def create_terminal(self, name=None):
+    def create_terminal(self, name=None) -> PinGroupTerminal:
         """Create a terminal.
 
         Parameters
@@ -136,7 +138,7 @@ class PinGroup(GrpcPinGroup):
         )
         return PinGroupTerminal(self._pedb, term)
 
-    def _json_format(self):
+    def _json_format(self) -> dict[str, any]:
         """Format json.
 
         Returns
@@ -146,7 +148,7 @@ class PinGroup(GrpcPinGroup):
         dict_out = {"component": self.component, "name": self.name, "net": self.net, "node_type": self.node_type}
         return dict_out
 
-    def create_current_source_terminal(self, magnitude=1.0, phase=0, impedance=1e6):
+    def create_current_source_terminal(self, magnitude=1.0, phase=0, impedance=1e6) -> PinGroupTerminal:
         """Create current source terminal.
 
         Parameters
@@ -171,7 +173,7 @@ class PinGroup(GrpcPinGroup):
         terminal.impedance = GrpcValue(impedance)
         return terminal
 
-    def create_voltage_source_terminal(self, magnitude=1, phase=0, impedance=0.001):
+    def create_voltage_source_terminal(self, magnitude=1, phase=0, impedance=0.001) -> PinGroupTerminal:
         """Create voltage source terminal.
 
         Parameters
@@ -196,7 +198,7 @@ class PinGroup(GrpcPinGroup):
         terminal.impedance = GrpcValue(impedance)
         return terminal
 
-    def create_voltage_probe_terminal(self, impedance=1e6):
+    def create_voltage_probe_terminal(self, impedance=1e6) -> PinGroupTerminal:
         """Create voltage probe terminal.
 
         Parameters
@@ -215,7 +217,7 @@ class PinGroup(GrpcPinGroup):
         terminal.impedance = GrpcValue(impedance)
         return terminal
 
-    def create_port_terminal(self, impedance=50):
+    def create_port_terminal(self, impedance=50) -> PinGroupTerminal:
         """Create port terminal.
 
         Parameters

pyedb/grpc/database/hierarchy/s_parameter_model.py

@@ -29,5 +29,5 @@ class SparamModel(GrpcSParameterModel):  # pragma: no cover
     """Manage :class:`SParameterModel <ansys.edb.core.hierarchy.sparameter_model.SParameterModel>`"""
 
     def __init__(self, edb_object):
-        super().__init__(self.msg)
+        super().__init__(edb_object.msg)
         self._edb_model = edb_object

pyedb/grpc/database/hierarchy/spice_model.py

@@ -28,7 +28,7 @@ class SpiceModel(GrpcSpiceModel):  # pragma: no cover
 
     def __init__(self, edb_object=None, name=None, file_path=None, sub_circuit=None):
         if edb_object:
-            super().__init__(edb_object)
+            super().__init__(edb_object.msg)
         elif name and file_path:
             if not sub_circuit:
                 sub_circuit = name

pyedb/grpc/database/layers/layer.py

@@ -53,7 +53,7 @@ class Layer(GrpcLayer):
                 self._pedb.logger.error(f"{k} is not a valid layer attribute")
 
     @property
-    def properties(self):
+    def properties(self) -> dict[str, str]:
         from ansys.edb.core.layer.stackup_layer import StackupLayer as GrpcStackupLayer
 
         from pyedb.grpc.database.stackup import StackupLayer
@@ -77,7 +77,7 @@ class Layer(GrpcLayer):
             self.color = color
 
     @property
-    def type(self):
+    def type(self) -> str:
         return super().type.name.lower().split("_")[0]
 
     @property