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

pyedb/grpc/database/definition/component_def.py

@@ -44,7 +44,7 @@ class ComponentDef(GrpcComponentDef):
         self._pedb = pedb
 
     @property
-    def part_name(self):
+    def part_name(self) -> str:
         """Component definition name.
 
         Returns
@@ -60,7 +60,7 @@ class ComponentDef(GrpcComponentDef):
         self.name = name
 
     @property
-    def type(self):
+    def type(self) -> str:
         """Component definition type.
 
         Returns
@@ -97,28 +97,28 @@ class ComponentDef(GrpcComponentDef):
             return
 
     @property
-    def components(self):
+    def components(self) -> dict[str, Component]:
         """Component instances belonging to the definition.
 
         Returns
         -------
-        Dict : [str, :class:`Component <pyedb.grpc.database.hierarchy.component.Component>`]
+        dict[str, :class:`Component <pyedb.grpc.database.hierarchy.component.Component>`]
         """
         comp_list = [Component(self._pedb, l) for l in Component.find_by_def(self._pedb.active_layout, self.part_name)]
         return {comp.refdes: comp for comp in comp_list}
 
     @property
-    def component_pins(self):
+    def component_pins(self) -> list[ComponentPin]:
         """Component pins.
 
         Returns
         -------
-        List[:class:`ComponentPin <pyedb.grpc.database.definition.component_pin.ComponentPin>`]
+        list[:class:`ComponentPin <pyedb.grpc.database.definition.component_pin.ComponentPin>`]
 
         """
         return [ComponentPin(self._pedb, pin) for pin in super().component_pins]
 
-    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) -> bool:
         """Assign RLC to all components under this part name.
 
         Parameters
@@ -142,16 +142,19 @@ class ComponentDef(GrpcComponentDef):
             comp.assign_rlc_model(res, ind, cap, is_parallel)
         return True
 
-    def assign_s_param_model(self, file_path, model_name=None, reference_net=None):
+    def assign_s_param_model(self, file_path, model_name=None, reference_net=None) -> bool:
         """Assign S-parameter to all components under this part name.
 
         Parameters
         ----------
         file_path : str
             File path of the S-parameter model.
-        name : str, optional
+        model_name : str, optional
             Name of the S-parameter model.
 
+        reference_net : str, optional
+            Name of the reference net.
+
         Returns
         -------
         bool
@@ -161,31 +164,31 @@ class ComponentDef(GrpcComponentDef):
             comp.assign_s_param_model(file_path, model_name, reference_net)
         return True
 
-    def assign_spice_model(self, file_path, model_name=None):
+    def assign_spice_model(self, file_path, model_name=None) -> bool:
         """Assign Spice model to all components under this part name.
 
         Parameters
         ----------
         file_path : str
             File path of the Spice model.
-        name : str, optional
+        model_name : str, optional
             Name of the Spice model.
 
         Returns
         -------
-
+        bool
         """
         for comp in list(self.components.values()):
             comp.assign_spice_model(file_path, model_name)
         return True
 
     @property
-    def reference_file(self):
+    def reference_file(self) -> list[str]:
         """Model reference file.
 
         Returns
         -------
-        List[str]
+        list[str]
             List of reference files.
 
         """

pyedb/grpc/database/definition/materials.py

@@ -128,7 +128,7 @@ class Material(GrpcMaterialDef):
         self.__dielectric_model = None
 
     @property
-    def name(self):
+    def name(self) -> str:
         """Material name.
 
         Returns
@@ -172,7 +172,7 @@ class Material(GrpcMaterialDef):
             return 0.0
 
     @property
-    def conductivity(self):
+    def conductivity(self) -> float:
         """Get material conductivity.
 
         Returns
@@ -238,7 +238,7 @@ class Material(GrpcMaterialDef):
             self.dielectric_material_model.dc_relative_permitivity = float(value)
 
     @property
-    def loss_tangent_at_frequency(self):
+    def loss_tangent_at_frequency(self) -> float:
         """Material loss tangent at frequency if dielectric model is defined.
 
         Returns
@@ -258,7 +258,7 @@ class Material(GrpcMaterialDef):
             self.dielectric_material_model.loss_tangent_at_frequency = float(value)
 
     @property
-    def dielectric_model_frequency(self):
+    def dielectric_model_frequency(self) -> float:
         """Dielectric model frequency if model is defined.
 
         Returns
@@ -278,7 +278,7 @@ class Material(GrpcMaterialDef):
             self.dielectric_material_model.frequency = float(value)
 
     @property
-    def permittivity_at_frequency(self):
+    def permittivity_at_frequency(self) -> float:
         """Material permittivity at frequency if model is defined.
 
 
@@ -299,7 +299,7 @@ class Material(GrpcMaterialDef):
             self.dielectric_material_model.relative_permitivity_at_frequency = float(value)
 
     @property
-    def permittivity(self):
+    def permittivity(self) -> float:
         """Material permittivity.
 
 
@@ -321,7 +321,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.PERMITTIVITY, GrpcValue(value))
 
     @property
-    def permeability(self):
+    def permeability(self) -> float:
         """Material permeability.
 
         Returns
@@ -359,7 +359,7 @@ class Material(GrpcMaterialDef):
         return self.dielectric_loss_tangent
 
     @property
-    def dielectric_loss_tangent(self):
+    def dielectric_loss_tangent(self) -> float:
         """Material loss tangent.
 
         Returns
@@ -389,7 +389,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.DIELECTRIC_LOSS_TANGENT, GrpcValue(value))
 
     @property
-    def magnetic_loss_tangent(self):
+    def magnetic_loss_tangent(self) -> float:
         """Material magnetic loss tangent.
 
         Returns
@@ -409,7 +409,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.MAGNETIC_LOSS_TANGENT, GrpcValue(value))
 
     @property
-    def thermal_conductivity(self):
+    def thermal_conductivity(self) -> float:
         """Material thermal conductivity.
 
         Returns
@@ -430,7 +430,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.THERMAL_CONDUCTIVITY, GrpcValue(value))
 
     @property
-    def mass_density(self):
+    def mass_density(self) -> float:
         """Material mass density.
 
         Returns
@@ -451,7 +451,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.MASS_DENSITY, GrpcValue(value))
 
     @property
-    def youngs_modulus(self):
+    def youngs_modulus(self) -> float:
         """Material young modulus.
 
         Returns
@@ -472,7 +472,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.YOUNGS_MODULUS, GrpcValue(value))
 
     @property
-    def specific_heat(self):
+    def specific_heat(self) -> float:
         """Material specific heat.
 
         Returns
@@ -491,7 +491,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.SPECIFIC_HEAT, GrpcValue(value))
 
     @property
-    def poisson_ratio(self):
+    def poisson_ratio(self) -> float:
         """Material poisson ratio.
 
         Returns
@@ -510,7 +510,7 @@ class Material(GrpcMaterialDef):
         self.set_property(GrpcMaterialProperty.POISSONS_RATIO, GrpcValue(value))
 
     @property
-    def thermal_expansion_coefficient(self):
+    def thermal_expansion_coefficient(self) -> float:
         """Material thermal coefficient.
 
         Returns
@@ -639,7 +639,7 @@ class Materials(object):
         return self.__syslib
 
     @property
-    def materials(self):
+    def materials(self) -> dict[str, Material]:
         """Get materials.
 
         Returns
@@ -652,7 +652,7 @@ class Materials(object):
         }
         return materials
 
-    def add_material(self, name: str, **kwargs):
+    def add_material(self, name: str, **kwargs) -> Material:
         """Add a new material.
 
         Parameters
@@ -690,7 +690,7 @@ class Materials(object):
 
         return material
 
-    def add_conductor_material(self, name, conductivity, **kwargs):
+    def add_conductor_material(self, name, conductivity, **kwargs) -> Material:
         """Add a new conductor material.
 
         Parameters
@@ -712,7 +712,7 @@ class Materials(object):
 
         return material
 
-    def add_dielectric_material(self, name, permittivity, dielectric_loss_tangent, **kwargs):
+    def add_dielectric_material(self, name, permittivity, dielectric_loss_tangent, **kwargs) -> Material:
         """Add a new dielectric material in library.
 
         Parameters
@@ -745,7 +745,7 @@ class Materials(object):
         dc_conductivity=None,
         dc_permittivity=None,
         **kwargs,
-    ):
+    ) -> Material:
         """Add a dielectric using the Djordjevic-Sarkar model.
 
         Parameters
@@ -804,7 +804,7 @@ class Materials(object):
         lower_freqency,
         higher_frequency,
         **kwargs,
-    ):
+    ) -> Material:
         """Add a dielectric with the Debye model.
 
         Parameters
@@ -864,7 +864,7 @@ class Materials(object):
         permittivities,
         loss_tangents,
         **kwargs,
-    ):
+    ) -> Material:
         """Add a dielectric with the Multipole Debye model.
 
         Parameters
@@ -938,7 +938,7 @@ class Materials(object):
         material = Material(self.__edb, material_def)
         return material
 
-    def duplicate(self, material_name, new_material_name):
+    def duplicate(self, material_name, new_material_name) -> Material:
         """Duplicate a material from the database.
 
         Parameters
@@ -983,7 +983,7 @@ class Materials(object):
         )
         self.delete(material_name)
 
-    def delete(self, material_name):
+    def delete(self, material_name) -> bool:
         """Remove a material from the database.
 
         Returns
@@ -1077,7 +1077,7 @@ class Materials(object):
         else:
             return property_name_to_id["InvalidProperty"]
 
-    def load_amat(self, amat_file):
+    def load_amat(self, amat_file) -> bool:
         """Load materials from an AMAT file.
 
         Parameters
@@ -1184,7 +1184,7 @@ class Materials(object):
                         material_description["name"] = match.group(1)
                         in_material_def = True
 
-    def read_materials(self, amat_file):
+    def read_materials(self, amat_file) -> dict[str, Material]:
         """Read materials from an AMAT file.
 
         Parameters
@@ -1207,7 +1207,7 @@ class Materials(object):
 
         return res
 
-    def read_syslib_material(self, material_name):
+    def read_syslib_material(self, material_name) -> dict[str, Material]:
         """Read a specific material from syslib AMAT file.
 
         Parameters

pyedb/grpc/database/definition/package_def.py

@@ -92,7 +92,7 @@ class PackageDef(GrpcPackageDef):
         return edb_object
 
     @property
-    def exterior_boundary(self):
+    def exterior_boundary(self) -> GrpcPolygonData:
         """Get the exterior boundary of a package definition.
 
         Returns
@@ -107,7 +107,7 @@ class PackageDef(GrpcPackageDef):
         super(PackageDef, self.__class__).exterior_boundary.__set__(self, value)
 
     @property
-    def maximum_power(self):
+    def maximum_power(self) -> float:
         """Maximum power of the package.
 
         Returns
@@ -122,7 +122,7 @@ class PackageDef(GrpcPackageDef):
         super(PackageDef, self.__class__).maximum_power.__set__(self, GrpcValue(value))
 
     @property
-    def therm_cond(self):
+    def therm_cond(self) -> float:
         """Thermal conductivity of the package.
 
         Returns
@@ -138,7 +138,7 @@ class PackageDef(GrpcPackageDef):
         super(PackageDef, self.__class__).thermal_conductivity.__set__(self, GrpcValue(value))
 
     @property
-    def theta_jb(self):
+    def theta_jb(self) -> float:
         """Theta Junction-to-Board of the package.
 
         Returns
@@ -153,7 +153,7 @@ class PackageDef(GrpcPackageDef):
         super(PackageDef, self.__class__).theta_jb.__set__(self, GrpcValue(value))
 
     @property
-    def theta_jc(self):
+    def theta_jc(self) -> float:
         """Theta Junction-to-Case of the package.
 
         Returns
@@ -168,7 +168,7 @@ class PackageDef(GrpcPackageDef):
         super(PackageDef, self.__class__).theta_jc.__set__(self, GrpcValue(value))
 
     @property
-    def height(self):
+    def height(self) -> float:
         """Height of the package.
 
         Returns
@@ -183,7 +183,7 @@ class PackageDef(GrpcPackageDef):
         super(PackageDef, self.__class__).height.__set__(self, GrpcValue(value))
 
     @property
-    def heat_sink(self):
+    def heat_sink(self) -> HeatSink:
         """Package heat sink.
 
         Returns
@@ -206,7 +206,7 @@ class PackageDef(GrpcPackageDef):
         """
         return self.heat_sink
 
-    def set_heatsink(self, fin_base_height, fin_height, fin_orientation, fin_spacing, fin_thickness):
+    def set_heatsink(self, fin_base_height, fin_height, fin_orientation, fin_spacing, fin_thickness) -> HeatSink:
         """Set Heat sink.
         Parameters
         ----------

pyedb/grpc/database/definition/padstack_def.py

@@ -84,7 +84,7 @@ class PadProperties:
         return p_val
 
     @property
-    def geometry_type(self):
+    def geometry_type(self) -> float:
         """Geometry type.
 
         Returns
@@ -99,7 +99,7 @@ class PadProperties:
         return self._pad_parameter_value[0]
 
     @property
-    def shape(self):
+    def shape(self) -> str:
         """Pad shape.
 
         Returns
@@ -123,6 +123,12 @@ class PadProperties:
         except TypeError:
             return []
 
+    @parameters_values.setter
+    def parameters_values(self, value):
+        if isinstance(value, (float, str)):
+            value = [value]
+        self._update_pad_parameters_parameters(params=value)
+
     @property
     def parameters_values_string(self):
         """Parameters value in string format."""
@@ -132,7 +138,7 @@ class PadProperties:
             return []
 
     @property
-    def polygon_data(self):
+    def polygon_data(self) -> GrpcPolygonData:
         """Parameters.
 
         Returns
@@ -144,7 +150,7 @@ class PadProperties:
         return p if isinstance(p, ansys.edb.core.geometry.polygon_data.PolygonData) else None
 
     @property
-    def offset_x(self):
+    def offset_x(self) -> float:
         """Offset for the X axis.
 
         Returns
@@ -155,7 +161,7 @@ class PadProperties:
         return self._pad_parameter_value[2].value
 
     @property
-    def offset_y(self):
+    def offset_y(self) -> float:
         """Offset for the Y axis.
 
         Returns
@@ -175,7 +181,7 @@ class PadProperties:
         self._update_pad_parameters_parameters(offsety=value)
 
     @property
-    def rotation(self):
+    def rotation(self) -> float:
         """Rotation.
 
         Returns
@@ -190,16 +196,6 @@ class PadProperties:
     def rotation(self, value):
         self._update_pad_parameters_parameters(rotation=value)
 
-    @rotation.setter
-    def rotation(self, value):
-        self._update_pad_parameters_parameters(rotation=value)
-
-    @parameters_values.setter
-    def parameters_values(self, value):
-        if isinstance(value, (float, str)):
-            value = [value]
-        self._update_pad_parameters_parameters(params=value)
-
     def _update_pad_parameters_parameters(
         self,
         layer_name=None,
@@ -272,7 +268,7 @@ class PadstackDef(GrpcPadstackDef):
         self._bounding_box = []
 
     @property
-    def instances(self):
+    def instances(self) -> list[any]:
         """Definitions Instances.
 
         Returns
@@ -283,7 +279,7 @@ class PadstackDef(GrpcPadstackDef):
         return [i for i in list(self._pedb.padstacks.instances.values()) if i.padstack_def.name == self.name]
 
     @property
-    def layers(self):
+    def layers(self) -> list[str]:
         """Layers.
 
         Returns
@@ -316,7 +312,7 @@ class PadstackDef(GrpcPadstackDef):
         return self.layers[-1]
 
     @property
-    def hole_diameter(self):
+    def hole_diameter(self) -> float:
         """Hole diameter.
 
         Returns
@@ -354,7 +350,7 @@ class PadstackDef(GrpcPadstackDef):
             )
 
     @property
-    def hole_type(self):
+    def hole_type(self) -> float:
         """Holy type.
 
         Returns
@@ -378,7 +374,7 @@ class PadstackDef(GrpcPadstackDef):
         return self.data.get_hole_parameters()[0]
 
     @property
-    def hole_offset_x(self):
+    def hole_offset_x(self) -> float:
         """Hole offset for the X axis.
 
         Returns
@@ -404,7 +400,7 @@ class PadstackDef(GrpcPadstackDef):
         )
 
     @property
-    def hole_offset_y(self):
+    def hole_offset_y(self) -> float:
         """Hole offset for the Y axis.
 
         Returns
@@ -430,7 +426,7 @@ class PadstackDef(GrpcPadstackDef):
         )
 
     @property
-    def hole_rotation(self):
+    def hole_rotation(self) -> float:
         """Hole rotation.
 
         Returns
@@ -456,7 +452,7 @@ class PadstackDef(GrpcPadstackDef):
         )
 
     @property
-    def pad_by_layer(self):
+    def pad_by_layer(self) -> dict[str, PadProperties]:
         """Pad by layer.
 
         Returns
@@ -473,7 +469,7 @@ class PadstackDef(GrpcPadstackDef):
         return self._pad_by_layer
 
     @property
-    def antipad_by_layer(self):
+    def antipad_by_layer(self) -> dict[str, PadProperties]:
         """Antipad by layer.
 
         Returns
@@ -490,7 +486,7 @@ class PadstackDef(GrpcPadstackDef):
         return self._antipad_by_layer
 
     @property
-    def thermalpad_by_layer(self):
+    def thermalpad_by_layer(self) -> dict[str, PadProperties]:
         """Thermal by layer.
 
         Returns
@@ -507,7 +503,7 @@ class PadstackDef(GrpcPadstackDef):
         return self._thermalpad_by_layer
 
     @property
-    def hole_plating_ratio(self):
+    def hole_plating_ratio(self) -> float:
         """Hole plating ratio.
 
         Returns
@@ -522,7 +518,7 @@ class PadstackDef(GrpcPadstackDef):
         self.data.plating_percentage = GrpcValue(ratio)
 
     @property
-    def hole_plating_thickness(self):
+    def hole_plating_thickness(self) -> float:
         """Hole plating thickness.
 
         Returns
@@ -551,7 +547,7 @@ class PadstackDef(GrpcPadstackDef):
         self.hole_plating_ratio = hr
 
     @property
-    def hole_finished_size(self):
+    def hole_finished_size(self) -> float:
         """Finished hole size.
 
         Returns
@@ -568,7 +564,7 @@ class PadstackDef(GrpcPadstackDef):
             return 0.0
 
     @property
-    def hole_range(self):
+    def hole_range(self) -> str:
         """Get hole range value from padstack definition.
 
         Returns
@@ -597,7 +593,7 @@ class PadstackDef(GrpcPadstackDef):
                 self.data.hole_range = GrpcPadstackHoleRange.UNKNOWN_RANGE
 
     @property
-    def material(self):
+    def material(self) -> str:
         """Return hole material name."""
         return self.data.material.value
 
@@ -605,7 +601,9 @@ class PadstackDef(GrpcPadstackDef):
     def material(self, value):
         self.data.material.value = value
 
-    def convert_to_3d_microvias(self, convert_only_signal_vias=True, hole_wall_angle=15, delete_padstack_def=True):
+    def convert_to_3d_microvias(
+        self, convert_only_signal_vias=True, hole_wall_angle=15, delete_padstack_def=True
+    ) -> bool:
         """Convert actual padstack instance to microvias 3D Objects with a given aspect ratio.
 
         Parameters
@@ -738,7 +736,7 @@ class PadstackDef(GrpcPadstackDef):
         self._pedb.logger.info(f"{i} Converted successfully to 3D Objects.")
         return True
 
-    def split_to_microvias(self):
+    def split_to_microvias(self) -> list[any]:
         """Convert actual padstack definition to multiple microvias definitions.
 
         Returns

pyedb/grpc/database/definitions.py

@@ -34,12 +34,30 @@ class Definitions:
 
     @property
     def component(self) -> dict[str, ComponentDef]:
-        """Component definitions"""
+        """Component definitions
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> component_defs = edb.definitions.component
+        >>> for name, comp_def in component_defs.items():
+        ...     print(f"Component: {name}, Part: {comp_def.part}")
+        """
         return {l.name: ComponentDef(self._pedb, l) for l in self._pedb.active_db.component_defs}
 
     @property
     def package(self) -> dict[str, PackageDef]:
-        """Package definitions."""
+        """Package definitions.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> package_defs = edb.definitions.package
+        >>> for name, pkg_def in package_defs.items():
+        ...     print(f"Package: {name}, Boundary: {pkg_def.exterior_boundary}")
+        """
         return {l.name: PackageDef(self._pedb, l) for l in self._pedb.active_db.package_defs}
 
     def add_package_def(self, name, component_part_name=None, boundary_points=None) -> Union[PackageDef, bool]:
@@ -57,6 +75,22 @@ class Definitions:
         Returns
         -------
         PackageDef object.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+
+        Example 1: Create package using component's bounding box
+        >>> comp_def = edb.definitions.add_package_def("QFP64", "QFP64_COMPONENT")
+        >>> if comp_def:  # Check if created successfully
+        ...     print(f"Created package: {comp_def.name}")
+
+        Example 2: Create package with custom boundary
+        >>> boundary = [[0, 0], [10e-3, 0], [10e-3, 10e-3], [0, 10e-3]]
+        >>> custom_pkg = edb.definitions.add_package_def("CustomIC", boundary_points=boundary)
+        >>> if custom_pkg:
+        ...     print(f"Custom package boundary: {custom_pkg.exterior_boundary}")
         """
         if not name in self.package:
             package_def = PackageDef.create(self._pedb.active_db, name=name)