pyedb 0.49.0__py3-none-any.whl → 0.50.1__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

@@ -99,22 +99,22 @@ def get_line_float_value(line):
 class MaterialProperties(BaseModel):
     """Store material properties."""
 
-    conductivity: Optional[PositiveFloat] = None
-    dielectric_loss_tangent: Optional[PositiveFloat] = None
-    magnetic_loss_tangent: Optional[PositiveFloat] = None
-    mass_density: Optional[PositiveFloat] = None
-    permittivity: Optional[PositiveFloat] = None
-    permeability: Optional[PositiveFloat] = None
-    poisson_ratio: Optional[PositiveFloat] = None
-    specific_heat: Optional[PositiveFloat] = None
-    thermal_conductivity: Optional[PositiveFloat] = None
-    youngs_modulus: Optional[PositiveFloat] = None
-    thermal_expansion_coefficient: Optional[PositiveFloat] = None
-    dc_conductivity: Optional[PositiveFloat] = None
-    dc_permittivity: Optional[PositiveFloat] = None
-    dielectric_model_frequency: Optional[PositiveFloat] = None
-    loss_tangent_at_frequency: Optional[PositiveFloat] = None
-    permittivity_at_frequency: Optional[PositiveFloat] = None
+    conductivity: Optional[PositiveFloat] = 0.0
+    dielectric_loss_tangent: Optional[PositiveFloat] = 0.0
+    magnetic_loss_tangent: Optional[PositiveFloat] = 0.0
+    mass_density: Optional[PositiveFloat] = 0.0
+    permittivity: Optional[PositiveFloat] = 0.0
+    permeability: Optional[PositiveFloat] = 0.0
+    poisson_ratio: Optional[PositiveFloat] = 0.0
+    specific_heat: Optional[PositiveFloat] = 0.0
+    thermal_conductivity: Optional[PositiveFloat] = 0.0
+    youngs_modulus: Optional[PositiveFloat] = 0.0
+    thermal_expansion_coefficient: Optional[PositiveFloat] = 0.0
+    dc_conductivity: Optional[PositiveFloat] = 0.0
+    dc_permittivity: Optional[PositiveFloat] = 0.0
+    dielectric_model_frequency: Optional[PositiveFloat] = 0.0
+    loss_tangent_at_frequency: Optional[PositiveFloat] = 0.0
+    permittivity_at_frequency: Optional[PositiveFloat] = 0.0
 
 
 class Material(GrpcMaterialDef):
@@ -128,7 +128,7 @@ class Material(GrpcMaterialDef):
         self.__dielectric_model = None
 
     @property
-    def name(self):
+    def name(self) -> str:
         """Material name.
 
         Returns
@@ -169,10 +169,10 @@ class Material(GrpcMaterialDef):
                 self.__dielectric_model = GrpcDjordjecvicSarkarModel(super().dielectric_material_model.msg)
             return self.__dielectric_model
         except:
-            return None
+            return 0.0
 
     @property
-    def conductivity(self):
+    def conductivity(self) -> float:
         """Get material conductivity.
 
         Returns
@@ -184,7 +184,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.CONDUCTIVITY).value
             return value
         except:
-            return None
+            return 0.0
 
     @conductivity.setter
     def conductivity(self, value):
@@ -210,7 +210,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.dielectric_material_model.dc_conductivity
         except:
-            return
+            return None
 
     @dc_conductivity.setter
     def dc_conductivity(self, value):
@@ -230,7 +230,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.dielectric_material_model.dc_relative_permitivity
         except:
-            return
+            return None
 
     @dc_permittivity.setter
     def dc_permittivity(self, value):
@@ -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
@@ -250,7 +250,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.dielectric_material_model.loss_tangent_at_frequency
         except:
-            return
+            return None
 
     @loss_tangent_at_frequency.setter
     def loss_tangent_at_frequency(self, value):
@@ -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
@@ -270,7 +270,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.dielectric_material_model.frequency
         except:
-            return
+            return None
 
     @dielectric_model_frequency.setter
     def dielectric_model_frequency(self, value):
@@ -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.
 
 
@@ -291,7 +291,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.dielectric_material_model.relative_permitivity_at_frequency
         except:
-            return
+            return None
 
     @permittivity_at_frequency.setter
     def permittivity_at_frequency(self, value):
@@ -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.
 
 
@@ -313,7 +313,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.PERMITTIVITY).value
             return value
         except:
-            return None
+            return 0.0
 
     @permittivity.setter
     def permittivity(self, value):
@@ -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
@@ -334,7 +334,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.PERMEABILITY).value
             return value
         except:
-            return None
+            return 0.0
 
     @permeability.setter
     def permeability(self, value):
@@ -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
@@ -371,7 +371,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.get_property(GrpcMaterialProperty.DIELECTRIC_LOSS_TANGENT).value
         except:
-            return None
+            return 0.0
 
     @loss_tangent.setter
     def loss_tangent(self, value):
@@ -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
@@ -401,7 +401,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.MAGNETIC_LOSS_TANGENT).value
             return value
         except:
-            return None
+            return 0.0
 
     @magnetic_loss_tangent.setter
     def magnetic_loss_tangent(self, value):
@@ -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
@@ -422,7 +422,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.THERMAL_CONDUCTIVITY).value
             return value
         except:
-            return None
+            return 0.0
 
     @thermal_conductivity.setter
     def thermal_conductivity(self, value):
@@ -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
@@ -443,7 +443,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.MASS_DENSITY).value
             return value
         except:
-            return None
+            return 0.0
 
     @mass_density.setter
     def mass_density(self, value):
@@ -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
@@ -464,7 +464,7 @@ class Material(GrpcMaterialDef):
             value = self.get_property(GrpcMaterialProperty.YOUNGS_MODULUS).value
             return value
         except:
-            return None
+            return 0.0
 
     @youngs_modulus.setter
     def youngs_modulus(self, value):
@@ -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
@@ -483,7 +483,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.get_property(GrpcMaterialProperty.SPECIFIC_HEAT).value
         except:
-            return None
+            return 0.0
 
     @specific_heat.setter
     def specific_heat(self, value):
@@ -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
@@ -502,7 +502,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.get_property(GrpcMaterialProperty.POISSONS_RATIO).value
         except:
-            return None
+            return 0.0
 
     @poisson_ratio.setter
     def poisson_ratio(self, value):
@@ -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
@@ -522,7 +522,7 @@ class Material(GrpcMaterialDef):
         try:
             return self.get_property(GrpcMaterialProperty.THERMAL_EXPANSION_COEFFICIENT).value
         except:
-            return None
+            return 0.0
 
     @thermal_expansion_coefficient.setter
     def thermal_expansion_coefficient(self, value):
@@ -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
         ----------